Configuration
Every environment variable the panel reads.
The panel reads its settings from apps/web/.env. Branding, billing provider, store URL and currency are set in Admin → Settings instead, so they can change without a restart.
Required
| Variable | Description |
|---|---|
BETTER_AUTH_SECRET | At least 32 random characters. Signs sessions and encrypts stored secrets. Generate with openssl rand -base64 32. |
BETTER_AUTH_URL | The URL people use to open the panel, for example https://panel.example.com. |
DATABASE_URL | Postgres connection string. Set for you by Docker Compose. |
REDIS_URL | Redis connection string. Defaults to redis://localhost:6379. Set for you by Docker Compose. |
Panel
| Variable | Description |
|---|---|
BYTEPANEL_PUBLIC_URL | The URL nodes use to reach the panel. Defaults to BETTER_AUTH_URL. Set it when nodes reach the panel at a different address. |
DATABASE_URL_UNPOOLED | A direct Postgres connection for migrations, if DATABASE_URL goes through a pooler such as PgBouncer. |
Storage
Used for profile pictures. Any S3-compatible service works, including MinIO, Cloudflare R2, Backblaze B2 and AWS S3. Requests use path-style URLs.
| Variable | Description |
|---|---|
S3_ENDPOINT | For example https://s3.example.com. |
S3_REGION | Defaults to us-east-1. |
S3_BUCKET | Bucket name. |
S3_ACCESS_KEY_ID | Access key. |
S3_SECRET_ACCESS_KEY | Secret key. |
When SMTP isn't set, the panel skips sending email. Password resets need email to work.
| Variable | Description |
|---|---|
SMTP_HOST | SMTP server. |
SMTP_PORT | Usually 587. |
SMTP_USER | Username. |
SMTP_PASS | Password. |
SMTP_FROM | The address emails come from. |
Billing
Only needed for the billing option you choose. See Billing.
| Variable | Used by |
|---|---|
BYTEPAY_URL, BYTEPAY_API_URL, BYTEPAY_CLIENT_ID, BYTEPAY_CLIENT_SECRET | BytePay sign-in and ordering. |
STRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRET | Built-in billing with Stripe. |
PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PAYPAL_WEBHOOK_ID, PAYPAL_SANDBOX | Built-in billing with PayPal. |
Monitoring
| Variable | Description |
|---|---|
NEXT_PUBLIC_SENTRY_DSN | Send errors to Sentry. Optional. |
SENTRY_ORG, SENTRY_PROJECT | Upload source maps at build time. Optional. |
UPDATE_CHECK_PANEL_REPO, UPDATE_CHECK_AGENT_REPO | GitHub repos checked for new releases. Default to NodeByteHosting/BytePanel. |