Install using Docker Compose¶

This installation is meant for people who want to just try out Open Forms on their own machine.

A Docker Compose file is available to get the app up and running in minutes. It contains ‘convenience’ settings, which means that no additional configuration is needed to run the app. Therefore, it should not be used for anything other than testing. For example, it includes:

A default SECRET_KEY environment variable
A predefined database with the environment variable POSTGRES_HOST_AUTH_METHOD=trust. This lets us connect to the database without using a password.
Debug mode is enabled.

Prerequisites¶

You will only need Docker tooling and nothing more:

Docker Engine (Desktop or Server)
Docker Compose (sometimes comes bundled with Docker Engine)

Getting started¶

Download the project as ZIP-file:

$ wget https://github.com/open-formulieren/open-forms/archive/refs/heads/master.zip -O
$ unzip master.zip
$ cd open-forms-master

Start the docker containers with docker-compose. If you want to run the containers in the background, add the -d option to the command below:

$ docker-compose up

Creating network "open-forms-master_default" with the default driver
Creating volume "open-forms-master_db" with default driver
Creating volume "open-forms-master_private_media" with default driver
Creating open-forms-master_db_1 ... done
Creating open-forms-master_redis_1 ... done
Creating open-forms-master_sdk_1 ... done
Creating open-forms-master_web_1 ... done
Creating open-forms-master_nginx_1 ... done
Creating open-forms-master_celery_1 ... done
Creating open-forms-master_celery-beat_1 ... done
Creating open-forms-master_celery-flower_1 ... done
...

Create a super-user.

$ docker-compose exec web src/manage.py createsuperuser

Navigate to http://127.0.0.1:8000/admin/ and use the credentials created above to log in.
To stop the containers, press CTRL-C or if you used the -d option:
```
$ docker-compose stop
```
If you want to get newer versions, you need to pull because the docker-compose.yml contains no explicit versions:
```
$ docker-compose pull
```