Configuration
List of available ENV variables
tip
To view list of up-to-date available variables, run oxygen env.
note
oxygen also supports yaml configuration, but it's not recommended for production usage.
Use --config=config.yml--skip-config
| Variable | Type | Required | Description |
|---|---|---|---|
WEB_ADDRESS | string | Listen address (default "0.0.0.0") | |
WEB_PORT | string | Listen port (default "80") | |
DB_DATA_SOURCE | string | ✓ | Postgres connection string. Example: 'host=localhost sslmode=disable dbname=oxygen user=oxygen password=qwerty pool_max_conns=32' |
APP_ENV | string | Environment [production; local; sandbox] (default "production") | |
APP_DEBUG | bool | Enables debug mode (default "false") | |
CORS_ALLOW_CREDENTIALS | bool | CORS (Cross Origin Resource Sharing) allow credentials (default "true") | |
CORS_ALLOW_ORIGINS | slice | ✓ | Comma separated list (without spaces) of origins (with schema). Example: https://pay.site.com |
CSRF_COOKIE_DOMAIN | string | CSRF (Cross Site Request Forgery) cookie domain | |
CSRF_COOKIE_HTTP_ONLY | bool | CSRF HTTP only cookie (default "true") | |
CSRF_COOKIE_MAX_AGE | int | CSRF cookie max-age (default "7200") | |
CSRF_COOKIE_PATH | string | CSRF cookie path (default "/") | |
CSRF_COOKIE_SAME_SITE | string | CSRF cookie same site (default "default") | |
CSRF_COOKIE_SECURE | bool | CSRF secure cookie | |
DB_MIGRATE_ON_START | bool | Apply database migrations on start (default "true") | |
EMAIL_AUTH_ENABLED | bool | Enables email auth (default "true") | |
EMAIL_AUTH_USER_EMAIL | string | ✓ | Email of a user that will be created on first startup |
EMAIL_AUTH_USER_PASSWORD | string | ✓ | Password of a user that will be created on first startup |
KMS_CLIENT_HOST | string | KMS server host. Example: localhost:14000 (default "localhost:14000") | |
KMS_DB_DATA_SOURCE | string | ✓ | KMS vault data source. Example: '/opt/oxygen/kms.db' |
LOGGER_LEVEL | string | Enabled verbose logging (default "debug") | |
LOGGER_PRETTY | bool | Enables human-readable logging. Otherwise uses JSON output (default "false") | |
PROCESSING_PAYMENT_FRONTEND_BASE_PATH | string | ✓ | Base path for payment UI. Example: https://pay.site.com |
PROCESSING_PAYMENT_FRONTEND_SUB_PATH | string | Sub path for payment UI (default "/p") | |
PROCESSING_WEBHOOK_BASE_PATH | string | ✓ | Base path for webhooks (sub)domain. Example: https://pay.site.com |
SESSION_COOKIE_DOMAIN | string | Cookie domain | |
SESSION_COOKIE_HTTP_ONLY | bool | Allow HTTP cookies only (default "true") | |
SESSION_COOKIE_MAX_AGE | int | Cookie max-age (default "86400") | |
SESSION_COOKIE_PATH | string | Cookie path (default "/") | |
SESSION_COOKIE_SAME_SITE | string | Cookie same site (default "default") | |
SESSION_COOKIE_SECURE | bool | Allow secure cookies only | |
SESSION_FS_PATH | string | ✓ | Path to sessions directory |
SESSION_SECRET | string | ✓ | Sessions secret; use a random string with 8+ characters |
TATUM_API_KEY | string | ✓ | Tatum API Key |
TATUM_HMAC_SECRET | string | ✓ | Tatum HMAC Secret. Use any random string with 8+ chars |
TATUM_TEST_API_KEY | string | ✓ | Tatum Test API Key |
TRONGRID_API_KEY | string | ✓ | Trongrid API Key |
TRONGRID_MAINNET_URL | string | Trongrid API base path (default "https://api.trongrid.io") | |
TRONGRID_TESTNET_URL | string | Trongrid testnet (shasta) API base path (default "https://api.shasta.trongrid.io") | |
WEB_ENABLE_INTERNAL_API | bool | Enables internal API /internal/v1/*. DO NOT EXPOSE TO PUBLIC (default "false") |