arso
/
outline
forked from coop-cloud/outline
0
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
Wiki and knowledge base for growing teams
46 Commits 3 Branches 5 Tags 886 KiB
Shell 58.5%
Roff 41.5%
Go to file
decentral1se 85324a477c
bump vendored config & autoformat 		2022-03-30 14:23:48 +02:00
release fix: use correct version 2022-01-06 12:45:13 +01:00
.env.sample make oidc_client_secret config optional 2022-03-30 13:55:50 +02:00
.gitignore Initial commit 2021-10-28 18:33:56 +00:00
README.md README: add delete_user, update metadata 2022-03-30 13:07:42 +02:00
abra.sh bump vendored config & autoformat 2022-03-30 14:23:48 +02:00
compose.oidc.yml make oidc_client_secret config optional 2022-03-30 13:55:50 +02:00
compose.yml make oidc_client_secret config optional 2022-03-30 13:55:50 +02:00
entrypoint.sh.tmpl make oidc_client_secret config optional 2022-03-30 13:55:50 +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

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

Tips & Tricks

Post-deploy migration

abra app run YOURAPPNAME app sh
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
export DATABASE_URL="postgres://outline:${DATABASE_PASSWORD}@${STACK_NAME}_postgres:5432/outline"
yarn db:migrate --env=production-ssl-disabled

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).

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