Skip to main content

Configuration

Overview​

The application uses YAML configuration files for both development and production environments. The main configuration file is located at config/app.yaml.

Server Configuration​

Basic server configuration includes environment, address, port, and various security settings.

You can find the full config file reference at Config File Reference

tip

When using CLI, you can use the --config flag to specify a configuration file. For example, sccce --config config/app.dev.yaml [command] will use the config/app.dev.yaml configuration file.

Environment Variables​

Environment variables with SCCCE prefix can be used to override configuration file settings. For example, SCCCE_SERVER_PORT can be used to override server.port in the configuration file.

You can also reference ENV variables in the configuration file using ${ENV_VAR_NAME} syntax.

Example Configurations​

You can find example configurations in the GitHub Repository (config.example) or in the downloaded release .tar.gz file (under the config folder instead of config.example).

  1. config.example/app.dev.yaml - Development Configuration
  2. config.example/app.prod.yaml - Production Configuration
  3. config.example/app.docker.prod.yaml - Production Configuration for Docker

Security Considerations​

  1. Change all default passwords and secrets in production
  2. Use strong passwords and secret keys
  3. Enable HTTPS in production
  4. Configure appropriate firewall rules
  5. Regularly rotate credentials
  6. Use environment-specific configuration files
  7. Never commit sensitive credentials to version control

Troubleshooting​

Common configuration issues:

  1. Database Connection Issues:

    • Verify host and port settings
    • Check credentials
    • Ensure network connectivity
    • Verify Docker network settings if using containers

  2. Email Configuration:

    • Test SMTP settings
    • Verify port numbers
    • Check firewall rules
    • Validate email credentials

  3. JWT Issues:

    • Ensure secret key is properly set
    • Check token expiration settings
    • Verify realm configuration

For more detailed configuration options and examples, refer to the Configuration Reference.