Appearance
Environment variables
Every variable the platform, the bridges and the chart service read from .env. "Default" is the value used when the variable is missing. For explanations and safe production values, see Environment (.env).
Variables marked ★ aren't in .env.example. Add them yourself when you need them.
Application
| Variable | Default | Description |
|---|---|---|
APP_NAME | Laravel | Platform name in emails, the browser title and the chart. Also set from Admin → Settings → General. |
APP_ENV | production | production or local. Controls Horizon workers and error display. |
APP_KEY | none | Encryption key. Generate once with php artisan key:generate. |
APP_DEBUG | false | Detailed error pages. Keep false in production. |
APP_URL | https://yourdomain | Full site address, with https:// |
SANCTUM_STATEFUL_DOMAINS | localhost,… | Your domain(s), without https://. Lets the site call its own API. |
APP_PLAN | lite | Product package. Use 5 for futures, P2P and options processors. |
APP_RELEASE_VERSION ★ | 1.0.0 | Version label |
API_VERSION ★ | 1.2 | Version shown in the API reference |
ASSET_URL ★ | none | Serve built files from another address (a CDN) |
LOG_CHANNEL | stack | Where logs go. stack writes one file per day: storage/logs/laravel-YYYY-MM-DD.log. |
LOG_STACK | daily | Channels of the stack (comma separated). single writes one ever-growing laravel.log |
LOG_DAILY_DAYS | 14 | How many daily log files are kept |
LOG_FILE_PERMISSION | 0664 | Permissions of new log files. Every process that logs (web, cron, PM2) must be able to write them: keep them all running as www-data, or use 0666 |
SETTING_CACHE_ENABLED | true | Cache the settings in Redis (encrypted settings stay encrypted in the cache; a save clears it at once) |
LOG_LEVEL ★ | debug | Lowest level written to the log |
GOOGLE_SITE_TAG ★ | none | Google Analytics measurement ID (G-…). Adds the tracking script to every page. |
Front-end build
| Variable | Default | Description |
|---|---|---|
USER_ASSETS | false | "false" when running (loads admin routes too). "true" only while generating the visitor route file. |
USER_ASSETS_HASH | none | Added to every script and stylesheet address. Change after every build. |
MIX_PUSHER_APP_KEY, MIX_PUSHER_HOST, MIX_PUSHER_PORT, MIX_PUSHER_SCHEME, MIX_PUSHER_APP_CLUSTER | copies of PUSHER_* | WebSocket settings built into the browser code. Rebuild after changing. |
MIX_SOCKET_PORT | 6001 | Not used by the current front-end |
Database
| Variable | Default | Description |
|---|---|---|
DB_CONNECTION | mysql | Use pgsql |
DB_HOST | 127.0.0.1 | Database server |
DB_PORT | 5432 | Database port |
DB_DATABASE | forge | Database name |
DB_USERNAME | forge | Database user |
DB_PASSWORD | empty | Database password |
PGHOST, PGUSER, PGDATABASE, PGPASSWORD, PGPORT | copies of DB_* | For PostgreSQL command-line tools only |
Cache, sessions, queues, Redis
| Variable | Default | Description |
|---|---|---|
CACHE_DRIVER | file | Use redis |
SESSION_DRIVER | database | Use redis |
SESSION_LIFETIME ★ | 120 | Minutes of inactivity before sign-out |
SESSION_SECURE_COOKIE ★ | none | true to send the session cookie over HTTPS only |
SESSION_DOMAIN ★ | none | Cookie domain, if you share sessions across subdomains |
QUEUE_CONNECTION | sync | Use redis |
REDIS_HOST | 127.0.0.1 | Redis server |
REDIS_PORT | 6379 | Redis port |
REDIS_PASSWORD | none | Redis password |
REDIS_CLIENT | phpredis | phpredis (needs the PHP extension) or predis |
REDIS_DB ★, REDIS_CACHE_DB ★ | 0, 1 | Redis database numbers for queues/sessions and for cache |
REDIS_PREFIX ★ | empty | Key prefix, if several sites share one Redis |
CACHE_PREFIX ★ | from APP_NAME | Cache key prefix |
MEMCACHED_HOST | 127.0.0.1 | Only with CACHE_DRIVER=memcached |
Email
| Variable | Default | Description |
|---|---|---|
MAIL_MAILER | smtp | Transport |
MAIL_HOST | smtp.mailgun.org | SMTP server |
MAIL_PORT | 587 | SMTP port |
MAIL_USERNAME, MAIL_PASSWORD | none | SMTP login |
MAIL_ENCRYPTION | tls | tls or ssl |
MAIL_FROM_ADDRESS | [email protected] | Sender address |
MAIL_FROM_NAME | Example | Sender name |
MAILGUN_DOMAIN, MAILGUN_SECRET | none | Mailgun API sending (Admin → Settings → Email → Use Mailgun API) |
MAILGUN_ENDPOINT | api.mailgun.net | api.eu.mailgun.net for EU domains |
POSTMARK_TOKEN ★ | none | Only with MAIL_MAILER=postmark |
Real-time
| Variable | Default | Description |
|---|---|---|
BROADCAST_DRIVER | null | Use pusher (Soketi) |
PUSHER_APP_ID, PUSHER_APP_KEY, PUSHER_APP_SECRET | none | Must match socket-config.json |
PUSHER_HOST | none | socket.yourdomain.com |
PUSHER_PORT | none | 443 |
PUSHER_SCHEME | http | https |
PUSHER_APP_CLUSTER | none | Any value, for example mt1 (required by the client library) |
Chart service
| Variable | Default | Description |
|---|---|---|
TRADINGVIEW_CHART_PORT | 8081 | Port of chart-udf |
TRADINGVIEW_CHART_SSL | required | "false" normally. The service crashes if the line is missing. |
TRADINGVIEW_CHART_PRIVATE_KEY, TRADINGVIEW_CHART_CERT_FILE | none | Certificate files when TRADINGVIEW_CHART_SSL="true" |
Background processes
| Variable | Default | Description |
|---|---|---|
PM_PATH | /var/www | PM2 home ($PM_PATH/.pm2) |
PM_PHP_PATH | /usr/bin/php | PHP binary used for PM2 processes |
PM_USR_PATH | /usr/local/bin:/usr/bin:/bin | Where pm2 is found |
PM_SERVICE_WATCHER_ENABLED | true | pm:watcher keeps core processes running |
PM_MARKET_WATCHER_ENABLED | true | pm:market-watcher keeps per-market liquidity processes running (per-market mode only) |
PM_LIQUIDITY_MODE | shared | shared: two liquidity runners for all markets (liquidity-binance, liquidity-custom). per-market: one LIQ-<market> process per market |
PM_LIQUIDITY_SHARDS | 1 | Split the provider liquidity runner over this many processes (liquidity-binance-1, -2, ...), for many markets |
PM_KILL_TIMEOUT | 15 | Seconds PM2 gives a worker to finish its current pass when stopping or restarting it |
PM_STALE_RESTART_COOLDOWN | 300 | pm:watcher restarts a stuck worker (no heartbeat) at most once per this many seconds |
PM_ECOSYSTEM_PATH | storage/app/pm2/ecosystem.json | Where pm:ecosystem / pm:watcher write the PM2 file |
PM_REDIS_CONNECTION | default | Redis connection used to wake workers at once (after trades and price ticks) |
BINANCE_STREAM_URL | wss://stream.binance.com:9443/stream | Binance combined-stream address used by the provider liquidity runner (the testnet one when BINANCE_API_TESTNET=true) |
Matching engine
| Variable | Default | Description |
|---|---|---|
MATCHING_ENGINE_ENABLED | false | Use the Rust engine for markets without a liquidity provider |
MATCHING_ENGINE_FORCE_LARAVEL ★ | false | Temporarily use the platform's matching everywhere |
MATCHING_ENGINE_HOST | 127.0.0.1 | Engine address |
MATCHING_ENGINE_PORT | 9000 | Engine port |
MATCHING_ENGINE_TIMEOUT | 5 | Seconds |
MATCHING_ENGINE_RECONNECT_ATTEMPTS ★ | 3 | Reconnection tries |
MATCHING_ENGINE_RECONNECT_DELAY ★ | 100 | Milliseconds between tries |
MATCHING_ENGINE_PRICE_PRECISION | 100000000 | Integer multiplier for prices |
MATCHING_ENGINE_QUANTITY_PRECISION | 100000000 | Integer multiplier for quantities |
MATCHING_ENGINE_SYMBOL_SEPARATOR ★ | / | Symbol format |
MATCHING_ENGINE_DEBUG | false | Extra logging |
Blockchains
| Variable | Default | Description |
|---|---|---|
APP_ETHEREUM_NODE | none, required for Ethereum | Ethereum node URL used by the bridge |
APP_BNB_NODE | https://bsc-dataseed.binance.org | BNB Smart Chain node |
APP_POLYGON_NODE | https://polygon-rpc.com | Polygon node |
APP_TRON_NODE | https://api.trongrid.io | Tron node for the Tron bridge (https://api.shasta.trongrid.io for testing) |
APP_TRONGRID_API | none | TronGrid API key for the Tron bridge (sent only when set) |
SOLANA_RPC_ENDPOINT | https://api.mainnet-beta.solana.com | Solana RPC |
TON_RPC_ENDPOINT (or TON_API_ENDPOINT) | https://toncenter.com/api/v2/jsonRPC | TON RPC |
TON_API_KEY | none | toncenter API key |
APP_TON_PORT ★ | 8007 | TON bridge port |
XRP_RPC_ENDPOINT | https://s1.ripple.com:51234 | XRP Ledger RPC |
APP_ETHERSCAN_KEY | none | Etherscan V2 key(s) for Ethereum deposit detection: one, or several comma-separated (they share the hour). Also the fallback key of every EVM chain without its own |
APP_BSCSCAN_KEY | none | The same for BNB Smart Chain |
APP_POLYGONSCAN_KEY | none | The same for Polygon |
APP_ETHERSCAN_API ★, APP_POLYGONSCAN_API ★ | https://api.etherscan.io/v2/api | Explorer API address |
APP_TRONSCAN_API ★ | https://apilist.tronscanapi.com (deposits), https://apilist.tronscan.org (merchant module) | Tronscan API |
APP_TRONSCAN_KEY ★ | empty | Tronscan API key (sent as TRON-PRO-API-KEY), optional |
CUSTOMTOKEN_EXPLORER_TX ★ | https://explorer.customtokenveo.xyz/tx/%s | Transaction link of the custom chain |
CUSTOMTOKEN_EXPLORER_API ★ | https://explorer.customtokenveo.xyz/api/v2 | Blockscout-compatible explorer API of the custom chain, used to detect coin and token deposits |
APP_ETHEREUM_URL ★, APP_BSC_URL ★, APP_TRON_URL ★, APP_POLYGON_URL ★, APP_SOLANA_URL ★, APP_TON_URL ★ | http://localhost:8000 … :8007 | Where the platform finds each bridge |
BITCOIND_HOST | localhost | Bitcoin Core RPC host |
BITCOIND_PORT | 8332 | Bitcoin Core RPC port |
BITCOIND_USER, BITCOIND_PASSWORD | empty | Bitcoin Core RPC login |
BITCOIND_SCHEME ★ | http | RPC scheme |
Liquidity, prices and swaps
| Variable | Default | Description |
|---|---|---|
BINANCE_API_KEY, BINANCE_API_SECRET | none | Liquidity provider account |
BINANCE_API_TESTNET ★ | false | Use Binance's test network |
CURRENCYAPI_KEY | none | currencyapi.com key for daily fiat rates |
FIXED_SWAP | false | Swaps at the last price, even with an empty book |
P2P_DEFAULT_BASE_PAIR ★ | USDT | Coin pre-selected on the P2P page |
P2P_DEFAULT_QUOTE_PAIR ★ | USD | Fiat currency pre-selected on the P2P page |
Sign-in providers
Setup guides: Google, Apple, Telegram, Passkeys, SMS with Twilio.
| Variable | Default | Description |
|---|---|---|
GOOGLE_CLIENT_ID, GOOGLE_CLIENT_SECRET | none | Google OAuth app |
GOOGLE_REDIRECT_URI | none | https://yourdomain.com/login/google/callback |
SMS_DRIVER | twilio | twilio sends SMS codes; log writes them to the daily log (storage/logs/laravel-YYYY-MM-DD.log) (local testing only) |
TWILIO_ACCOUNT_SID, TWILIO_AUTH_TOKEN | none | Twilio account credentials (phone sign-up and SMS codes) |
TWILIO_VERIFY_SID | none | Twilio Verify service SID (VA…). Recommended: Twilio makes and checks the codes |
TWILIO_FROM | none | Twilio number or sender ID. Needed for SMS security notices; sends the codes when there is no Verify service |
TELEGRAM_BOT_TOKEN | none | Token of the Telegram bot used for sign-in (from @BotFather). The Telegram button shows once it is set |
TELEGRAM_BOT_USERNAME | none | The bot's username, without @ |
TELEGRAM_AUTH_ENABLED | true | Set to false to hide the Telegram button even with a token |
APPLE_AUTH_ENABLED | false | Show the Apple button |
APPLE_CLIENT_ID, APPLE_CLIENT_SECRET, APPLE_KEY_ID, APPLE_TEAM_ID, APPLE_PRIVATE_KEY, APPLE_PASSPHRASE | none | Sign in with Apple credentials |
APPLE_REDIRECT_URI | none | https://yourdomain.com/auth/apple/callback |
TURNSTILE_SITE_KEY, TURNSTILE_SECRET_KEY | none | Cloudflare Turnstile keys (Admin → Settings → Captcha) |
PASSKEYS_ENABLED | true | Passkeys. false hides them everywhere |
PASSKEYS_RP_ID | host of APP_URL | Domain the passkeys belong to, e.g. yourdomain.com. It must be a domain, never an IP address: with an IP, passkeys are switched off |
PASSKEYS_ORIGINS | none | Extra addresses the site is opened at, comma separated (e.g. https://www.yourdomain.com). APP_URL is always allowed |
Identity verification
| Variable | Default | Description |
|---|---|---|
SUMSUB_ENABLED | none | true to use Sumsub |
SUMSUB_APP_TOKEN, SUMSUB_APP_SECRET | none | Sumsub API credentials |
SUMSUB_WEBHOOK_SECRET | none | Secret for Sumsub's webhook to https://yourdomain.com/api/v1/sumsub/ipn |
SUMSUB_KYC_LEVEL | none | Name of the verification level in your Sumsub dashboard |
Mobile app
| Variable | Default | Meaning |
|---|---|---|
MOBILE_APP_SCHEME | cryptotech | Link scheme the mobile app opens after Google / X / Apple sign-in. Must match the app's APP_SCHEME. |
FIREBASE_CREDENTIALS | none | Path to the Firebase service-account JSON for push notifications (absolute, or relative to the project folder). Empty = no pushes. |
PASSKEYS_ANDROID_PACKAGE | none | Android application ID of your app (e.g. exchange.cryptotech.exchange_app). Needed for passkeys in the Android app |
PASSKEYS_ANDROID_FINGERPRINTS | none | SHA-256 fingerprint(s) of the app's signing certificate, AA:BB:…, comma separated (Play App Signing key + upload key). Published at /.well-known/assetlinks.json and allowed as passkey origins |
PASSKEYS_IOS_APP_IDS | none | TEAMID.bundle.id of the iOS app, comma separated. Published at /.well-known/apple-app-site-association |
Payments and custody
| Variable | Default | Description |
|---|---|---|
UNLIMIT_ENABLED | false | Show the Buy crypto pop-up |
UNLIMIT_ACCESS_KEY, UNLIMIT_SECRET_KEY, UNLIMIT_PARTNER_ACCOUNT_ID | none | Unlimit (GateFi) credentials (Admin → Settings → Unlimit) |
UNLIMIT_BASE_URL | https://api-sandbox.gatefi.com | Sandbox by default. Use the live address in production. |
UNLIMIT_DEFAULT_BASE_PAIR ★ | USD | Default fiat currency in the pop-up |
UNLIMIT_DEFAULT_QUOTE_PAIR ★ | USDT | Default coin in the pop-up |
UNLIMIT_REDIRECT_URL ★ | APP_URL | Where users return after paying |
PAYEER_MERCHANT_ID, PAYEER_MERCHANT_KEY, PAYEER_ACCOUNT_ID, PAYEER_API_KEY, PAYEER_API_ID | none | Payeer |
PERFECT_MONEY_LOGIN, PERFECT_MONEY_PASSWORD, PERFECT_MONEY_ACCOUNT_ID | none | Perfect Money |
PERFECT_MONEY_AUTO_WITHDRAWALS ★ | none | Automatic Perfect Money payouts |
FIREBLOCKS_ENABLED | false | Use Fireblocks |
FIREBLOCKS_WEBHOOK_PUBLIC_KEY ★ | empty | Fireblocks webhook public key (PEM, \n allowed, or a file path). Required with Fireblocks: webhooks without a valid Fireblocks-Signature are refused |
FIREBLOCKS_API_KEY ★ | empty | Fireblocks API key |
FIREBLOCKS_BASE_URL ★ | https://sandbox-api.fireblocks.io | Sandbox by default |
FIREBLOCKS_PUBLIC_KEY_PATH ★ | fireblocks_secret.key | Path to the API secret key file |
FIREBLOCKS_EVM_HOT_WALLET ★ | empty | EVM hot wallet address in Fireblocks |
Merchant payments
| Variable | Default | Description |
|---|---|---|
MERCHANT_ACQUIRING_ENABLED | false | Turn on the merchant module |
MERCHANT_ACQUIRING_ENV ★ | live | live or sandbox |
MERCHANT_CHECKOUT_URL ★ | https://pay.example.com | Base address of the hosted checkout |
INVOICE_PAYMENT_EXPIRY ★ | 1800 | Seconds a customer has to pay an invoice |
RATE_SOURCE ★ | binance | Exchange-rate source for invoices: binance, coingecko, internal or fixed |
Feature switches
| Variable | Default | Description |
|---|---|---|
READ_ONLY_MODE | false | Demo mode: blocks all changes. Never on a live site. |
DEMO_LOGIN_EMAIL, DEMO_LOGIN_PASSWORD | [email protected], 123123123 | Prefilled on the login form in read-only (demo) mode only. The account isn't created automatically |
UI_PALETTE | gold | Brand colour palette for the website: gold, ember, ocean, violet, mint (themes) |
UI_PALETTE_PICKER | false | true shows the Color theme choice to visitors |
SENSITIVE_MODE ★ | false | Mask secrets in admin settings |
LENDING_ENABLED | false | Lending module |
ENABLE_AUTO_WITHDRAWALS | false | Approve covered withdrawals automatically |
DEPOSIT_BONUS_ENABLED | false | Deposit bonuses |
ENABLE_FEES_IN_USD ★ | false | Show fixed withdrawal fees in USD |
HIDE_CMC_GECKO | not set | true hides internal endpoints from the API reference |
DEBUGBAR_ENABLED | not set | Developer debug bar. Keep false. |
Not used
TRADE_FREQUENCY and MIX_SOCKET_PORT are in .env.example but aren't read by the current code.
