.env.sample
Set these on your host before deploying. Each platform has an “Environment Variables” section in the deploy flow. (showing first 20, more exist in .env.sample)
NODE_ENV
URL
This URL should point to the fully qualified, publicly accessible, URL. If using a proxy this will be the proxy's URL.
PORT
The port to expose the Outline server on, this should match what is configured in your docker-compose.yml
COLLABORATION_URL
See [documentation](docs/SERVICES.md) on running a separate collaboration server, for normal operation this does not need to be set.
CDN_URL
If using a Cloudfront/Cloudflare distribution or similar it can be set below. This will cause paths to javascript, stylesheets, and images…
WEB_CONCURRENCY
How many processes should be spawned. As a reasonable rule divide your servers available memory by 512 for a rough estimate
SECRET_KEY
secret
Generate a hex-encoded 32-byte random key. Use `openssl rand -hex 32` in your terminal to generate a random value.
UTILS_SECRET
secret
Generate a unique random key. The format is not important but you could still use `openssl rand -hex 32` in your terminal to generate a…
DEFAULT_LANGUAGE
The default interface language. See translate.getoutline.com for a list of available language codes and their rough percentage translated.
DATABASE_URL
secret
The database URL for your production database, including username, password, and database name.
DATABASE_CONNECTION_POOL_MIN
The in-memory database pool per-process settings. Ensure that the pool size that will not exceed the maximum number of connections allowed…
DATABASE_CONNECTION_POOL_MAX
REDIS_URL
secret
The Redis URL for your environment you can either specify an ioredis compatible url or a Base64 encoded configuration object. DOCS:…
REDIS_COLLABORATION_URL
To enable horizontal scaling of the collaboration service you must provide a Redis URL, it may be the same as above, or a different server.…
FILE_STORAGE
Specify what storage system to use. Possible value is one of "s3" or "local". For "local" images and document attachments will be saved on…
FILE_STORAGE_LOCAL_ROOT_DIR
If "local" is configured for FILE_STORAGE above, then this sets the parent directory under which all attachments/images are stored. Make…
FILE_STORAGE_UPLOAD_MAX_SIZE
Maximum allowed size for the uploaded attachment.
FILE_STORAGE_IMPORT_MAX_SIZE
Override the maximum size of document imports, generally this should be lower than the document attachment maximum size.
FILE_STORAGE_WORKSPACE_IMPORT_MAX_SIZE
Override the maximum size of workspace imports, these can be especially large and the files are temporary being automatically deleted after…
AWS_ACCESS_KEY_ID
secret
To support uploading of images for avatars and document attachments in a distributed architecture, an s3-compatible storage can be…