add service dependencies and extend deployment timeout

.drone.yml

@@ -18,10 +18,11 @@ steps:
       STACK_NAME: outline
       LETS_ENCRYPT_ENV: production
       APP_ENTRYPOINT_VERSION: v1
+      DB_ENTRYPOINT_VERSION: v1
+      PG_BACKUP_VERSION: v1
       SECRET_DB_PASSWORD_VERSION: v1
       SECRET_SECRET_KEY_VERSION: v1  # length=64
       SECRET_UTILS_SECRET_VERSION: v1  # length=64
-      SECRET_AWS_SECRET_KEY_VERSION: v1
 trigger:
   branch:
     - main
@@ -37,7 +38,7 @@ steps:
         from_secret: drone_abra-bot_token
       fork: true
       repositories:
-        - coop-cloud/auto-recipes-catalogue-json
+        - toolshed/auto-recipes-catalogue-json
 
 trigger:
   event: tag

.env.sample

@@ -8,6 +8,8 @@ DOMAIN=outline.example.com
 #EXTRA_DOMAINS=', `www.outline.example.com`'
 LETS_ENCRYPT_ENV=production
 
+ENABLE_BACKUPS=true
+
 COMPOSE_FILE="compose.yml"
 
 # –––––––––––––––– REQUIRED ––––––––––––––––
@@ -15,15 +17,9 @@ COMPOSE_FILE="compose.yml"
 SECRET_DB_PASSWORD_VERSION=v1
 SECRET_SECRET_KEY_VERSION=v1  # length=64
 SECRET_UTILS_SECRET_VERSION=v1  # length=64
-SECRET_AWS_SECRET_KEY_VERSION=v1
 
-AWS_ACCESS_KEY_ID=
+# Set to s3 to use AWS S3 bucket
-AWS_REGION=
+FILE_STORAGE=local
-AWS_S3_UPLOAD_BUCKET_URL=
-AWS_S3_UPLOAD_BUCKET_NAME=
-AWS_S3_UPLOAD_MAX_SIZE=26214400
-AWS_S3_FORCE_PATH_STYLE=true
-AWS_S3_ACL=private
 
 # –––––––––––––––– OPTIONAL ––––––––––––––––
 
@@ -45,7 +41,7 @@ WEB_CONCURRENCY=1
 
 # Override the maxium size of document imports, could be required if you have
 # especially large Word documents with embedded imagery
-MAXIMUM_IMPORT_SIZE=5120000
+FILE_STORAGE_IMPORT_MAX_SIZE=5120000
 
 # You can remove this line if your reverse proxy already logs incoming http
 # requests and this ends up being duplicative
@@ -85,3 +81,16 @@ ALLOWED_DOMAINS=
 #GOOGLE_ENABLED=1
 #GOOGLE_CLIENT_ID=
 #SECRET_GOOGLE_CLIENT_SECRET_VERSION=v1
+
+COMPOSE_FILE="$COMPOSE_FILE:compose.local.yml"
+FILE_STORAGE_UPLOAD_MAX_SIZE=26214400
+
+#COMPOSE_FILE="$COMPOSE_FILE:compose.aws.yml"
+#AWS_ACCESS_KEY_ID=
+#AWS_REGION=
+#AWS_S3_UPLOAD_BUCKET_URL=
+#AWS_S3_UPLOAD_BUCKET_NAME=
+#AWS_S3_UPLOAD_MAX_SIZE=26214400
+#AWS_S3_FORCE_PATH_STYLE=true
+#AWS_S3_ACL=private
+#SECRET_AWS_SECRET_KEY_VERSION=v1

README.md

@@ -22,13 +22,12 @@ Wiki and knowledge base for growing teams
 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. For Minio, you'll want:
+   your Docker swarm box
-   - `AWS_ACCESS_KEY_ID=<minio username>`
+5. Insert secrets:
-   - `AWS_REGION="us-east-1"`
+    - `abra app secret insert YOURAPPNAME secret_key v1 $(openssl rand -hex 32)` #12
-   - `AWS_S3_UPLOAD_BUCKET_URL=https://minio.example.com`
+    - `abra app secret generate -a YOURAPPNAME`
-   - `AWS_S3_UPLOAD_BUCKET_NAME=
+6. `abra app deploy YOURAPPNAME`
-5. `abra app deploy YOURAPPNAME`
+8. Open the configured domain in your browser to finish set-up
-7. Open the configured domain in your browser to finish set-up
 
 [`abra`]: https://git.coopcloud.tech/coop-cloud/abra
 [`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
