📙 Outline

· Report Bug · Request Feature ·

About The Project

Setup for outline the wiki software we use to document internal workings and other collaborative work. Uses discord OpenID Connect for authentication for ease of use.

Setup

Production

Follow Creating a release.

Development

1. Follow local setup.
2. Follow the Customization section and set all variables with Required in dev true.
3. Navigate to http://localhost:3400

Customization

Create a environment file touch .env. Override variables in the {variable name}={variable value} format. All required variables need to be overridden for the respected environment.

Variable	Description	Required in dev	Required in prod	Default value
SECRET_KEY	Run openssl rand -hex 32 to get one.	true	true	none
UTILS_SECRET	Run openssl rand -hex 32 to get one.	true	true	none
POSTGRES_PASSWORD	Postgres password. Choose a secure one.	true	true	none
DISCORD_APP_ID	Follow Discord OpenId Connect for a rough tutorial. Id can be retrieved from Discord Apps > Click your application > OAuth2 > APPLICATION ID.	true	true	none
DISCORD_APP_SECRET	Follow Discord OpenId Connect for a rough tutorial. Id can be retrieved from Discord Apps > Click your application > OAuth2 > CLIENT SECRET.	true	true	none
OUTLINE_HOST	URL to be used by the reverse proxy. E.g. wiki.domain.de.	false	true	none
SMTP_HOST	SMTP host.	true	true	none
SMTP_PORT	SMTP host.	true	true	none
SMTP_USERNAME	SMTP username.	true	true	none
SMTP_PASSWORD	SMTP password.	true	true	none
SMTP_FROM_EMAIL	SMTP from email.	true	true	none
SMTP_REPLY_EMAIL	SMTP reply email.	false	false	``
SMTP_TLS_CIPHERS	SMTP tls cipher.	false	false	``
SMTP_SECURE	SMTP secure connection.	false	false	1

Setup a discord application for OpenId Connect

Follow Discord OpenId Connect for a rough tutorial.

1. Navigate to Discord Apps
2. Create a application
3. Navigate to Your application > OAuth2
4. Click to regenerate a CLIENT SECRET
5. Make note of APPLICATION ID and CLIENT SECRET and set it like described in Customization
6. Add a redirect url with this value: (http|https)://{url}/auth/oidc.callback. Make sure to replace url and the protocol according to your environment

Contributing

Follow contributing.