GitPeeks

Configuration

Configuration is read from the .gitpeeks/config.yml in your repository.

roles:
  web:
  worker:
    cmd: bundle exec sidekiq
env:
  clear:
    POSTGRES_HOST: postgres
    POSTGRES_USER: postgres
    REDIS_URL: redis://redis:6379
  secret:
    - RAILS_MASTER_KEY
    - POSTGRES_PASSWORD
accessories:
  postgres:
    image: postgres:17
    env:
      clear:
        POSTGRES_HOST: postgres
        POSTGRES_USER: postgres
      secret:
        - POSTGRES_PASSWORD
    volumes:
      - postgres:/var/lib/postgresql/data
  redis:
    image: redis:7
    volumes:
      - redis:/data

Roles

Roles are used to define different server types in the deployment. See Roles for full reference.

roles:
  web:
  worker:
    cmd: bundle exec sidekiq

Environment variables

See Environment variables for full reference.

env:
  clear:
    POSTGRES_HOST: postgres
    POSTGRES_USER: postgres
    REDIS_URL: redis://redis:6379
  secret:
    - RAILS_MASTER_KEY
    - POSTGRES_PASSWORD

Accessories

Additionals services to run in Docker, see Accessories for full reference.

accessories:
  postgres:
    image: postgres:15
    env:
      clear:
        POSTGRES_HOST: postgres
        POSTGRES_USER: postgres
      secret:
        - POSTGRES_PASSWORD
    volumes:
      - postgres:/var/lib/postgresql/data
  redis:
    image: redis:7
    volumes:
      - redis:/data

Additional volumes

volumes:
  - /path/on/host:/path/in/container:ro

Build

See Build for full reference.

build:
  ...