Environment

Use for infrastructure-level settings that are unlikely to change, such as database credentials and secret keys.

Required Variables

These variables must be set for the application to function properly.

Variable	Type	Description
`PUBLIC_DOMAIN`	`str`	The domain used by the HTTP API to show only the public events
`API_CLIENT_URL`	`str`	The URL used by the web client to communicate with the API client
`DATABASE_URL`	`str`	The PostgreSQL database URL
`CACHE_URL`	`str`	The Redis database URL
`SECRET_KEY`	`str`	A secret key used to handle the authentication system
`SECRET`	`str`	The secret key used to handle the authentication system
`DISCORD_CLIENT_ID`	`int`	The ID of the Discord client
`DISCORD_SECRET`	`str`	The secret of the Discord client
`DISCORD_REDIRECT_URL`	`str`	The callback URL for Discord API authentication
`SENTRY_DSN`	`str`	The DSN configuration for sending error logs to Sentry

Some of these variables have default values and can be customized as needed.

Variable	Type	Description
`PRIVATE_DOMAIN`	`str`	The domain used by the HTTP API to show only the private events

Variable	Type	Description
`DB_POOL_SIZE`	`int`	Database connection pool size (default: 5)
`DB_MAX_OVERFLOW`	`int`	Maximum overflow connections for database pool (default: 5)
`DB_POOL_TIMEOUT`	`int`	Database connection timeout in seconds (default: 30)
`DB_POOL_RECYCLE`	`int`	Database connection recycle time in seconds (default: 1800)
`DB_POOL_PRE_PING`	`bool`	Whether to pre-ping database connections (default: true)

Variable	Type	Description
`WEB_WORKERS`	`int`	Number of web application workers (default: 3)
`API_WORKERS`	`int`	Number of API application workers (default: 3)

Note

Keep in mind that the signal manager is counted as 1 worker and is not configurable yet.

These variables serve different purposes:

PUBLIC_DOMAIN: Used by the API client to validate incoming request domains
PRIVATE_DOMAIN: Used by the API client to validate incoming request domains for private content
API_CLIENT_URL: Used by the web client to know where to send HTTP requests to the API client

Examples:

Local Development:

TOML

PUBLIC_DOMAIN = "resonite-communities.local"
API_CLIENT_URL = "http://resonite-communities.local"

Production:

TOML

PUBLIC_DOMAIN = "resonite-communities.com"
API_CLIENT_URL = "https://resonite-communities.com"

Docker Service Communication:

TOML

API_CLIENT_URL = "http://api_client_community:8000"

To use the HTTP API locally, configure your hosts file with the following domains:

hosts

127.0.0.1 resonite-communities.local
127.0.0.1 private.resonite-communities.local

Note

The code checks for the .local top-level domain to detect local environments.

For direct Poetry runs:

TOML

DATABASE_URL = "postgresql://resonitecommunities:changeme@127.0.0.1:5432/resonitecommunities"

For Docker Compose runs:

TOML

DATABASE_URL = "postgresql://resonitecommunities:changeme@database:5432/resonitecommunities"

The default values for database connection pool and application workers are based on tests on the community instance.

They are based on the default settings of PostgreSQL which have a limit of 100 connections.

When creating the Discord bot application, configure these settings:

Installation Section:

Bot Section - Required Intents: