Skip to content

Standalone Setup

Installation

Generate Salt

echo "SALT=$(openssl rand -base64 32)" > .env

Run CanaryCD

compose.yml 

services:
  canary-cd:
    image: ghcr.io/rehborn/canary-cd:main
    ports:
      - "127.0.0.1:8001:80"
    volumes:
      - ./data/:/data/
      - /var/run/docker.sock:/var/run/docker.sock:ro
    env_file: .env

$ docker compose up -d


$ pipx install canary-cd

$ canarycd
INFO:     Uvicorn running on http://127.0.0.1:9001 (Press CTRL+C to quit)

SSL and Static Content

in order to auto provision SSL Certificates traefik is required and for serving static content nginx.

Checkout Complete Setup Example

fetch API_KEY

first startup will generated and print the API_KEY to stdout: 

API_KEY <generated-api-key>

add cli to container

Run cli inside container 

$ alias ccd="docker compose exec -it canary-cd ccd"
$ ccd
 Usage: ccd COMMAND [ARGS]...

Environment Variables

  • SALT unique random secret salt used for hashing and encryption
  • API_KEY set initial ROOT_KEY (stored to database)
  • DATA_DIR cache for repositories, pages and dynamic configuration dumps
  • CANARY_HOST (default 127.0.0.1)
  • CANARY_PORT (default 8001)

Next Steps

Install CLI CLI Usage Read API Docs

Was this page helpful?