Docker Compose

Docker Compose file

Download the docker-compose.yml file from the github repository.

Download using CLI

curl -o docker-compose.yml https://raw.githubusercontent.com/0PandaDEV/Ziit/refs/heads/main/docker-compose.yml

Edit the environment variables in the docker-compose.yml file to set your configuration values:

Variable	Description
`NUXT_DATABASE_URL`	PostgreSQL connection string. Example: `postgresql://postgres:CHANGEME@postgres:5432/ziit`
`NUXT_PASETO_KEY`	PASETO local key (Generate with `echo k4.local.$(openssl rand -base64 32)`)
`NUXT_ADMIN_KEY`	Password for the admin dashboard (Generate with `openssl rand -base64 64`)
`NUXT_BASE_URL`	Base URL of the Ziit instance, including protocol. Example: `https://ziit.example.com`
`NUXT_DISABLE_REGISTRATION`	Disable user registration
`NUXT_GITHUB_CLIENT_ID`	GitHub OAuth client ID
`NUXT_GITHUB_CLIENT_SECRET`	GitHub OAuth client secret
`NUXT_EPILOGUE_APP_ID`	Epilogue OAuth application ID
`NUXT_EPILOGUE_APP_SECRET`	Epilogue OAuth application secret

Be sure to replace the example values with your actual configuration details before proceeding.

Run the following command in your terminal:

Start Docker Compose

docker compose up -d

The application will be available at http://localhost:3000 (or your configured host/port).

When needed, you can stop the containers with:

Stop Docker Compose

docker compose down