iexos
/
outline
forked from coop-cloud/outline
0
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
Wiki and knowledge base for growing teams
78 Commits 3 Branches 8 Tags 193 KiB
Shell 67.2%
Roff 32.8%
Go to file
3wc 361908fe84 chore: publish 0.7.0+0.69.0 release 2023-04-27 15:04:50 -04:00
release add this additional pointer 2022-05-26 13:01:42 +02:00
.drone.yml Switch to self-hosted stack-ssh-deploy image [mass update] 2023-01-21 11:49:56 -08:00
.env.sample Fix COMPOSE_FILE variable names 2023-04-21 17:49:39 -04:00
.gitignore Initial commit 2021-10-28 18:33:56 +00:00
README.md Add basic SSO setup to README, tweak settings order 2023-04-13 15:42:53 -04:00
abra.sh Add some more tables to delete user script 2023-01-20 11:47:10 -08:00
compose.google.yml feat: add ALOWED_DOMAINS setting 2022-06-25 12:28:36 +01:00
compose.oidc.yml remove those unused vars, sort 2022-05-26 12:42:18 +02:00
compose.yml chore: publish 0.7.0+0.69.0 release 2023-04-27 15:04:50 -04:00
entrypoint.sh.tmpl fix: always migrate before start 2022-08-02 20:09:26 +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 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.

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

abra app cmd YOURAPPNAME db 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.

Single Sign On with Keycloak

abra app config YOURAPPNAME, then uncomment everything in the OIDC_ section.

Create a new client in Keycloak:

  • Valid Redirect URIs: https://YOURAPPDOMAIN/auth/oidc.callback

abra app deploy YOURAPPDOMAIN