api/.env.example at master · VATUSA/api · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# ============================================================================
# VATUSA API — example environment
#
# Copy to `.env` and fill in. The defaults below match `compose.dev.yml` so a
# local Docker stack works out of the box. Anything left blank is only needed
# when exercising that specific integration (VATSIM SSO, AWS, Moodle, etc.).
#
# Generate APP_KEY after copying:  php artisan key:generate
# ============================================================================

APP_NAME=VATUSA-API
APP_ENV=local
APP_KEY=
APP_DEBUG=true
APP_LOG=daily
APP_LOG_LEVEL=debug
APP_URL=http://localhost:5002
LOGIN_URL=http://localhost:5002

# ---------------------------------------------------------------------------
# Primary database (MySQL). The app ALSO defines `forum`, `email`, and `moodle`
# connections (see config/database.php). They default to the values below if
# their DB_<NAME>_* vars are unset; override them only if those systems exist.
# ---------------------------------------------------------------------------
DB_CONNECTION=mysql
DB_HOST=127.0.0.1
DB_PORT=3306
DB_DATABASE=vatusa
DB_USERNAME=vatusa
DB_PASSWORD=secret

# Auxiliary connections (optional — leave commented unless you have them)
# DB_FORUM_HOST=127.0.0.1
# DB_FORUM_DATABASE=forum
# DB_FORUM_USERNAME=forum
# DB_FORUM_PASSWORD=
# DB_EMAIL_HOST=127.0.0.1
# DB_EMAIL_DATABASE=email
# DB_MOODLE_HOST=127.0.0.1
# DB_MOODLE_DATABASE=moodle

# ---------------------------------------------------------------------------
# Drivers. For local dev, `array`/`sync`/`log` avoid needing extra services.
# ---------------------------------------------------------------------------
BROADCAST_DRIVER=log
CACHE_DRIVER=redis
SESSION_DRIVER=file
QUEUE_CONNECTION=sync
FILESYSTEM_DRIVER=local
CACHE_TIME_ROSTER=240

REDIS_HOST=127.0.0.1
REDIS_PASSWORD=null
REDIS_PORT=6379

# ---------------------------------------------------------------------------
# Mail (use a catch-all like Mailtrap/Mailpit locally; `log` writes to logs)
# ---------------------------------------------------------------------------
MAIL_DRIVER=log
MAIL_HOST=127.0.0.1
MAIL_PORT=1025
MAIL_USERNAME=null
MAIL_PASSWORD=null
MAIL_ENCRYPTION=null

# ---------------------------------------------------------------------------
# Error reporting
# ---------------------------------------------------------------------------
SENTRY_LARAVEL_DSN=

# ---------------------------------------------------------------------------
# JWT (tymon/jwt-auth). `php artisan jwt:secret` sets JWT_SECRET for HMAC algos.
# RFC7519 / asymmetric setups use the key pair vars instead.
# ---------------------------------------------------------------------------
JWT_SECRET=
JWT_ALGO=HS256
JWT_TTL=60
JWT_REFRESH_TTL=20160
# JWT_PRIVATE_KEY=
# JWT_PUBLIC_KEY=
# JWT_PASSPHRASE=

# Legacy v2 API key signing
APIV2_ALG=HS256
APIV2_SIZE=32

# ---------------------------------------------------------------------------
# VATSIM Connect (OAuth2 SSO). Required for the login flow only.
# ---------------------------------------------------------------------------
VATSIM_OAUTH_BASE=
VATSIM_OAUTH_CLIENT=
VATSIM_OAUTH_SECRET=
VATSIM_OAUTH_REDIRECT=
VATSIM_OAUTH_SCOPES=

# VATSIM core API v2
VATSIM_API2_URL=
VATSIM_API2_KEY=
VATSIM_API2_IDENTIFIER=

# Legacy SSO (older VATSIM SSO; being phased out)
SSO_METHOD=
SSO_KEY=
SSO_SECRET=
SSO_RETURN=

# ---------------------------------------------------------------------------
# AWS (S3 for file storage, SES for mail). Optional for local dev.
# ---------------------------------------------------------------------------
AWS_KEY=
AWS_SECRET=
AWS_REGION=us-east-1
AWS_BUCKET=

# ---------------------------------------------------------------------------
# VATUSA Academy (Moodle) integration. Optional.
# ---------------------------------------------------------------------------
MOODLE_URL=
MOODLE_TOKEN=
MOODLE_TOKEN_SSO=

# ---------------------------------------------------------------------------
# Swagger / OpenAPI docs (darkaonline/l5-swagger)
# ---------------------------------------------------------------------------
L5_SWAGGER_GENERATE_ALWAYS=true
L5_SWAGGER_CONST_HOST=http://localhost:5002