Wiki and knowledge base for growing teams https://github.com/outline/outline
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
Go to file
3wc 361908fe84
continuous-integration/drone/push Build is passing Details
chore: publish 0.7.0+0.69.0 release
1 month ago
release add this additional pointer 1 year ago
.drone.yml Switch to self-hosted stack-ssh-deploy image [mass update] 4 months ago
.env.sample Fix COMPOSE_FILE variable names 1 month ago
.gitignore Initial commit 2 years ago
README.md Add basic SSO setup to README, tweak settings order 2 months ago
abra.sh Add some more tables to delete user script 4 months ago
compose.google.yml feat: add ALOWED_DOMAINS setting 11 months ago
compose.oidc.yml remove those unused vars, sort 1 year ago
compose.yml chore: publish 0.7.0+0.69.0 release 1 month ago
entrypoint.sh.tmpl fix: always migrate before start 10 months ago

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