Initial Configuration¶
To get Control Center running and have it reflect your division as you wish, there are several environment variables you must customise.
Setting up the environment¶
You may start the container with docker-compose.yaml from the root folder, but fill it out with the required variables first.
Environment variables¶
The full list of environment variables and defaults lives in Reference: Environment Variables. The table section is included below for convenience.
Configure core settings¶
Settings related to URLs, subdivision names and other core application settings.
| Variable | Default value | Explanation |
|---|---|---|
APP_NAME |
Control Center | What you want to call the software |
APP_OWNER_NAME |
(sub)division Name | Full name of your (sub)division such as VATSIM Scandinavia |
APP_OWNER_NAME_SHORT |
SCA | Short name of choice for your vACC e.g. VATSCA/ESTVACC |
APP_OWNER_CODE |
SCA | 3-4 letter name identifying your vACC within VATSIM APIs |
APP_MODE |
subdivision | Select correct logic mode subdivision or division |
APP_URL |
http://localhost |
URL to your Control Center without slash at the end |
APP_ENV |
production | Environment of your Control Center |
Configure database¶
Important
The database settings must be valid to get access to Control Center.
Settings related to configuring the database connection.
| Variable | Default value | Explanation |
|---|---|---|
DB_CONNECTION |
mysql | Database connection type |
DB_HOST |
localhost | Database host |
DB_PORT |
3306 | Database port |
DB_DATABASE |
control-center | Database name |
DB_USERNAME |
root | Database username |
DB_PASSWORD |
root | Database password |
DB_TABLE_PREFIX |
null | Database table prefix |
Configure authentication¶
Important
The authentication settings must be valid to get access to Control Center.
Settings related to configuring OAuth-based authentication adhering to the fields supported by VATSIM and Handover.
| Variable | Default value | Explanation |
|---|---|---|
OAUTH_URL |
https://auth.vatsim.net |
OAuth URL of VATSIM |
OAUTH_ID |
null | OAuth ID of your subdivision |
OAUTH_SECRET |
null | OAuth secret of your subdivision |
Configure VATSIM integration¶
Important
The VATSIM settings must be valid for the membership tasks and bookings to function.
Settings related to the VATSIM integration.
| Variable | Default value | Explanation |
|---|---|---|
VATSIM_CORE_API_TOKEN |
null | API token (v2) to VATSIM Core API |
VATSIM_BOOKING_API_URL |
https://atc-bookings.vatsim.net/api |
URL to VATSIM ATC Bookings API |
VATSIM_BOOKING_API_TOKEN |
null | API token to VATSIM ATC Bookings API |
STATSIM_API_URL |
https://api.statsim.net/ |
URL to StatSim statistics API (used for ATC activity charts and recent ATC sessions) |
STATSIM_API_KEY |
null | API key for StatSim statistics API authentication (required for ATC activity charts and ATC tables) |
STATSIM_CACHE_TTL_MINUTES |
30 | Cache TTL (in minutes) for StatSim ATC session responses (shared between charts and recent tables) |
STATSIM_RECENT_SESSIONS_DAYS |
30 | Number of days back to include when building the \"Recent Connections\" ATC sessions table |
STATSIM_RECENT_SESSIONS_LIMIT |
10 | Maximum number of recent ATC sessions shown in the \"Recent Connections\" table |
Configure mail & notifications¶
Settings related to mail notifications, an important aspect of supporting training.
| Variable | Default value | Explanation |
|---|---|---|
MAIL_MAILER |
smtp | Mailer type |
MAIL_HOST |
smtp.mailgun.org | Mail host |
MAIL_PORT |
587 | Mail port |
MAIL_USERNAME |
null | Mail username |
MAIL_PASSWORD |
null | Mail password |
MAIL_ENCRYPTION |
null | Mail encryption |
MAIL_FROM_NAME |
Control Center | Mail from name |
MAIL_FROM_ADDRESS |
noreply@yourvacc.com |
Mail from address |
Configure reverse proxy¶
Settings related to reverse proxies in front of Control Center.
| Variable | Default value | Explanation |
|---|---|---|
TRUSTED_PROXIES |
null | Comma-separated list of trusted proxy addresses or * for all |
Optional: Configuring alternative OAuth providers¶
Control Center supports both VATSIM Connect, Handover and other OAuth providers to authenticate and fetch user data. If you're looking for a centrailised login system check out our Handover service, or use VATSIM Connect.
If you want to use a custom Oauth provider, see how to configure authentication in-full.
Optional: Extras¶
| Variable | Default value | Explanation |
|---|---|---|
| APP_DEBUG | false | Toggle debug mode of your Control Center |
| APP_TRACKING_SCRIPT | null | Input javascript here with your tracking script, e.g. Google Analytics |
| 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 |
Next steps¶
With a configured instance of Control Center, it is time to complete the installation on the system Control Center is running.