Install using Docker Compose
This installation is meant for people who want to just try out Open Zaak 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 predefined database with the environment variable
POSTGRES_HOST_AUTH_METHOD=trust. This lets us connect to the database without using a password.
Default admin credentials
Runs against the latest version of Open Zaak, which may contain bugs.
You will only need Docker tooling and nothing more:
Docker Engine (Desktop or Server, 18.09 or newer)
Docker Compose (sometimes comes bundled with Docker Engine)
On Windows, we support WSL as a suitable a Linux-environment.
Download the project as ZIP-file:
$ wget https://github.com/open-zaak/open-zaak/archive/refs/heads/main.zip -O main.zip $ unzip main.zip $ cd open-zaak-main
Start the docker containers with
docker-compose. If you want to run the containers in the background, add the
-doption to the command below:
the image build requires Docker BuildKit to be enabled - if this is not the case, you will see permission errors. You enable this by setting two environment variables:
export DOCKER_BUILDKIT=1 COMPOSE_DOCKER_CLI_BUILD=1
$ docker-compose up [+] Running 5/5 ⠿ Network open-zaak-main_default Created 0.0s ⠿ Container open-zaak-main-db-1 Created 0.2s ⠿ Container open-zaak-main-redis-1 Created 0.2s ⠿ Container open-zaak-main-web-1 Created 0.1s ⠿ Container open-zaak-main-nginx-1 Created 0.1s ...
Navigate to http://127.0.0.1:8000/admin/ and log in with
To stop the containers, press CTRL-C or if you used the
$ docker-compose stop
If you want to get newer versions, you need to
docker-compose.ymlcontains no explicit versions:
$ docker-compose pull