Wiki and knowledge base for growing teams

Go to file

decentral1se 3736e7efbb chore: bump version of outline		2022-05-26 11:59:13 +02:00
release	fix: use correct version	2022-01-06 12:45:13 +01:00
.env.sample	add google auth	2022-03-30 14:40:27 +02:00
.gitignore	Initial commit	2021-10-28 18:33:56 +00:00
README.md	Move `migrate` to `abra.sh` command	2022-03-30 20:43:55 +02:00
abra.sh	Also delete search_queries	2022-04-20 00:05:59 +02:00
compose.google.yml	use correct secret	2022-03-30 14:58:14 +02:00
compose.oidc.yml	make oidc_client_secret config optional	2022-03-30 13:55:50 +02:00
compose.yml	chore: bump version of outline	2022-05-26 11:59:13 +02:00
entrypoint.sh.tmpl	add google auth	2022-03-30 14:40:27 +02:00

README.md

Outline

Wiki and knowledge base for growing teams

Category: Apps
Status: 1, alpha
Image: outlinewiki/outline
Healthcheck: No
Backups: No
Email: No
Tests: No
SSO: 3 (OAuth)

Basic usage

Set up Docker Swarm and abra
Deploy coop-cloud/traefik
abra app new ${REPO_NAME} --secrets (optionally with --pass if you'd like to save secrets in pass)
abra app config YOURAPPNAME - be sure to change $DOMAIN to something that resolves to your Docker swarm box
abra app deploy YOURAPPNAME
Open the configured domain in your browser to finish set-up

Tips & Tricks

Post-deploy migration

abra app cmd YOURAPPNAME app migrate

As of 2022-03-30, this requires abra RC version, run abra upgrade --rc.

Setting up your `.env` config

Avoid the use of quotes ("...") as much as possible, the NodeJS scripts flip out for some reason on some vars.

Multiple users logging in & generic oauth

COMPOSE_FILE="compose.yml:compose.patch.yml"

Deleting a user (e.g. to fix SSO weirdness)

abra app cmd YOURAPPNAME postgres delete_user <username-to-delete> <username-to-replace>

Where <username-to-delete> is the username of the user to be removed, and <username-to-replace> is the username of another user, to assign documents and revisions to (instead of deleting them).