Compare commits

...

75 Commits

Author SHA1 Message Date
6c4fb2c70b chore: publish 2.9.1+0.82.0 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2025-06-07 15:07:39 -04:00
ca0eebcc64 Merge pull request 'add service dependencies and extend deployment timeout' (#21) from deploy-timeout into main
All checks were successful
continuous-integration/drone/push Build is passing
Reviewed-on: #21
2025-06-07 19:05:11 +00:00
400445f8f5 Merge branch 'main' into deploy-timeout 2025-06-07 19:04:42 +00:00
73ed83f5bf remove depends_on clause because it's ignored by docker swarm 2025-06-07 19:03:44 +00:00
91e73387bf expand SSO documentation
All checks were successful
continuous-integration/drone/push Build is passing
2025-06-07 13:51:39 -04:00
4005524b7b add service dependencies and extend deployment timeout 2025-06-07 13:41:19 -04:00
3wc
ab70b3c4ca chore: publish 2.9.0+0.82.0 release
Some checks are pending
continuous-integration/drone/push Build is pending
continuous-integration/drone/tag Build is pending
2025-02-19 12:22:40 -05:00
59fdc6481a chore: publish 2.8.2+0.81.1 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2025-02-05 17:26:30 +01:00
fbcdc57b9d Update .drone.yml
All checks were successful
continuous-integration/drone/push Build is passing
2025-01-08 10:09:13 -08:00
3wc
37c8cf8141 chore: publish 2.8.1+0.81.1 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2024-12-15 12:55:30 -05:00
cd3d754eb5 chore: publish 2.8.0+0.81.1 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2024-11-21 13:28:21 +01:00
fbe1a99054 chore: publish 2.7.2+0.80.2 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2024-10-29 16:48:51 +01:00
529e0d9d26 EXTRA_DOMAINS redirect 2024-10-29 16:48:31 +01:00
5f300f945b chore: publish 2.7.1+0.80.2 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2024-10-29 16:05:10 +01:00
3a06d0d9a0 update backupbot label
All checks were successful
continuous-integration/drone/push Build is passing
2024-10-24 14:50:21 +02:00
3wc
10c074a96b Add DB_ENTRYPOINT_VERSION for CI test
All checks were successful
continuous-integration/drone/push Build is passing
2024-10-02 14:17:28 -04:00
3wc
33c53a5d94 chore: publish 2.7.0+0.80.2 release
Some checks failed
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is failing
2024-10-02 14:14:35 -04:00
a2713a9a64 chore: publish 2.6.1+0.79.1 release
Some checks failed
continuous-integration/drone/push Build is failing
2024-09-23 17:11:01 +02:00
f6536067ee add secret generation script 2024-09-23 17:05:52 +02:00
93b670b8f4 chore: publish 2.6.0+0.79.1 release
Some checks failed
continuous-integration/drone/push Build is failing
2024-09-17 16:14:12 +02:00
1212c295b9 chore: publish 2.5.0+0.78.0 release
Some checks failed
continuous-integration/drone/push Build is failing
2024-08-07 16:37:10 +02:00
6a1fb0e4f3 chore: publish 2.4.2+0.77.3 release
Some checks failed
continuous-integration/drone/push Build is failing
2024-07-15 17:24:35 +02:00
9ee27ac443 add backupbot label for local data
Some checks failed
continuous-integration/drone/push Build is failing
2024-07-05 17:47:40 +02:00
287654b8d3 chore: publish 2.4.1+0.77.2 release
Some checks failed
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is failing
2024-06-18 11:15:07 +02:00
79c10ed214 chore: publish 2.4.0+0.77.1 release
Some checks failed
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is failing
2024-06-17 15:52:37 +02:00
3wc
8ddceb9017 chore: publish 2.3.0+0.76.1 release
Some checks failed
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is failing
2024-05-23 15:54:31 -03:00
c1d6826d82 add alakazam integration file alaconnect.yml
Some checks failed
continuous-integration/drone/push Build is failing
2024-05-13 17:33:49 +02:00
ac7fb7c3dd document how to generate the secrets
Some checks failed
continuous-integration/drone/push Build is failing
2024-05-01 12:42:29 +02:00
ba63176598 fix backupbot label
Some checks failed
continuous-integration/drone/push Build is failing
2024-04-17 16:59:39 +02:00
6eee864ba1 fix typo
Some checks failed
continuous-integration/drone/push Build is failing
2024-03-31 14:58:17 +02:00
f3c8e08441 cleanup docs
Some checks failed
continuous-integration/drone/push Build is failing
2024-03-31 14:52:41 +02:00
6da688ad1b add s3 -> local storage migration guide 2024-03-31 14:47:00 +02:00
3wc
ea012f2628 chore: publish 2.2.0+0.75.2 release
Some checks failed
continuous-integration/drone/push Build is failing
2024-03-19 20:19:25 -03:00
1705383533 chore: publish 2.1.0+0.75.0 release
Some checks failed
continuous-integration/drone/push Build is failing
2024-02-19 11:16:08 +01:00
6575668586 chore: publish 2.0.1+0.74.0 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-12-19 18:59:29 +01:00
39f3a61ce0 chore: publish 2.0.0+0.74.0 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-12-19 18:55:32 +01:00
158a3c8b1c increment APP_ENTRYPOINT_VERSION
Some checks failed
continuous-integration/drone/push Build is failing
2023-12-19 18:48:48 +01:00
03b7d984f0 Merge branch 'simon-add-local-storage-support' 2023-12-19 18:48:34 +01:00
907597aab3 fix entrypoint script 2023-12-17 15:51:28 +01:00
d9ce8fb168 fix bash script 2023-12-14 14:15:41 +01:00
73de12d12f add support for local storage 2023-12-14 12:29:37 +01:00
8c3521b87f chore: publish 1.1.0+0.73.1 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-11-22 20:32:28 +01:00
4273faad76 chore: publish 1.0.1+0.72.2 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-10-12 17:24:19 +02:00
0e84bbc2ee chore: publish 1.0.0+0.72.1 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-10-07 12:32:22 +02:00
ca60a0f1a3 chore: publish 0.13.0+0.71.0 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-09-05 15:25:00 +02:00
3wc
3b1eeb6160 chore: publish 0.12.0+0.70.2 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-08-11 12:31:16 +02:00
3wc
52f3bf31ed Update recipe metadata
[ci skip]
2023-08-05 14:21:05 +02:00
3wc
e229ab6e30 chore: publish 0.11.0+0.70.2 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-07-31 14:23:14 +01:00
0ab6c0c244 chore: publish 0.11.0+0.69.2 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-07-24 13:48:01 +01:00
3wc
5e2a13a93a Add a mode to entrypoint to allow just loading env
Some checks failed
continuous-integration/drone/push Build is failing
2023-07-21 10:20:31 +01:00
3wc
8796269ad2 Some readme tweaks
[ci skip]
2023-07-21 10:09:45 +01:00
3wc
a4f75f2da0 Add create_email_user script
Some checks failed
continuous-integration/drone/push Build is failing
2023-07-19 13:40:41 +01:00
3wc
76523535ca Bump entrypoint version
Some checks failed
continuous-integration/drone/push Build is failing
2023-07-19 11:42:40 +01:00
3wc
68f23084aa Don't run postgres migrate on a new DB
Some checks failed
continuous-integration/drone/push Build is failing
2023-07-19 11:41:20 +01:00
3wc
e487a36bb5 chore: publish 0.10.0+0.69.2 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-06-23 12:43:35 +01:00
8426058959 Merge pull request 'Add SMTP support' (#16) from iexos/outline:smtp-new into main
Some checks failed
continuous-integration/drone/push Build is failing
Reviewed-on: #16
2023-06-23 11:17:38 +00:00
277a5d2343 add smtp support 2023-06-20 12:58:15 +02:00
56be9efd22 chore: publish 0.9.0+0.69.2 release
Some checks failed
continuous-integration/drone/push Build is failing
2023-06-19 13:36:59 +02:00
7d2f35277b Merge pull request 'Update to postgres 15 and run pg_upgrade automatically' (#15) from iexos/outline:pg15 into main
Some checks failed
continuous-integration/drone/push Build is failing
Reviewed-on: #15
2023-06-19 11:32:38 +00:00
53913b92cd pg_upgrade: catch intentionally failing cmd 2023-06-18 23:03:53 +02:00
e0cc0ff9af make pg upgrade more safe 2023-06-15 18:51:28 +02:00
5e3e8a655b use postgres 15 and add entrypoint.sh for pg_upgrade 2023-06-15 16:04:05 +02:00
53e4d82aa3 chore: publish 0.8.0+0.69.2 release
All checks were successful
continuous-integration/drone/push Build is passing
2023-06-14 18:28:56 +02:00
3wc
361908fe84 chore: publish 0.7.0+0.69.0 release
All checks were successful
continuous-integration/drone/push Build is passing
2023-04-27 15:04:50 -04:00
3wc
ecb5314fe7 chore: publish 0.6.0+0.67.2 release
All checks were successful
continuous-integration/drone/push Build is passing
2023-04-21 17:50:37 -04:00
3wc
a016995516 Fix COMPOSE_FILE variable names 2023-04-21 17:49:39 -04:00
3wc
2daf487bb8 Add basic SSO setup to README, tweak settings order
All checks were successful
continuous-integration/drone/push Build is passing
2023-04-13 15:42:53 -04:00
3wc
0354892c74 Switch to self-hosted stack-ssh-deploy image [mass update]
All checks were successful
continuous-integration/drone/push Build is passing
2023-01-21 11:49:56 -08:00
3wc
86c215cbc9 Add drone configs / secrets [mass update]
All checks were successful
continuous-integration/drone/push Build is passing
2023-01-20 21:32:06 -08:00
3wc
8e7a7b9932 Add some more tables to delete user script
Some checks failed
continuous-integration/drone/push Build is failing
2023-01-20 11:47:10 -08:00
3wc
d1f7c765dd Add CI and catalogue generation [mass update] 2023-01-20 10:45:03 -08:00
3wc
4f923ad0c1 Define database backups 2023-01-19 13:18:11 -08:00
672557c7fb chore: publish 0.5.0+0.67.2 release 2023-01-17 09:59:57 +01:00
3wc
00576231e5 Add delete_user_by_id, delete_duplicate_users 2022-12-09 11:18:18 -08:00
beeffe65f6 chore: publish 0.5.0+0.66.3 release 2022-11-30 17:25:58 +01:00
14 changed files with 376 additions and 71 deletions

44
.drone.yml Normal file
View File

@ -0,0 +1,44 @@
---
kind: pipeline
name: deploy to swarm-test.autonomic.zone
steps:
- name: deployment
image: git.coopcloud.tech/coop-cloud/stack-ssh-deploy:latest
settings:
host: swarm-test.autonomic.zone
stack: outline
generate_secrets: true
purge: true
deploy_key:
from_secret: drone_ssh_swarm_test
networks:
- proxy
environment:
DOMAIN: outline.swarm-test.autonomic.zone
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
trigger:
branch:
- main
---
kind: pipeline
name: generate recipe catalogue
steps:
- name: release a new version
image: plugins/downstream
settings:
server: https://build.coopcloud.tech
token:
from_secret: drone_abra-bot_token
fork: true
repositories:
- toolshed/auto-recipes-catalogue-json
trigger:
event: tag

View File

@ -8,24 +8,18 @@ DOMAIN=outline.example.com
#EXTRA_DOMAINS=', `www.outline.example.com`'
LETS_ENCRYPT_ENV=production
ENABLE_BACKUPS=true
COMPOSE_FILE="compose.yml"
#COMPOSE_YML="compose.yml:compose.oidc.yml"
#COMPOSE_YML="compose.yml:compose.google.yml"
# REQUIRED
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=
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
# Set to s3 to use AWS S3 bucket
FILE_STORAGE=local
# OPTIONAL
@ -47,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
@ -57,19 +51,22 @@ DEBUG=http
# set, all domains are allowed by default when using Google OAuth to signin
ALLOWED_DOMAINS=
# TODO: setup compose.smtp.yml
# To support sending outgoing transactional emails such as "document updated" or
# "you've been invited" you'll need to provide authentication for an SMTP server
# By default, this enables email login. You can disable this in the settings
# for configuration details see https://docs.getoutline.com/s/hosting/doc/smtp-cqCJyZGMIB
#COMPOSE_FILE="$COMPOSE_FILE:compose.smtp.yml"
#SMTP_ENABLED=1
#SMTP_HOST=
#SMTP_PORT=
#SMTP_USERNAME=
#SMTP_PASSWORD=
#SMTP_FROM_EMAIL=
#SMTP_REPLY_EMAIL=
#SMTP_TLS_CIPHERS=
#SMTP_SECURE=true
#SECRET_SMTP_PASSWORD_VERSION=v1
#COMPOSE_FILE="$COMPOSE_FILE:compose.oidc.yml"
#OIDC_ENABLED=1
#OIDC_CLIENT_ID=
#OIDC_AUTH_URI=
@ -80,6 +77,20 @@ ALLOWED_DOMAINS=
#OIDC_SCOPES="openid profile email"
#SECRET_OIDC_CLIENT_SECRET_VERSION=v1
#COMPOSE_FILE="$COMPOSE_FILE:compose.google.yml"
#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

View File

@ -5,12 +5,12 @@ Wiki and knowledge base for growing teams
<!-- metadata -->
* **Category**: Apps
* **Status**: 1, alpha
* **Image**: [outlinewiki/outline](https://hub.docker.com/r/outlinewiki/outline)
* **Status**: 3, beta
* **Image**: [outlinewiki/outline](https://hub.docker.com/r/outlinewiki/outline), 4, upstream
* **Healthcheck**: No
* **Backups**: No
* **Email**: No
* **Tests**: No
* **Backups**: Yes
* **Email**: Yes
* **Tests**: 2
* **SSO**: 3 (OAuth)
<!-- endmetadata -->
@ -19,26 +19,27 @@ Wiki and knowledge base for growing teams
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`)
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`
7. Open the configured domain in your browser to finish set-up
5. Insert secrets:
- `abra app secret insert YOURAPPNAME secret_key v1 $(openssl rand -hex 32)` #12
- `abra app secret generate -a YOURAPPNAME`
6. `abra app deploy YOURAPPNAME`
8. 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
## Tips & Tricks
### Post-deploy migration
### Create an initial admin user
```
abra app cmd YOURAPPNAME app migrate
abra app cmd YOURAPPNAME app create_email_user test@example.com
```
_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.
@ -51,4 +52,30 @@ 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/Authentik
- Create an OIDC client in Keycloak (in Authentik this is called a provider and application)
- Run `abra app config YOURAPPNAME`, then uncomment everything in the `OIDC_` section.
- **Valid Redirect URIs**: `https://YOURAPPDOMAIN/auth/oidc.callback`
- Reference the client/provider info to populate the `_AUTH_URI` `_TOKEN_URI` and `_USERINFO_URI` values
- Set the OIDC secret using the value from the client/provider `abra app secret insert YOURAPPNAME oidc_client_secret v1 SECRETVALUE`
- `abra app deploy YOURAPPDOMAIN`

94
abra.sh
View File

@ -1,4 +1,18 @@
export APP_ENTRYPOINT_VERSION=v6
export APP_ENTRYPOINT_VERSION=v9
export DB_ENTRYPOINT_VERSION=v2
export PG_BACKUP_VERSION=v1
create_email_user() {
if [ -z "$1" ]; then
echo "Usage: ... create_email_user <email_address>"
exit 1
fi
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
export DATABASE_URL="postgres://outline:${DATABASE_PASSWORD}@${STACK_NAME}_db:5432/outline"
export UTILS_SECRET=$(cat /run/secrets/utils_secret)
export SECRET_KEY=$(cat /run/secrets/secret_key)
node build/server/scripts/seed.js "$1"
}
migrate() {
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
@ -6,9 +20,46 @@ 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>"
exit 1
fi
USERID_REPLACE="$2"
USERID_REMOVE="$1"
psql -U outline outline <<- SQL
UPDATE documents SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
UPDATE groups SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE pins SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE group_users SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE collections SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE collection_users SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE collection_groups SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE documents SET "lastModifiedById" = '$USERID_REPLACE' WHERE "lastModifiedById" = '$USERID_REMOVE';
UPDATE documents SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE revisions SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
UPDATE attachments SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
UPDATE backlinks SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
UPDATE file_operations SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
UPDATE users SET "suspendedById" = '$USERID_REPLACE' WHERE "suspendedById" = '$USERID_REMOVE';
DELETE FROM search_queries WHERE "userId" = '$USERID_REMOVE';
DELETE FROM shares WHERE "userId" = '$USERID_REMOVE';
DELETE FROM notification_settings WHERE "userId" = '$USERID_REMOVE';
DELETE FROM events WHERE "actorId" = '$USERID_REMOVE';
DELETE FROM events WHERE "userId" = '$USERID_REMOVE';
DELETE FROM users WHERE "id" = '$USERID_REMOVE';
SQL
}
delete_user() {
if [ -z "$1" ] || [ -z "$2" ]; then
echo "Usage: ... delete_user <user-to-delete> <user-to-replace>"
echo "Usage: ... delete_user <userid-to-delete> <userid-to-replace>"
exit 1
fi
@ -25,22 +76,25 @@ delete_user() {
exit 1
fi
psql -U outline outline <<- SQL
UPDATE documents SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
UPDATE groups SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE pins SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE group_users SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE collections SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE collection_users SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE documents SET "lastModifiedById" = '$USERID_REPLACE' WHERE "lastModifiedById" = '$USERID_REMOVE';
UPDATE documents SET "createdById" = '$USERID_REPLACE' WHERE "createdById" = '$USERID_REMOVE';
UPDATE revisions SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
UPDATE attachments SET "userId" = '$USERID_REPLACE' WHERE "userId" = '$USERID_REMOVE';
DELETE FROM search_queries WHERE "userId" = '$USERID_REMOVE';
DELETE FROM shares WHERE "userId" = '$USERID_REMOVE';
DELETE FROM notification_settings WHERE "userId" = '$USERID_REMOVE';
DELETE FROM events WHERE "actorId" = '$USERID_REMOVE';
DELETE FROM events WHERE "userId" = '$USERID_REMOVE';
DELETE FROM users WHERE username = '$1';
SQL
delete_user_by_id "$USERID_REMOVE" "$USERID_REPLACE"
}
delete_duplicate_users() {
if [ -z "$1" ]; then
echo "Usage: ... delete_duplicate_users <username>"
exit 1
fi
USERIDS=$(echo "SELECT id FROM users WHERE username = '$1' ORDER BY users.\"createdAt\" DESC" | psql -t -A -U outline outline)
if [ ! "$(echo "$USERIDS" | wc -l)" -gt 1 ]; then
echo "Only one user exists, bailing"
exit 1
fi
USERID_NEW=$(echo "$USERIDS" | head -n1)
for USERID_OLD in $(echo "$USERIDS" | tail -n+2); do
delete_user_by_id "$USERID_OLD" "$USERID_NEW"
done
}

15
alaconnect.yml Normal file
View File

@ -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

22
compose.aws.yml Normal file
View File

@ -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

13
compose.local.yml Normal file
View File

@ -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:

18
compose.smtp.yml Normal file
View File

@ -0,0 +1,18 @@
version: "3.8"
services:
app:
secrets:
- smtp_password
environment:
- SMTP_HOST
- SMTP_PORT
- SMTP_USERNAME
- SMTP_FROM_EMAIL
- SMTP_REPLY_EMAIL
- SMTP_TLS_CIPHERS
- SMTP_SECURE
secrets:
smtp_password:
external: true
name: ${STACK_NAME}_smtp_password_${SECRET_SMTP_PASSWORD_VERSION}

View File

@ -6,9 +6,8 @@ services:
networks:
- backend
- proxy
image: outlinewiki/outline:0.64.4
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
- 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
- FILE_STORAGE
- DATABASE_PASSWORD_FILE=/run/secrets/db_password
- FORCE_HTTPS=true
- PGSSLMODE=disable
@ -43,29 +34,44 @@ 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.4.1+0.64.4"
## Redirect from EXTRA_DOMAINS to DOMAIN
#- "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.SSLHost=${DOMAIN}"
- "coop-cloud.${STACK_NAME}.version=2.9.0+0.82.0"
# Redirect from EXTRA_DOMAINS to DOMAIN
- "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.SSLHost=${DOMAIN}"
- "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-80}"
cache:
image: redis:6.2.6
image: redis:7.4.2
networks:
- backend
db:
image: postgres:11
image: postgres:17.3
networks:
- backend
secrets:
- db_password
configs:
- 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
POSTGRES_USER: outline
volumes:
- "postgres_data:/var/lib/postgresql/data"
entrypoint: /docker-entrypoint.sh
deploy:
labels:
backupbot.backup: "${ENABLE_BACKUPS:-true}"
backupbot.backup.pre-hook: "/pg_backup.sh backup"
backupbot.backup.volumes.postgres_data.path: "backup.sql"
backupbot.restore.post-hook: '/pg_backup.sh restore'
secrets:
secret_key:
@ -74,9 +80,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
@ -94,3 +97,10 @@ configs:
name: ${STACK_NAME}_app_entrypoint_${APP_ENTRYPOINT_VERSION}
file: entrypoint.sh.tmpl
template_driver: golang
db_entrypoint:
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

View File

@ -0,0 +1,44 @@
#!/bin/bash
set -e
MIGRATION_MARKER=$PGDATA/migration_in_progress
OLDDATA=$PGDATA/old_data
NEWDATA=$PGDATA/new_data
if [ -e $MIGRATION_MARKER ]; then
echo "FATAL: migration was started but did not complete in a previous run. manual recovery necessary"
exit 1
fi
if [ -f $PGDATA/PG_VERSION ]; then
DATA_VERSION=$(cat $PGDATA/PG_VERSION)
if [ -n "$DATA_VERSION" -a "$PG_MAJOR" != "$DATA_VERSION" ]; then
echo "postgres data version $DATA_VERSION found, but need $PG_MAJOR. Starting migration"
echo "Installing postgres $DATA_VERSION"
sed -i "s/$/ $DATA_VERSION/" /etc/apt/sources.list.d/pgdg.list
apt-get update && apt-get install -y --no-install-recommends \
postgresql-$DATA_VERSION \
&& rm -rf /var/lib/apt/lists/*
echo "shuffling around"
gosu postgres mkdir $OLDDATA $NEWDATA
chmod 700 $OLDDATA $NEWDATA
mv $PGDATA/* $OLDDATA/ || true
touch $MIGRATION_MARKER
echo "running initdb"
# abuse entrypoint script for initdb by making server error out
gosu postgres bash -c "export PGDATA=$NEWDATA ; /usr/local/bin/docker-entrypoint.sh --invalid-arg || true"
echo "running pg_upgrade"
cd /tmp
gosu postgres pg_upgrade --link -b /usr/lib/postgresql/$DATA_VERSION/bin -d $OLDDATA -D $NEWDATA -U $POSTGRES_USER
cp $OLDDATA/pg_hba.conf $NEWDATA/
mv $NEWDATA/* $PGDATA
rm -rf $OLDDATA
rmdir $NEWDATA
rm $MIGRATION_MARKER
echo "migration complete"
fi
fi
/usr/local/bin/docker-entrypoint.sh postgres

View File

@ -1,6 +1,12 @@
#!/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)
{{ end }}
{{ if eq (env "OIDC_ENABLED") "1" }}
export OIDC_CLIENT_SECRET=$(cat /run/secrets/oidc_client_secret)
@ -15,5 +21,7 @@ export SECRET_KEY=$(cat /run/secrets/secret_key)
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
export DATABASE_URL="postgres://outline:${DATABASE_PASSWORD}@${STACK_NAME}_db:5432/outline"
/usr/local/bin/yarn db:migrate --env=production-ssl-disabled
/usr/local/bin/yarn start "$@"
if [ ! "$1" = "-e" ]; then
/usr/local/bin/yarn db:migrate --env=production-ssl-disabled
/usr/local/bin/yarn start "$@"
fi

34
pg_backup.sh Normal file
View File

@ -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
}
$@

4
release/2.0.0+0.74.0 Normal file
View File

@ -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"

1
release/2.9.1+0.82.0 Normal file
View File

@ -0,0 +1 @@
Fixes a problem where deployments were consistently giving a timeout response even though they were successful