outline/README.md

1.3 KiB

Outline

Wiki and knowledge base for growing teams

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"