Skip to content

Environment variables

Configure Handover through environment variables on the container. The repository's docker-compose.yaml lists the ones most installations need. Override a variable when its default does not fit.

Required

Variable Default value Explanation
APP_NAME Handover Name shown in the page title and admin header
APP_OWNER VATSIM Full name of your division
APP_OWNER_SHORT SCA Short name of your division, usually 3 letters, shown to banned users
APP_OWNER_CONTACT webmaster@vatsim.net E-mail address banned users contact to dispute a ban
APP_DPP_URL https://vatsim.net URL to your full Data Protection Policy
APP_DPP_DATE 2019-10-10 Date of your Data Protection Policy, shown as free text
APP_DPO_MAIL webmaster@vatsim.net E-mail address of your Data Protection Officer
APP_URL http://localhost Public URL of your Handover
APP_ENV production Environment of your Handover
APP_KEY none Application key, see installation
DB_CONNECTION mysql Database connection type
DB_HOST 127.0.0.1 Database host
DB_PORT 3306 Database port
DB_DATABASE handover Database name
DB_USERNAME root Database username
DB_PASSWORD root Database password
DB_TABLE_PREFIX empty Prefix for all database table names
VATSIM_OAUTH_BASE https://auth.vatsim.net Base URL of VATSIM Connect
VATSIM_OAUTH_CLIENT none OAuth client ID of your division at VATSIM Connect
VATSIM_OAUTH_SECRET none OAuth client secret of your division at VATSIM Connect

Optional: Theming

See customising the theme for how to apply these.

Variable Default value Explanation
APP_LOGO vatsca.svg File name of your logo in /app/public/images/logos
VITE_THEME_PRIMARY #1a475f Primary colour
VITE_THEME_SECONDARY #484b4c Secondary colour
VITE_THEME_TERTIARY #011328 Tertiary colour
VITE_THEME_INFO #17a2b8 Info colour
VITE_THEME_SUCCESS #41826e Success colour
VITE_THEME_WARNING #ff9800 Warning colour
VITE_THEME_DANGER #b63f3f Danger colour
VITE_THEME_BORDER_RADIUS 2px Border radius

Optional: Extras

Variable Default value Explanation
APP_DEBUG false Show detailed error pages. Never enable in production
VATSIM_OAUTH_SCOPES full_name,email,vatsim_details,country Comma-separated scopes Handover requests from VATSIM Connect
SESSION_LIFETIME 360 Session lifetime in minutes. Users must log in again when it passes
SENTRY_LARAVEL_DSN none The Sentry DSN. Falls back to SENTRY_DSN
SENTRY_TRACES_SAMPLE_RATE 0.0 The Sentry traces sample rate