akanealw
eec8c28fb3
Some checks are pending
Go Benchmark / Performance Regression Check (push) Waiting to run
Cerberus Integration / Cerberus Security Stack Integration (push) Waiting to run
Upload Coverage to Codecov / Backend Codecov Upload (push) Waiting to run
Upload Coverage to Codecov / Frontend Codecov Upload (push) Waiting to run
CodeQL - Analyze / CodeQL analysis (go) (push) Waiting to run
CodeQL - Analyze / CodeQL analysis (javascript-typescript) (push) Waiting to run
CrowdSec Integration / CrowdSec Bouncer Integration (push) Waiting to run
Docker Build, Publish & Test / build-and-push (push) Waiting to run
Docker Build, Publish & Test / Security Scan PR Image (push) Blocked by required conditions
Quality Checks / Auth Route Protection Contract (push) Waiting to run
Quality Checks / Codecov Trigger/Comment Parity Guard (push) Waiting to run
Quality Checks / Backend (Go) (push) Waiting to run
Quality Checks / Frontend (React) (push) Waiting to run
Rate Limit integration / Rate Limiting Integration (push) Waiting to run
Security Scan (PR) / Trivy Binary Scan (push) Waiting to run
Supply Chain Verification (PR) / Verify Supply Chain (push) Waiting to run
WAF integration / Coraza WAF Integration (push) Waiting to run
Docker Compose Files
This directory contains all Docker Compose configuration variants for Charon.
File Descriptions
| File | Purpose |
|---|---|
docker-compose.yml |
Main production compose configuration. Base services and production settings. |
docker-compose.dev.yml |
Development overrides. Enables hot-reload, debug logging, and development tools. |
docker-compose.local.yml |
Local development configuration. Standalone setup for local testing. |
docker-compose.remote.yml |
Remote deployment configuration. Settings for deploying to remote servers. |
docker-compose.override.yml |
Personal local overrides. Gitignored - use for machine-specific settings. |
Usage Patterns
Production Deployment
docker compose -f .docker/compose/docker-compose.yml up -d
Development Mode
docker compose -f .docker/compose/docker-compose.yml \
-f .docker/compose/docker-compose.dev.yml up -d
Local Testing
docker compose -f .docker/compose/docker-compose.local.yml up -d
With Personal Overrides
Create your own docker-compose.override.yml in this directory for personal
configurations (port mappings, volume paths, etc.). This file is gitignored.
docker compose -f .docker/compose/docker-compose.yml \
-f .docker/compose/docker-compose.override.yml up -d
Notes
- Always use the
-fflag to specify compose file paths from the project root - The override file is automatically ignored by git - do not commit personal settings
- See project tasks in VS Code for convenient pre-configured commands