Skip to content

Latest commit

 

History

History
40 lines (35 loc) · 8.58 KB

environment-variables.md

File metadata and controls

40 lines (35 loc) · 8.58 KB
description
All configurable environment variables

Environment Variables

Security Configuration

Variable Name Description Default Value
NEXT_ENV_IMAGES_ALL_REMOTE Set to false to allow attachment preview, or modify apps/nextjs-app/next.config.js and rebuild the Dockerfile to specify a secure domain. false

Backend Configuration

Variable Name Description Default Value
PUBLIC_ORIGIN

Required to enable attachment upload, email notification etc.
Service access address.
example: http://example.com

PUBLIC_DATABASE_PROXY

Required to enable the database connection feature in Base.
The public IP address or domain of the server hosting the database + the database service port exposed by Docker (default is 42345) Example: example.com:42345

API_DOC_DISENABLED Whether to disable API documentation false
BACKEND_MAIL_HOST

Fill in the following when needing to send emails
Email service HOST

BACKEND_MAIL_PORT Email service PORT 465
PRISMA_DATABASE_URL Database URL
BACKEND_MAIL_SECURE Use TLS/STARTTLS to securely send emails true
BACKEND_MAIL_SENDER Sender's address
BACKEND_MAIL_SENDER_NAME Sender's name
BACKEND_MAIL_AUTH_USER Email service account
BACKEND_CACHE_PROVIDER

Cache storage mode:
memory
sqlite
redis

sqlite
BACKEND_MAIL_AUTH_PASS

Email service password
Usually not the web login password, but a separate email authorization code set

BACKEND_CACHE_REDIS_URI

Required for redis, redis connection address:
redis://:password@127.0.0.1:6380/4
redis://username:password@127.0.0.1:6380/4

BACKEND_CACHE_SQLITE_URI Required for sqlite, sqlite connection address sqlite://.assets/.cache.db
BACKEND_STORAGE_PROVIDER

Object storage mode:
local
minio

local
BACKEND_STORAGE_PUBLIC_BUCKET Public resource bucket name public
BACKEND_STORAGE_PRIVATE_BUCKET Private resource bucket name private
BACKEND_STORAGE_LOCAL_PATH Required for local mode, .assets/uploads
BACKEND_STORAGE_MINIO_ENDPOINT Required for mino mode, minio service domain
BACKEND_STORAGE_MINIO_PORT Required for mino mode, minio service port 9000
BACKEND_STORAGE_MINIO_USE_SSL Required for mino mode, use https? false
BACKEND_STORAGE_MINIO_ACCESS_KEY Required for mino mode, minio username
BACKEND_STORAGE_MINIO_SECRET_KEY Required for mino mode, minio password
STORAGE_PREFIX

Preview resource prefix address
local: Not required,
minio: minio service domain + port