@@ -41,14 +40,6 @@ Wiki and knowledge base for growing teams
 abra app cmd YOURAPPNAME app create_email_user test@example.com
 ```
 
-### 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.
@@ -61,7 +52,24 @@ 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`._
+### 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.sh

@@ -1,5 +1,6 @@
-export APP_ENTRYPOINT_VERSION=v8
+export APP_ENTRYPOINT_VERSION=v9
 export DB_ENTRYPOINT_VERSION=v2
+export PG_BACKUP_VERSION=v1
 
 create_email_user() {
 	if [ -z "$1" ]; then
@@ -19,6 +20,10 @@ migrate() {
 	yarn db:migrate --env=production-ssl-disabled
 }
 
+generate_secret() {
+    abra app secret insert $DOMAIN secret_key v1 $(openssl rand -hex 32)
+}
+
 delete_user_by_id() {
 	if [ -z "$1" ] || [ -z "$2" ]; then
 		echo "Usage: ... delete_user_by_id <userid-to-delete> <userid-to-replace>"

alaconnect.yml

@@ -0,0 +1,15 @@
+authentik:
+    env: 
+        OIDC_CLIENT_ID: outline
+        OIDC_AUTH_URI: https://authentik.example.com/application/o/authorize/
+        OIDC_TOKEN_URI: https://authentik.example.com/application/o/token/
+        OIDC_USERINFO_URI: https://authentik.example.com/application/o/userinfo/
+        OIDC_DISPLAY_NAME: "Authentik"
+    uncomment:
+        - compose.oidc.yml
+        - OIDC_ENABLED
+        - OIDC_USERNAME_CLAIM
+        - OIDC_SCOPES
+        - SECRET_OIDC_CLIENT_SECRET_VERSION
+    shared_secrets:
+        outline_secret: oidc_client_secret

compose.aws.yml

@@ -0,0 +1,22 @@
+---
+version: "3.8"
+
+services:
+  app:
+    secrets:
+      - aws_secret_key
+    environment:
+      - AWS_ACCESS_KEY_ID
+      - AWS_REGION
+      - AWS_S3_ACL
+      - AWS_S3_FORCE_PATH_STYLE
+      - AWS_S3_UPLOAD_BUCKET_NAME
+      - AWS_S3_UPLOAD_BUCKET_URL
+      - AWS_S3_UPLOAD_MAX_SIZE
+      - AWS_SDK_LOAD_CONFIG=0
+      - AWS_SECRET_KEY_FILE=/run/secrets/aws_secret_key
+
+secrets:
+  aws_secret_key:
+    name: ${STACK_NAME}_aws_secret_key_${SECRET_AWS_SECRET_KEY_VERSION}
+    external: true

compose.local.yml

@@ -0,0 +1,13 @@
+---
+version: "3.8"
+
+services:
+  app:
+    volumes:
+      - storage-data:/var/lib/outline/data
+    environment:
+      - FILE_STORAGE
+      - FILE_STORAGE_UPLOAD_MAX_SIZE
+
+volumes:
+  storage-data:

compose.yml

@@ -6,9 +6,8 @@ services:
     networks:
       - backend
       - proxy
-    image: outlinewiki/outline:0.70.2
+    image: outlinewiki/outline:0.82.0
     secrets:
-      - aws_secret_key
       - db_password
       - secret_key
       - utils_secret
@@ -17,15 +16,7 @@ services:
         target: /docker-entrypoint.sh
         mode: 0555
     environment:
-      - AWS_ACCESS_KEY_ID
+      - FILE_STORAGE
-      - AWS_REGION
-      - AWS_S3_ACL
-      - AWS_S3_FORCE_PATH_STYLE
-      - AWS_S3_UPLOAD_BUCKET_NAME
-      - AWS_S3_UPLOAD_BUCKET_URL
-      - AWS_S3_UPLOAD_MAX_SIZE
-      - AWS_SDK_LOAD_CONFIG=0
-      - AWS_SECRET_KEY_FILE=/run/secrets/aws_secret_key
       - DATABASE_PASSWORD_FILE=/run/secrets/db_password
       - FORCE_HTTPS=true
       - PGSSLMODE=disable
@@ -43,19 +34,23 @@ services:
         - "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`${EXTRA_DOMAINS})"
         - "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
         - "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
-        - "coop-cloud.${STACK_NAME}.version=0.12.0+0.70.2"
+        - "coop-cloud.${STACK_NAME}.version=2.9.0+0.82.0"
-        ## Redirect from EXTRA_DOMAINS to DOMAIN
+        # Redirect from EXTRA_DOMAINS to DOMAIN
-        #- "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
+        - "traefik.http.routers.${STACK_NAME}.middlewares=${STACK_NAME}-redirect"
-        #- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
+        - "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLForceHost=true"
-        #- "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
+        - "traefik.http.middlewares.${STACK_NAME}-redirect.headers.SSLHost=${DOMAIN}"
+        - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-80}"
+    depends_on:
+      - cache
+      - db
 
   cache:
-    image: redis:7.0.12
+    image: redis:7.4.2
     networks:
       - backend
 
   db:
-    image: postgres:15.3
+    image: postgres:17.3
     networks:
       - backend
     secrets:
@@ -64,6 +59,9 @@ services:
       - source: db_entrypoint
         target: /docker-entrypoint.sh
         mode: 0555
+      - source: pg_backup
+        target: /pg_backup.sh
+        mode: 0555
     environment:
       POSTGRES_DB: outline
       POSTGRES_PASSWORD_FILE: /run/secrets/db_password
@@ -73,10 +71,10 @@ services:
     entrypoint: /docker-entrypoint.sh
     deploy:
       labels:
-        backupbot.backup: "true"
+        backupbot.backup: "${ENABLE_BACKUPS:-true}"
-        backupbot.backup.path: "/tmp/dump.sql.gz"
+        backupbot.backup.pre-hook: "/pg_backup.sh backup"
-        backupbot.backup.post-hook: "rm -f /tmp/dump.sql.gz"
+        backupbot.backup.volumes.postgres_data.path: "backup.sql"
-        backupbot.backup.pre-hook: "sh -c 'PGPASSWORD=$$(cat $${POSTGRES_PASSWORD_FILE}) pg_dump -U outline outline | gzip > /tmp/dump.sql.gz'"
+        backupbot.restore.post-hook: '/pg_backup.sh restore'
 
 secrets:
   secret_key:
@@ -85,9 +83,6 @@ secrets:
   utils_secret:
     name: ${STACK_NAME}_utils_secret_${SECRET_UTILS_SECRET_VERSION}
     external: true
-  aws_secret_key:
-    name: ${STACK_NAME}_aws_secret_key_${SECRET_AWS_SECRET_KEY_VERSION}
-    external: true
   db_password:
     name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
     external: true
@@ -109,3 +104,6 @@ configs:
     name: ${STACK_NAME}_db_entrypoint_${DB_ENTRYPOINT_VERSION}
     file: entrypoint.postgres.sh.tmpl
     template_driver: golang
+  pg_backup:
+    name: ${STACK_NAME}_pg_backup_${PG_BACKUP_VERSION}
+    file: pg_backup.sh

entrypoint.sh.tmpl

@@ -1,6 +1,8 @@
 #!/bin/sh
 
+{{ if eq (env "FILE_STORAGE")  "s3" }}
 export AWS_SECRET_ACCESS_KEY=$(cat /run/secrets/aws_secret_key)
+{{ end }}
 
 {{ if eq (env "SMTP_ENABLED") "1" }}
 export SMTP_PASSWORD=$(cat /run/secrets/smtp_password)

pg_backup.sh

@@ -0,0 +1,34 @@
+#!/bin/bash
+
+set -e
+
+BACKUP_FILE='/var/lib/postgresql/data/backup.sql'
+
+function backup {
+  export PGPASSWORD=$(cat $POSTGRES_PASSWORD_FILE)
+  pg_dump -U ${POSTGRES_USER} ${POSTGRES_DB} > $BACKUP_FILE
+}
+
+function restore {
+    cd /var/lib/postgresql/data/
+    restore_config(){
+        # Restore allowed connections
+        cat pg_hba.conf.bak > pg_hba.conf
+        su postgres -c 'pg_ctl reload'
+    }
+    # Don't allow any other connections than local
+    cp pg_hba.conf pg_hba.conf.bak
+    echo "local all all trust" > pg_hba.conf
+    su postgres -c 'pg_ctl reload'
+    trap restore_config EXIT INT TERM
+
+    # Recreate Database
+    psql -U ${POSTGRES_USER} -d postgres -c "DROP DATABASE ${POSTGRES_DB} WITH (FORCE);" 
+    createdb -U ${POSTGRES_USER} ${POSTGRES_DB}
+    psql -U ${POSTGRES_USER} -d ${POSTGRES_DB} -1 -f $BACKUP_FILE
+
+    trap - EXIT INT TERM
+    restore_config
+}
+
+$@

release/2.0.0+0.74.0

@@ -0,0 +1,4 @@
+Due to the introduction of local storage, you need to adapt your config to continue using S3 storage. Just add the following lines to your config:
+
+FILE_STORAGE=s3
+COMPOSE_FILE="$COMPOSE_FILE:compose.aws.yml"