forked from coop-cloud/outline
Compare commits
19 Commits
Author | SHA1 | Date | |
---|---|---|---|
8c3521b87f | |||
4273faad76 | |||
0e84bbc2ee | |||
ca60a0f1a3 | |||
3b1eeb6160 | |||
52f3bf31ed | |||
e229ab6e30 | |||
0ab6c0c244 | |||
5e2a13a93a | |||
8796269ad2 | |||
a4f75f2da0 | |||
76523535ca | |||
68f23084aa | |||
e487a36bb5 | |||
8426058959 | |||
277a5d2343 | |||
56be9efd22 | |||
7d2f35277b | |||
53913b92cd |
@ -55,18 +55,20 @@ DEBUG=http
|
|||||||
# set, all domains are allowed by default when using Google OAuth to signin
|
# set, all domains are allowed by default when using Google OAuth to signin
|
||||||
ALLOWED_DOMAINS=
|
ALLOWED_DOMAINS=
|
||||||
|
|
||||||
# TODO: setup compose.smtp.yml
|
|
||||||
# To support sending outgoing transactional emails such as "document updated" or
|
# 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
|
# "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_ENABLED=1
|
||||||
#SMTP_HOST=
|
#SMTP_HOST=
|
||||||
#SMTP_PORT=
|
#SMTP_PORT=
|
||||||
#SMTP_USERNAME=
|
#SMTP_USERNAME=
|
||||||
#SMTP_PASSWORD=
|
|
||||||
#SMTP_FROM_EMAIL=
|
#SMTP_FROM_EMAIL=
|
||||||
#SMTP_REPLY_EMAIL=
|
#SMTP_REPLY_EMAIL=
|
||||||
#SMTP_TLS_CIPHERS=
|
#SMTP_TLS_CIPHERS=
|
||||||
#SMTP_SECURE=true
|
#SMTP_SECURE=true
|
||||||
|
#SECRET_SMTP_PASSWORD_VERSION=v1
|
||||||
|
|
||||||
#COMPOSE_FILE="$COMPOSE_FILE:compose.oidc.yml"
|
#COMPOSE_FILE="$COMPOSE_FILE:compose.oidc.yml"
|
||||||
#OIDC_ENABLED=1
|
#OIDC_ENABLED=1
|
||||||
|
26
README.md
26
README.md
@ -5,12 +5,12 @@ Wiki and knowledge base for growing teams
|
|||||||
<!-- metadata -->
|
<!-- metadata -->
|
||||||
|
|
||||||
* **Category**: Apps
|
* **Category**: Apps
|
||||||
* **Status**: 1, alpha
|
* **Status**: 3, beta
|
||||||
* **Image**: [outlinewiki/outline](https://hub.docker.com/r/outlinewiki/outline)
|
* **Image**: [outlinewiki/outline](https://hub.docker.com/r/outlinewiki/outline), 4, upstream
|
||||||
* **Healthcheck**: No
|
* **Healthcheck**: No
|
||||||
* **Backups**: No
|
* **Backups**: Yes
|
||||||
* **Email**: No
|
* **Email**: Yes
|
||||||
* **Tests**: No
|
* **Tests**: 2
|
||||||
* **SSO**: 3 (OAuth)
|
* **SSO**: 3 (OAuth)
|
||||||
|
|
||||||
<!-- endmetadata -->
|
<!-- endmetadata -->
|
||||||
@ -19,10 +19,14 @@ Wiki and knowledge base for growing teams
|
|||||||
|
|
||||||
1. Set up Docker Swarm and [`abra`]
|
1. Set up Docker Swarm and [`abra`]
|
||||||
2. Deploy [`coop-cloud/traefik`]
|
2. Deploy [`coop-cloud/traefik`]
|
||||||
3. `abra app new ${REPO_NAME} --secrets` (optionally with `--pass` if you'd like
|
3. `abra app new ${REPO_NAME}`
|
||||||
to save secrets in `pass`)
|
- **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
|
4. `abra app config YOURAPPNAME` - be sure to change `$DOMAIN` to something that resolves to
|
||||||
your Docker swarm box
|
your Docker swarm box. For Minio, you'll want:
|
||||||
|
- `AWS_ACCESS_KEY_ID=<minio username>`
|
||||||
|
- `AWS_REGION="us-east-1"`
|
||||||
|
- `AWS_S3_UPLOAD_BUCKET_URL=https://minio.example.com`
|
||||||
|
- `AWS_S3_UPLOAD_BUCKET_NAME=
|
||||||
5. `abra app deploy YOURAPPNAME`
|
5. `abra app deploy YOURAPPNAME`
|
||||||
7. Open the configured domain in your browser to finish set-up
|
7. Open the configured domain in your browser to finish set-up
|
||||||
|
|
||||||
@ -31,6 +35,12 @@ Wiki and knowledge base for growing teams
|
|||||||
|
|
||||||
## Tips & Tricks
|
## Tips & Tricks
|
||||||
|
|
||||||
|
### Create an initial admin user
|
||||||
|
|
||||||
|
```
|
||||||
|
abra app cmd YOURAPPNAME app create_email_user test@example.com
|
||||||
|
```
|
||||||
|
|
||||||
### Post-deploy migration
|
### Post-deploy migration
|
||||||
|
|
||||||
```
|
```
|
||||||
|
16
abra.sh
16
abra.sh
@ -1,5 +1,17 @@
|
|||||||
export APP_ENTRYPOINT_VERSION=v6
|
export APP_ENTRYPOINT_VERSION=v8
|
||||||
export DB_ENTRYPOINT_VERSION=v1
|
export DB_ENTRYPOINT_VERSION=v2
|
||||||
|
|
||||||
|
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() {
|
migrate() {
|
||||||
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
|
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
|
||||||
|
18
compose.smtp.yml
Normal file
18
compose.smtp.yml
Normal 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}
|
@ -6,7 +6,7 @@ services:
|
|||||||
networks:
|
networks:
|
||||||
- backend
|
- backend
|
||||||
- proxy
|
- proxy
|
||||||
image: outlinewiki/outline:0.69.2
|
image: outlinewiki/outline:0.73.1
|
||||||
secrets:
|
secrets:
|
||||||
- aws_secret_key
|
- aws_secret_key
|
||||||
- db_password
|
- db_password
|
||||||
@ -43,19 +43,19 @@ services:
|
|||||||
- "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`${EXTRA_DOMAINS})"
|
- "traefik.http.routers.${STACK_NAME}.rule=Host(`${DOMAIN}`${EXTRA_DOMAINS})"
|
||||||
- "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
|
- "traefik.http.routers.${STACK_NAME}.entrypoints=web-secure"
|
||||||
- "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
|
- "traefik.http.routers.${STACK_NAME}.tls.certresolver=${LETS_ENCRYPT_ENV}"
|
||||||
- "coop-cloud.${STACK_NAME}.version=0.8.0+0.69.2"
|
- "coop-cloud.${STACK_NAME}.version=1.1.0+0.73.1"
|
||||||
## 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}"
|
||||||
|
|
||||||
cache:
|
cache:
|
||||||
image: redis:7.0.11
|
image: redis:7.2.3
|
||||||
networks:
|
networks:
|
||||||
- backend
|
- backend
|
||||||
|
|
||||||
db:
|
db:
|
||||||
image: postgres:15.3
|
image: postgres:15.5
|
||||||
networks:
|
networks:
|
||||||
- backend
|
- backend
|
||||||
secrets:
|
secrets:
|
||||||
|
@ -7,13 +7,14 @@ OLDDATA=$PGDATA/old_data
|
|||||||
NEWDATA=$PGDATA/new_data
|
NEWDATA=$PGDATA/new_data
|
||||||
|
|
||||||
if [ -e $MIGRATION_MARKER ]; then
|
if [ -e $MIGRATION_MARKER ]; then
|
||||||
echo "FATAL: previous migration not completed. manual restore necessary"
|
echo "FATAL: migration was started but did not complete in a previous run. manual recovery necessary"
|
||||||
exit 1
|
exit 1
|
||||||
fi
|
fi
|
||||||
|
|
||||||
DATA_VERSION=$(cat $PGDATA/PG_VERSION)
|
if [ -f $PGDATA/PG_VERSION ]; then
|
||||||
|
DATA_VERSION=$(cat $PGDATA/PG_VERSION)
|
||||||
|
|
||||||
if [ -n "$DATA_VERSION" -a "$PG_MAJOR" != "$DATA_VERSION" ]; then
|
if [ -n "$DATA_VERSION" -a "$PG_MAJOR" != "$DATA_VERSION" ]; then
|
||||||
echo "postgres data version $DATA_VERSION found, but need $PG_MAJOR. Starting migration"
|
echo "postgres data version $DATA_VERSION found, but need $PG_MAJOR. Starting migration"
|
||||||
echo "Installing postgres $DATA_VERSION"
|
echo "Installing postgres $DATA_VERSION"
|
||||||
sed -i "s/$/ $DATA_VERSION/" /etc/apt/sources.list.d/pgdg.list
|
sed -i "s/$/ $DATA_VERSION/" /etc/apt/sources.list.d/pgdg.list
|
||||||
@ -27,7 +28,7 @@ if [ -n "$DATA_VERSION" -a "$PG_MAJOR" != "$DATA_VERSION" ]; then
|
|||||||
touch $MIGRATION_MARKER
|
touch $MIGRATION_MARKER
|
||||||
echo "running initdb"
|
echo "running initdb"
|
||||||
# abuse entrypoint script for initdb by making server error out
|
# 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"
|
gosu postgres bash -c "export PGDATA=$NEWDATA ; /usr/local/bin/docker-entrypoint.sh --invalid-arg || true"
|
||||||
echo "running pg_upgrade"
|
echo "running pg_upgrade"
|
||||||
cd /tmp
|
cd /tmp
|
||||||
gosu postgres pg_upgrade --link -b /usr/lib/postgresql/$DATA_VERSION/bin -d $OLDDATA -D $NEWDATA -U $POSTGRES_USER
|
gosu postgres pg_upgrade --link -b /usr/lib/postgresql/$DATA_VERSION/bin -d $OLDDATA -D $NEWDATA -U $POSTGRES_USER
|
||||||
@ -37,6 +38,7 @@ if [ -n "$DATA_VERSION" -a "$PG_MAJOR" != "$DATA_VERSION" ]; then
|
|||||||
rmdir $NEWDATA
|
rmdir $NEWDATA
|
||||||
rm $MIGRATION_MARKER
|
rm $MIGRATION_MARKER
|
||||||
echo "migration complete"
|
echo "migration complete"
|
||||||
|
fi
|
||||||
fi
|
fi
|
||||||
|
|
||||||
/usr/local/bin/docker-entrypoint.sh postgres
|
/usr/local/bin/docker-entrypoint.sh postgres
|
||||||
|
@ -2,6 +2,10 @@
|
|||||||
|
|
||||||
export AWS_SECRET_ACCESS_KEY=$(cat /run/secrets/aws_secret_key)
|
export AWS_SECRET_ACCESS_KEY=$(cat /run/secrets/aws_secret_key)
|
||||||
|
|
||||||
|
{{ if eq (env "SMTP_ENABLED") "1" }}
|
||||||
|
export SMTP_PASSWORD=$(cat /run/secrets/smtp_password)
|
||||||
|
{{ end }}
|
||||||
|
|
||||||
{{ if eq (env "OIDC_ENABLED") "1" }}
|
{{ if eq (env "OIDC_ENABLED") "1" }}
|
||||||
export OIDC_CLIENT_SECRET=$(cat /run/secrets/oidc_client_secret)
|
export OIDC_CLIENT_SECRET=$(cat /run/secrets/oidc_client_secret)
|
||||||
{{ end }}
|
{{ end }}
|
||||||
@ -15,5 +19,7 @@ export SECRET_KEY=$(cat /run/secrets/secret_key)
|
|||||||
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
|
export DATABASE_PASSWORD=$(cat /run/secrets/db_password)
|
||||||
export DATABASE_URL="postgres://outline:${DATABASE_PASSWORD}@${STACK_NAME}_db:5432/outline"
|
export DATABASE_URL="postgres://outline:${DATABASE_PASSWORD}@${STACK_NAME}_db:5432/outline"
|
||||||
|
|
||||||
/usr/local/bin/yarn db:migrate --env=production-ssl-disabled
|
if [ ! "$1" = "-e" ]; then
|
||||||
/usr/local/bin/yarn start "$@"
|
/usr/local/bin/yarn db:migrate --env=production-ssl-disabled
|
||||||
|
/usr/local/bin/yarn start "$@"
|
||||||
|
fi
|
||||||
|
Reference in New Issue
Block a user