Table of Contents
Here is a list over all environment variables you may tweak. You may start the container with docker-compose.yaml from the root folder, but fill it out with the required variables first.
Table with all the variables, default value and explanation. Override the environment variable to change the value if the default value does not fit your needs.
| Variable | Default value | Explanation |
|---|---|---|
| APP_NAME | Handover | Name of your subdivision |
| APP_OWNER | Subdivision Name | Name of your subdivision |
| APP_OWNER_SHORT | SCA | Usually 3 letter name identifying your vACC within VATSIM API |
| APP_OWNER_CONTACT | [email protected] | E-mail address of your person for ban disputes |
| APP_DPP_URL | https://vatsim.net | URL to your Data Protection Policy |
| APP_DPP_DATE | 2019-10-10 | Date of your Data Protection Policy |
| APP_DPO_MAIL | [email protected] | E-mail address of your Data Protection Officer |
| APP_URL | http://localhost | URL to your Handover |
| APP_ENV | production | Environment of your Handover |
| DB_CONNECTION | mysql | Database connection type |
| DB_HOST | localhost | 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 | null | Database table prefix |
| VATSIM_OAUTH_BASE | https://auth.vatsim.net | OAuth URL of VATSIM Connect |
| VATSIM_OAUTH_CLIENT | null | OAuth ID of your subdivision |
| VATSIM_OAUTH_SECRET | null | OAuth secret of your subdivision |
To change the logo to yours, bind your logo image files to /app/public/images/logos and change the following variables:
| Variable | Default value | Explanation |
|---|---|---|
| APP_LOGO | vatsca.svg | The logo of your choice, located in /app/public/images/logos |
To change the bootstrap colors to match your division, first change the environment variables and then run the following command
| Variable | Default value | Explanation |
|---|---|---|
| BOOTSTRAP_COLOR_PRIMARY | #1a475f | Primary color of your theme |
| BOOTSTRAP_COLOR_SECONDARY | #484b4c | Secondary color of your theme |
| BOOTSTRAP_COLOR_TERTIARY | #011328 | Tertiary color of your theme |
| BOOTSTRAP_COLOR_INFO | #17a2b8 | Info color of your theme |
| BOOTSTRAP_COLOR_SUCCESS | #41826e | Success color of your theme |
| BOOTSTRAP_COLOR_WARNING | #ff9800 | Warning color of your theme |
| BOOTSTRAP_COLOR_DANGER | #b63f3f | Danger color of your theme |
| BOOTSTRAP_BORDER_RADIUS | 2px | Border radius of your theme |
Run this command to build the theme. If you get an error like "#5f271a" is not a color, remove the " quotes from your environment variable.
docker exec -it handover sh container/theme/build.shNote
- Building custom themes will increase your container size with ~200mb when completed. When you run this command, we need install dependencies inside your container to build the theme and then remove them again. This is done to keep the container size down.
- You need to run this command each time you recreate the container.
To change the icons and bullet points the simplified DPP, bind your blade file to /app/resources/views/parts/dpp-bullets.blade.php. We recommend duplicating the original file and then editing it to your liking.
To change the header text, bind your blade file to /app/resources/views/layouts/header.blade.php and name it header.blade.php. We recommend duplicating the original file and then editing it to your liking.
| Variable | Default value | Explanation |
|---|---|---|
| APP_DEBUG | false | Toggle debug mode of your Control Center |
| DEBUGBAR_ENABLED | false | Toggle debug bar of your Control Center |
| SESSION_LIFETIME | 120 | Session lifetime in minutes, forces a new login when passed |
| SENTRY_LARAVEL_DSN | null | The Sentry DSN |
| SENTRY_TRACES_SAMPLE_RATE | 0.1 | The Sentry sample rate |