|
|
# –––––––––––––––– REQUIRED ––––––––––––––––
|
|
|
NODE_ENV=production
|
|
|
|
|
|
# Generate a hex-encoded 32-byte random key. You should use `openssl rand -hex 32`
|
|
|
# in your terminal to generate a random value.
|
|
|
SECRET_KEY=<Generate with openssl rand -hex 32>
|
|
|
|
|
|
# Generate a unique random key. The format is not important but you could still use
|
|
|
# `openssl rand -hex 32` in your terminal to produce this.
|
|
|
UTILS_SECRET=<Generate with openssl rand -hex 32>
|
|
|
|
|
|
# For production point these at your databases, in development the default
|
|
|
# should work out of the box.
|
|
|
DATABASE_URL=postgres://postgres:<insert long and scary PG password>@outline-postgres:5432/outline
|
|
|
DATABASE_URL_TEST=postgres://postgres:<insert long and scary PG password>@outline-postgres:5432/outline-test
|
|
|
DATABASE_CONNECTION_POOL_MIN=
|
|
|
DATABASE_CONNECTION_POOL_MAX=
|
|
|
# Uncomment this to disable SSL for connecting to Postgres
|
|
|
PGSSLMODE=disable
|
|
|
|
|
|
# For redis you can either specify an ioredis compatible url like this
|
|
|
REDIS_URL=redis://outline-redis:6379
|
|
|
# or alternatively, if you would like to provide additional connection options,
|
|
|
# use a base64 encoded JSON connection option object. Refer to the ioredis documentation
|
|
|
# for a list of available options.
|
|
|
# Example: Use Redis Sentinel for high availability
|
|
|
# {"sentinels":[{"host":"sentinel-0","port":26379},{"host":"sentinel-1","port":26379}],"name":"mymaster"}
|
|
|
# REDIS_URL=ioredis://eyJzZW50aW5lbHMiOlt7Imhvc3QiOiJzZW50aW5lbC0wIiwicG9ydCI6MjYzNzl9LHsiaG9zdCI6InNlbnRpbmVsLTEiLCJwb3J0IjoyNjM3OX1dLCJuYW1lIjoibXltYXN0ZXIifQ==
|
|
|
|
|
|
# URL should point to the fully qualified, publicly accessible URL. If using a
|
|
|
# proxy the port in URL and PORT may be different.
|
|
|
URL=https://outline.yourdomain.com
|
|
|
PORT=3000
|
|
|
|
|
|
# See [documentation](/SERVICES.md) on running a separate collaboration
|
|
|
# server, for normal operation this does not need to be set.
|
|
|
COLLABORATION_URL=
|
|
|
|
|
|
# To support uploading of images for avatars and document attachments an
|
|
|
# s3-compatible storage must be provided. AWS S3 is recommended for redundancy
|
|
|
# however if you want to keep all file storage local an alternative such as
|
|
|
# minio (https://github.com/minio/minio) can be used.
|
|
|
|
|
|
# A more detailed guide on setting up S3 is available here:
|
|
|
# => https://wiki.generaloutline.com/share/125de1cc-9ff6-424b-8415-0d58c809a40f
|
|
|
#
|
|
|
AWS_ACCESS_KEY_ID=minio
|
|
|
AWS_SECRET_ACCESS_KEY=<insert long and scary minio password>
|
|
|
AWS_REGION=us-east-1
|
|
|
AWS_S3_ACCELERATE_URL=
|
|
|
AWS_S3_UPLOAD_BUCKET_URL=https://outlinedata.yourdomain.com
|
|
|
AWS_S3_UPLOAD_BUCKET_NAME=outlinebucket
|
|
|
AWS_S3_UPLOAD_MAX_SIZE=26214400
|
|
|
AWS_S3_FORCE_PATH_STYLE=true
|
|
|
AWS_S3_ACL=private
|
|
|
|
|
|
|
|
|
# –––––––––––––– AUTHENTICATION ––––––––––––––
|
|
|
|
|
|
# Third party signin credentials, at least ONE OF EITHER Google, Slack,
|
|
|
# or Microsoft is required for a working installation or you'll have no sign-in
|
|
|
# options.
|
|
|
|
|
|
# To configure Slack auth, you'll need to create an Application at
|
|
|
# => https://api.slack.com/apps
|
|
|
#
|
|
|
# When configuring the Client ID, add a redirect URL under "OAuth & Permissions":
|
|
|
# https://<URL>/auth/slack.callback
|
|
|
SLACK_CLIENT_ID=
|
|
|
SLACK_CLIENT_SECRET=
|
|
|
|
|
|
# To configure Google auth, you'll need to create an OAuth Client ID at
|
|
|
# => https://console.cloud.google.com/apis/credentials
|
|
|
#
|
|
|
# When configuring the Client ID, add an Authorized redirect URI:
|
|
|
# https://<URL>/auth/google.callback
|
|
|
GOOGLE_CLIENT_ID=
|
|
|
GOOGLE_CLIENT_SECRET=
|
|
|
|
|
|
# To configure Microsoft/Azure auth, you'll need to create an OAuth Client. See
|
|
|
# the guide for details on setting up your Azure App:
|
|
|
# => https://wiki.generaloutline.com/share/dfa77e56-d4d2-4b51-8ff8-84ea6608faa4
|
|
|
AZURE_CLIENT_ID=
|
|
|
AZURE_CLIENT_SECRET=
|
|
|
AZURE_RESOURCE_APP_ID=
|
|
|
|
|
|
# To configure generic OIDC auth, you'll need some kind of identity provider.
|
|
|
# See documentation for whichever IdP you use to acquire the following info:
|
|
|
# Redirect URI is https://<URL>/auth/oidc.callback
|
|
|
|
|
|
## Because I'm using personal gmail accounts I put CLIENT_ID and CLIENT_SECRET Here in OIDC instead of the Google Section
|
|
|
OIDC_CLIENT_ID=outline.yourdomain.com
|
|
|
OIDC_CLIENT_SECRET=<use your own client secret generated in keycloak>
|
|
|
OIDC_AUTH_URI=https://auth.yourdomain.com/realms/master/protocol/openid-connect/auth
|
|
|
OIDC_TOKEN_URI=https://auth.yourdomain.com/realms/master/protocol/openid-connect/token
|
|
|
OIDC_USERINFO_URI=https://auth.yourdomain.com/realms/master/protocol/openid-connect/userinfo
|
|
|
|
|
|
# Specify which claims to derive user information from
|
|
|
# Supports any valid JSON path with the JWT payload
|
|
|
OIDC_USERNAME_CLAIM=preferred_username
|
|
|
|
|
|
# Display name for OIDC authentication
|
|
|
OIDC_DISPLAY_NAME=Keycloak
|
|
|
|
|
|
# Space separated auth scopes.
|
|
|
OIDC_SCOPES=openid profile email
|
|
|
|
|
|
|
|
|
# –––––––––––––––– OPTIONAL ––––––––––––––––
|
|
|
|
|
|
# If using a Cloudfront/Cloudflare distribution or similar it can be set below.
|
|
|
# This will cause paths to javascript, stylesheets, and images to be updated to
|
|
|
# the hostname defined in CDN_URL. In your CDN configuration the origin server
|
|
|
# should be set to the same as URL.
|
|
|
CDN_URL=
|
|
|
|
|
|
# Auto-redirect to https in production. The default is true but you may set to
|
|
|
# false if you can be sure that SSL is terminated at an external loadbalancer.
|
|
|
FORCE_HTTPS=true
|
|
|
|
|
|
# Have the installation check for updates by sending anonymized statistics to
|
|
|
# the maintainers
|
|
|
ENABLE_UPDATES=true
|
|
|
|
|
|
# How many processes should be spawned. As a reasonable rule divide your servers
|
|
|
# available memory by 512 for a rough estimate
|
|
|
WEB_CONCURRENCY=1
|
|
|
|
|
|
# Override the maximum size of document imports, could be required if you have
|
|
|
# especially large Word documents with embedded imagery
|
|
|
MAXIMUM_IMPORT_SIZE=5120000
|
|
|
|
|
|
# You can remove this line if your reverse proxy already logs incoming http
|
|
|
# requests and this ends up being duplicative
|
|
|
DEBUG=http
|
|
|
|
|
|
# Configure lowest severity level for server logs. Should be one of
|
|
|
# error, warn, info, http, verbose, debug and silly
|
|
|
LOG_LEVEL=info
|
|
|
|
|
|
|
|
|
# To support sending outgoing transactional emails such as "document updated" or
|
|
|
# "you've been invited" you'll need to provide authentication for an SMTP server
|
|
|
SMTP_HOST=
|
|
|
SMTP_PORT=
|
|
|
SMTP_USERNAME=
|
|
|
SMTP_PASSWORD=
|
|
|
SMTP_FROM_EMAIL=hello@example.com
|
|
|
SMTP_REPLY_EMAIL=hello@example.com
|
|
|
SMTP_TLS_CIPHERS=
|
|
|
SMTP_SECURE=true
|
|
|
|
|
|
# The default interface language. See translate.getoutline.com for a list of
|
|
|
# available language codes and their rough percentage translated.
|
|
|
DEFAULT_LANGUAGE=en_US
|
|
|
|
|
|
# Optionally enable rate limiter at application web server
|
|
|
RATE_LIMITER_ENABLED=true
|
|
|
|
|
|
# Configure default throttling parameters for rate limiter
|
|
|
RATE_LIMITER_REQUESTS=1000
|
|
|
RATE_LIMITER_DURATION_WINDOW=60
|
|
|
|
|
|
# Iframely API config
|
|
|
# IFRAMELY_URL=
|
|
|
# IFRAMELY_API_KEY= |