Configuration

The included compose.yml and compose.env files in the repo contain default values that allow you to quickly demo the app.

If you plan to use the app long-term, you can customize your deployment using the following values in compose.env.

Client Configuration

These are general configuration options for the budget-board-client container.

Option	Details
PORT	Change this if you would like to access Budget Board on a different port from the default 6253.

Server Configuration

These are general configuration options for the budget-board-server container.

Option	Details
LOG_LEVEL	The logging level of the server. By default this is set to the most verbose level.

Database Configuration

These are general configuration options for the budget-board-db container.

info

If you are using the included postgresql container, the only value you need to set is POSTGRES_PASSWORD. The other values will default to the correct values for the included container.

If you are using an external database, you will need to set all of these values to match your database configuration.

Option	Details
POSTGRES_HOST	The host for the PostgreSQL database.
POSTGRES_PORT	The port for the PostgreSQL database.
POSTGRES_DATABASE	The PostgreSQL database name.
POSTGRES_USER	The PostgreSQL database user that Budget Board will use to connect to the database.
POSTGRES_PASSWORD	The database user's password.
TZ	The timezone for the database (e.g. America/New_York). See the list of valid timezone values. If not set, defaults to UTC timezone.

OIDC Configuration

These values are required if you plan to use an OIDC provider for authentication instead of the built-in username/password authentication.

Option	Details
OIDC_ENABLED	Set to true to enable OIDC authentication.
OIDC_ISSUER	The URL of your OIDC provider.
OIDC_CLIENT_ID	The client ID registered with your OIDC provider.
OIDC_CLIENT_SECRET	The client secret registered with your OIDC provider.

Email Configuration

The following values are required if you plan to use email features such as password resets and account verification for local authentication.

Option	Details
EMAIL_SENDER	The email address used to send verification and password-reset emails.
EMAIL_SENDER_USERNAME	The username for the SMTP server. If not specified, this defaults to the EMAIL_SENDER value.
EMAIL_SENDER_PASSWORD	The password for the SMTP server.
EMAIL_SMTP_HOST	The SMTP host used to send email.
EMAIL_SMTP_PORT	The port for the SMTP server.

Authentication Settings

The following options allow you to customize authentication behavior.

Option	Details
DISABLE_LOCAL_AUTH	Set to true to disable local authentication. This is only recommended for deployments that use an external authentication provider (i.e. OIDC).
DISABLE_NEW_USERS	Set to true to prevent new user registrations.

Server Settings

These settings allow you to customize the behavior of the Budget Board server.

Option	Details
AUTO_UPDATE_DB	Set to true to enable automatic database migrations when the server starts.
DISABLE_AUTO_SYNC	Set to true to disable automatic syncs.
SYNC_INTERVAL_HOURS	The number of hours between automatic syncs. If not specified, this defaults to 8 hours.