Quickstart
Use this example docker-compose.yml as your starting point.
You need to create an access token that doco-cd will use to authenticate with your Git provider (GIT_ACCESS_TOKEN).
See Setup Access Token to create this access token.
In the environment section of the docker-compose.yml:
- Set the
GIT_ACCESS_TOKENto the access token you just created. - Set the
WEBHOOK_SECRETto a random password, that will be used to authenticate webhooks. You can use tools like pwgen or openssl to generate a random password.# Generate a random password with pwgen pwgen -s 40 1# Generate a random password with openssl openssl rand -base64 40
You can find all available settings on the app settings page.
Alternatively, you can create a .env file with the settings and use the env_file option instead of environment in the docker-compose.yml file.
services:
app:
...
- environment:
- GIT_ACCESS_TOKEN: ${GIT_ACCESS_TOKEN}
- WEBHOOK_SECRET: ${WEBHOOK_SECRET}
+ env_file:
+ - .env
...Write the app settings in the .env file in the format KEY=VALUE:
GIT_ACCESS_TOKEN=xxx
WEBHOOK_SECRET=xxxAfter you have created the docker-compose.yml file, you can run the application with the following command:
docker compose up -dYou can check the logs of the application with the following command:
docker compose logs -fTo be able to reach the application via SaaS products like Github or Gitlab, you need to expose the http endpoint of the application to the internet. You can use a reverse proxy like NGINX, Traefik or Caddy for this purpose.
After you have set up the application, you can proceed with the following steps:
- Deploy Settings - Configure the Docker Compose deployment in your repositories.
- Webhook Setup - Set up a webhook for your deployments.
