coop-cloud/outline
coop-cloud
/
outline
generated from coop-cloud/example
1
0
Fork 3
Code Issues 7 Pull Requests Projects Releases Wiki Activity
Wiki and knowledge base for growing teams https://github.com/outline/outline
113 Commits 5 Branches 22 Tags 249 KiB
Shell 76.1%
Roff 23.9%
Go to file
Moritz ba63176598
continuous-integration/drone/push Build is failing Details
fix backupbot label 		2024-04-17 16:59:39 +02:00
release chore: publish 2.0.1+0.74.0 release 2023-12-19 18:59:29 +01:00
.drone.yml add support for local storage 2023-12-14 12:29:37 +01:00
.env.sample add support for local storage 2023-12-14 12:29:37 +01:00
.gitignore Initial commit 2021-10-28 18:33:56 +00:00
README.md fix typo 2024-03-31 14:58:17 +02:00
abra.sh increment APP_ENTRYPOINT_VERSION 2023-12-19 18:48:48 +01:00
compose.aws.yml add support for local storage 2023-12-14 12:29:37 +01:00
compose.google.yml feat: add ALOWED_DOMAINS setting 2022-06-25 12:28:36 +01:00
compose.local.yml add support for local storage 2023-12-14 12:29:37 +01:00
compose.oidc.yml remove those unused vars, sort 2022-05-26 12:42:18 +02:00
compose.smtp.yml add smtp support 2023-06-20 12:58:15 +02:00
compose.yml fix backupbot label 2024-04-17 16:59:39 +02:00
entrypoint.postgres.sh.tmpl Don't run postgres migrate on a new DB 2023-07-19 11:41:20 +01:00
entrypoint.sh.tmpl fix entrypoint script 2023-12-17 15:51:28 +01:00

README.md

Outline

Wiki and knowledge base for growing teams

  • Category: Apps
  • Status: 3, beta
  • Image: outlinewiki/outline, 4, upstream
  • Healthcheck: No
  • Backups: Yes
  • Email: Yes
  • Tests: 2
  • SSO: 3 (OAuth)

Basic usage

  1. Set up Docker Swarm and abra
  2. Deploy coop-cloud/traefik
  3. abra app new ${REPO_NAME}
    • WARNING: Choose "n" when abra asks if you'd like to generate secrets
  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

Create an initial admin user

abra app cmd YOURAPPNAME app create_email_user test@example.com

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

Migrate from S3 to local storage

  • abra app config <domain>, add
    • COMPOSE_FILE="$COMPOSE_FILE:compose.local.yml"
    • FILE_STORAGE_UPLOAD_MAX_SIZE=26214400
  • abra app deploy <domain> -f
    • compose.aws.yml should still be deployed!
  • abra app undeploy <domain>
  • on the docker host, find mountpoint of newly created volume via docker volume ls and docker volume inspect
    • volume name is smth like <domain>_storage-data
  • take note which linux user owns <storage_mountpoint> (likely 1001)
  • use s3cmd/rclone/... to sync your bucket to <storage_mountpoint>
  • chown -R <storage_user>:<storage_user> <storage_mountpoint>
  • abra app config <domain>, switch storage backend
    • remove AWS_* vars, SECRET_AWS_SECRET_KEY_VERSION and COMPOSE_FILE="$COMPOSE_FILE:compose.aws.yml"
    • set FILE_STORAGE=local
  • abra app deploy <domain> -f
  • enjoy getting rid of S3 🥳

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