Environment variables reference
.env is the single source of truth for a node's configuration. Copy
.env.example to .env, then set the values below. All variables are optional
unless marked required.
Application
| Variable |
Default |
Purpose |
APP_NAME |
VulaSocial |
Site name fallback (branding settings override) |
APP_ENV |
local |
Set production on a live node |
APP_KEY |
— |
Required. App encryption key (php artisan key:generate) |
APP_DEBUG |
true |
Keep false in production |
APP_URL |
http://localhost |
Required. Public URL, e.g. https://your-node.example |
APP_TIMEZONE |
Africa/Johannesburg |
Node timezone |
APP_LOCALE / APP_FALLBACK_LOCALE |
en |
Default locale(s) |
BCRYPT_ROUNDS |
12 |
Password hashing cost |
Database
| Variable |
Default |
Purpose |
DB_CONNECTION |
sqlite |
mysql (or sqlite for dev) |
DB_HOST |
— |
MySQL host (127.0.0.1, or the Compose service name mysql) |
DB_PORT |
3306 |
MySQL port |
DB_DATABASE |
— |
Database name |
DB_USERNAME / DB_PASSWORD |
— |
Database credentials |
Sessions, cache, queue
Shared-hosting friendly defaults keep everything in the database (no Redis
required):
| Variable |
Default |
Purpose |
SESSION_DRIVER |
database |
database recommended on shared hosting |
SESSION_LIFETIME |
120 |
Minutes |
SESSION_SECURE_COOKIE |
— |
Set true behind HTTPS |
SESSION_ENCRYPT |
— |
Set true in production |
CACHE_STORE |
database |
database or redis |
QUEUE_CONNECTION |
database |
database on shared hosting (no worker process needed — cron drains it) |
Broadcasting / realtime (Reverb)
| Variable |
Default |
Purpose |
BROADCAST_CONNECTION |
reverb |
log disables realtime (works everywhere) |
REVERB_APP_ID |
vulasocial |
App id |
REVERB_APP_KEY / REVERB_APP_SECRET |
— |
Reverb credentials |
REVERB_HOST |
127.0.0.1 |
Public hostname browsers connect to |
REVERB_PORT / REVERB_SCHEME |
8080 / http |
443 / https behind a proxy |
REVERB_SERVER_HOST / REVERB_SERVER_PORT |
0.0.0.0 / 8080 |
Internal bind |
REVERB_ALLOWED_ORIGINS |
— |
Comma-separated allowed origins |
See Realtime messaging.
Mail
| Variable |
Default |
Purpose |
MAIL_MAILER |
log |
smtp in production |
MAIL_HOST / MAIL_PORT |
127.0.0.1 / 2525 |
SMTP host/port |
MAIL_USERNAME / MAIL_PASSWORD |
— |
SMTP auth |
MAIL_FROM_ADDRESS |
— |
e.g. hello@your-node.example |
MAIL_FROM_NAME |
VulaSocial |
Sender name |
See Email / SMTP.
Media storage (S3 / Filebase)
| Variable |
Default |
Purpose |
MEDIA_STORAGE_DISK |
local |
local | managed_filebase | admin_s3 |
AWS_ACCESS_KEY_ID / AWS_SECRET_ACCESS_KEY |
— |
Your S3 credentials |
AWS_DEFAULT_REGION / AWS_BUCKET |
— |
S3 region/bucket |
FILEBASE_ACCESS_KEY / FILEBASE_SECRET_KEY |
— |
Filebase credentials |
FILEBASE_BUCKET / FILEBASE_URL / FILEBASE_ENDPOINT |
— |
Filebase bucket/endpoints |
See Media storage. Credentials can also be set in the
admin panel (Settings → Media Storage) and are stored encrypted there.
Social / OAuth logins
| Variable |
Default |
Purpose |
GITHUB_CLIENT_ID / GITHUB_CLIENT_SECRET |
— |
GitHub OAuth |
GOOGLE_CLIENT_ID / GOOGLE_CLIENT_SECRET |
— |
Google OAuth |
FACEBOOK_CLIENT_ID / FACEBOOK_CLIENT_SECRET |
— |
Facebook OAuth |
TWITTER_CLIENT_ID / TWITTER_CLIENT_SECRET |
— |
Twitter/X OAuth |
LINKEDIN_CLIENT_ID / LINKEDIN_CLIENT_SECRET |
— |
LinkedIn OAuth |
GITLAB_CLIENT_ID / GITLAB_CLIENT_SECRET |
— |
GitLab OAuth |
See Social logins.
Federation
| Variable |
Default |
Purpose |
FEDERATION_DRIVER |
local |
local | fedifuel |
FEDERATION_PUBLIC_BASE_URL |
APP_URL |
Required for federation. The public URL others use to reach you |
FEDI_OFFLOADER_URL |
— |
FediFuel offloader URL |
FEDI_BRIDGE_SECRET / FEDI_RELAY_SECRET |
— |
FediFuel signing secrets |
See Federation.
Security & bot protection
| Variable |
Default |
Purpose |
ALTCHA_SECRET |
— |
ALTCHA HMAC secret (or generate in the admin panel) |
GOOGLE_SAFE_BROWSING_KEY |
— |
Google Safe Browsing API key (optional) |
See Bot protection & link safety.
Ads & monetisation (optional)
| Variable |
Default |
Purpose |
ADS_DRIVER |
reclaim |
Ad driver (local sandbox) |
ADS_NODE_SHARE_PERCENT |
90 |
Node's share of ad revenue |
ADS_CURRENCY |
ZAR |
Payout currency |
Required model binding
| Variable |
Default |
Purpose |
SOCIAL_NETWORK_USER_MODEL |
— |
Required. App\Models\User |
Tips
- Never commit
.env. It holds secrets. It is gitignored.
- After editing
.env, run php artisan config:clear (shared hosting) or
php artisan config:cache (VPS with a deploy pipeline).
- Values are read at runtime for Reverb — changing them needs no asset rebuild.