Skip to Content
BytePanelBytePanel

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

VariableDescription
BETTER_AUTH_SECRETAt least 32 random characters. Signs sessions and encrypts stored secrets. Generate with openssl rand -base64 32.
BETTER_AUTH_URLThe URL people use to open the panel, for example https://panel.example.com.
DATABASE_URLPostgres connection string. Set for you by Docker Compose.
REDIS_URLRedis connection string. Defaults to redis://localhost:6379. Set for you by Docker Compose.

Panel

VariableDescription
BYTEPANEL_PUBLIC_URLThe 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_UNPOOLEDA 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.

VariableDescription
S3_ENDPOINTFor example https://s3.example.com.
S3_REGIONDefaults to us-east-1.
S3_BUCKETBucket name.
S3_ACCESS_KEY_IDAccess key.
S3_SECRET_ACCESS_KEYSecret key.

Email

When SMTP isn't set, the panel skips sending email. Password resets need email to work.

VariableDescription
SMTP_HOSTSMTP server.
SMTP_PORTUsually 587.
SMTP_USERUsername.
SMTP_PASSPassword.
SMTP_FROMThe address emails come from.

Billing

Only needed for the billing option you choose. See Billing.

VariableUsed by
BYTEPAY_URL, BYTEPAY_API_URL, BYTEPAY_CLIENT_ID, BYTEPAY_CLIENT_SECRETBytePay sign-in and ordering.
STRIPE_SECRET_KEY, STRIPE_WEBHOOK_SECRETBuilt-in billing with Stripe.
PAYPAL_CLIENT_ID, PAYPAL_CLIENT_SECRET, PAYPAL_WEBHOOK_ID, PAYPAL_SANDBOXBuilt-in billing with PayPal.

Monitoring

VariableDescription
NEXT_PUBLIC_SENTRY_DSNSend errors to Sentry. Optional.
SENTRY_ORG, SENTRY_PROJECTUpload source maps at build time. Optional.
UPDATE_CHECK_PANEL_REPO, UPDATE_CHECK_AGENT_REPOGitHub repos checked for new releases. Default to NodeByteHosting/BytePanel.
Edit on GitHub

On this page