This guide covers all configuration options for the application. Adjust settings in the config.yml file or via environment variables to tailor behavior to your needs.

Start with the minimal configuration required to run the service.

# config.yml
server:
  port: 8080
database:
  host: localhost
  port: 5432
  name: appdb

All settings can be overridden with environment variables. Prefix variables with APP_.

# .env
APP_SERVER_PORT=8080
APP_DATABASE_HOST=localhost
APP_DATABASE_PORT=5432
APP_DATABASE_NAME=appdb

Fine‑tune performance and security.

• Cache: Enable Redis cache.
• TLS: Provide certificate paths for HTTPS.
• Logging: Set log level and output format.

# config.yml
cache:
  enabled: true
  host: redis.local
  port: 6379

tls:
  enabled: true
  cert: /etc/ssl/certs/app.crt
  key: /etc/ssl/private/app.key

logging:
  level: info
  format: json

Common issues and their resolutions.

1. Port already in use: Change server.port or stop the conflicting service.
2. Database connection failed: Verify credentials and network access.
3. TLS handshake errors: Ensure certificate files are valid and paths are correct.