Outline

An open, extensible, wiki for your team built using React and Node.js.

Official integration

Created 5 years ago - Last update 2 years ago

Outline is an open, extensible, wiki for your team built using React and Node.js. Outline requires an external authentication provider such as Google/Slack, etc. If you don't want to rely on those solutions you can use a generic OpenID Connect Server. For instance you can use the Open Source Keycloak alternative (there is a Caprover one-click-apps for that) IMPORTANT: You need to, at least, set one 3rd party login method, either Keycloak, Slack or Google

Deployed services

outline-redis

redis:$$cap_redis_version

outline-redis-data:/redis.conf

always

outline-db

postgres:$$cap_postgres_version

outline-db-data:/var/lib/postgresql/data

always

outline

custom

3000

Variables

Outline Version

Default: 0.68.1

$$cap_outline_version
Check out their page for the valid tags https://hub.docker.com/r/outlinewiki/outline/tags

Postgres Version

Default: 14.4

$$cap_postgres_version
Check out their page for the valid tags https://hub.docker.com/_/postgres?tab=tags

Redis Version

Default: 7.0.2

$$cap_redis_version
Check out their Docker page for the valid tags https://hub.docker.com/_/redis?tab=tags

SECRET_KEY

Default: undefined

$$cap_secret_key
Run this command to generate a key: `openssl rand -hex 32`

UTILS_SECRET

Default: undefined

$$cap_utils_secret
Run this command to generate a key: `openssl rand -hex 32`

Database user

Default: outline_user

$$cap_db_user

Database password

Default: $$cap_gen_random_hex(20)

$$cap_db_pass

S3 Storage compatible API URL for instance Minio, AWS, etc.

Default: https://YOUR_S3_STORAGE_PROVIDER_API_URL

$$cap_s3_storage_url
NB: You can have your own S3 storage by using the Open Source Minio alternative (there is a Caprover one-click-apps for that)

S3 Storage region

Default: eu-east-1

$$cap_s3_storage_region
Name of the location of the server e.g. "us-west-rack2"

S3 Storage bucket name

Default: outline-data

$$cap_s3_storage_bucket_name
Log into the Minio dashboard, then select the `Create Bucket` menu option to create a new bucket (e.g. named outline-data). Don't forget to add `Read and Write` policy to the bucket so the Outline app would be able to upload content

S3 storage Access Key ID

Default: outline_user

$$cap_s3_storage_access_key_id
For instance in your Minio instance, create a new user called outline_user for the outline app with a new policy that grants full access inside the bucket (e.g. outlineAppFullAccess - see also https://wiki.generaloutline.com/share/125de1cc-9ff6-424b-8415-0d58c809a40f#h-iam-policy)

S3 storage Secret Access Key

Default: undefined

$$cap_s3_storage_secret_access_key
For instance in your Minio instance it correponds to the password/secret of above outline_user

Google Client ID

Default: undefined

$$cap_google_client_id

Google Client Secret

Default: undefined

$$cap_google_client_secret

SMTP host

Default: undefined

$$cap_smtp_host
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 port

Default: undefined

$$cap_smtp_port

SMTP username

Default: undefined

$$cap_smtp_username

SMTP password

Default: undefined

$$cap_smtp_password

SMTP from email

Default: undefined

$$cap_smtp_from_email

SMTP reply email

Default: undefined

$$cap_smtp_reply_email

SMTP TLS ciphers

Default: undefined

$$cap_smtp_tls_ciphers

SMTP Secure

Default: true

$$cap_smtp_secure

The default interface language

Default: en_US

$$cap_default_language
See translate.getoutline.com for a list of available language codes and their rough percentage translated.