64c3ff8d6b
Add 'Installation' section
63 lines
1.8 KiB
Plaintext
63 lines
1.8 KiB
Plaintext
# Copy this file to .env, remove this comment and change the keys. For development
|
|
# with docker this should mostly work out of the box other than setting the Slack
|
|
# keys (for auth) and the SECRET_KEY.
|
|
#
|
|
# Please use `openssl rand -hex 32` to create SECRET_KEY
|
|
SECRET_KEY=generate_a_new_key
|
|
UTILS_SECRET=generate_a_new_key
|
|
|
|
DATABASE_URL=postgres://user:pass@localhost:5532/outline
|
|
DATABASE_URL_TEST=postgres://user:pass@localhost:5532/outline-test
|
|
REDIS_URL=redis://localhost:6479
|
|
|
|
URL=http://localhost:3000
|
|
PORT=3000
|
|
|
|
# enforce (auto redirect to) https in production, (optional) default is true.
|
|
# set to false if your SSL is terminated at a loadbalancer, for example
|
|
FORCE_HTTPS=true
|
|
|
|
ENABLE_UPDATES=true
|
|
WEBSOCKETS_ENABLED=true
|
|
DEBUG=cache,presenters,events
|
|
|
|
# Third party signin credentials (at least one is required)
|
|
SLACK_KEY=get_a_key_from_slack
|
|
SLACK_SECRET=get_the_secret_of_above_key
|
|
|
|
GOOGLE_CLIENT_ID=
|
|
GOOGLE_CLIENT_SECRET=
|
|
|
|
# Comma separated list of domains to be allowed (optional)
|
|
# If not set, all Google apps domains are allowed by default
|
|
GOOGLE_ALLOWED_DOMAINS=
|
|
|
|
# Third party credentials (optional)
|
|
SLACK_VERIFICATION_TOKEN=PLxk6OlXXXXXVj3YYYY
|
|
SLACK_APP_ID=A0XXXXXXX
|
|
SLACK_MESSAGE_ACTIONS=true
|
|
GOOGLE_ANALYTICS_ID=
|
|
SENTRY_DSN=
|
|
|
|
# AWS credentials (optional in development)
|
|
AWS_ACCESS_KEY_ID=get_a_key_from_aws
|
|
AWS_SECRET_ACCESS_KEY=get_the_secret_of_above_key
|
|
AWS_REGION=xx-xxxx-x
|
|
AWS_S3_UPLOAD_BUCKET_URL=http://s3:4569
|
|
AWS_S3_UPLOAD_BUCKET_NAME=bucket_name_here
|
|
AWS_S3_UPLOAD_MAX_SIZE=26214400
|
|
# uploaded s3 objects permission level, default is private
|
|
# set to "public-read" to allow public access
|
|
AWS_S3_ACL=private
|
|
|
|
# Emails configuration (optional)
|
|
SMTP_HOST=
|
|
SMTP_PORT=
|
|
SMTP_USERNAME=
|
|
SMTP_PASSWORD=
|
|
SMTP_FROM_EMAIL=
|
|
SMTP_REPLY_EMAIL=
|
|
|
|
# Custom logo that displays on the authentication screen, scaled to height: 60px
|
|
# TEAM_LOGO=https://example.com/images/logo.png
|