forked from coop-cloud/discourse
Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
a09477f40d |
+40
@@ -0,0 +1,40 @@
|
||||
---
|
||||
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: discourse
|
||||
generate_secrets: true
|
||||
purge: true
|
||||
deploy_key:
|
||||
from_secret: drone_ssh_swarm_test
|
||||
networks:
|
||||
- proxy
|
||||
environment:
|
||||
DOMAIN: discourse.swarm-test.autonomic.zone
|
||||
STACK_NAME: discourse
|
||||
LETS_ENCRYPT_ENV: production
|
||||
SECRET_DB_PASSWORD_VERSION: v1
|
||||
DB_ENTRYPOINT_VERSION: v1
|
||||
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
|
||||
+23
@@ -0,0 +1,23 @@
|
||||
TYPE=discourse
|
||||
|
||||
DOMAIN=discourse.example.com
|
||||
## Domain aliases
|
||||
#EXTRA_DOMAINS=', `www.discourse.example.com`'
|
||||
LETS_ENCRYPT_ENV=production
|
||||
|
||||
# Admin / developer accounts (comma-separated); these become admins on signup
|
||||
DISCOURSE_DEVELOPER_EMAILS=admin@example.com
|
||||
|
||||
# Outgoing email (official discourse/discourse env names)
|
||||
#DISCOURSE_SMTP_ADDRESS=
|
||||
#DISCOURSE_SMTP_PORT=587
|
||||
#DISCOURSE_SMTP_USER_NAME=
|
||||
#DISCOURSE_SMTP_AUTHENTICATION=login
|
||||
#DISCOURSE_SMTP_ENABLE_START_TLS=true
|
||||
# Set this if you send e-mail from a different address than noreply@$DOMAIN
|
||||
#DISCOURSE_NOTIFICATION_EMAIL=
|
||||
|
||||
# SMTP password as a secret
|
||||
#SECRET_SMTP_PASSWORD_VERSION=v1
|
||||
|
||||
SECRET_DB_PASSWORD_VERSION=v1
|
||||
@@ -1 +0,0 @@
|
||||
.env
|
||||
@@ -1,24 +1,59 @@
|
||||
# Discourse
|
||||
|
||||
Wiki Cafe's configuration for a Discourse deployment. Originally slimmed down from an `abra` [recipe](https://git.coopcloud.tech/coop-cloud/discourse) by [Co-op Cloud](https://coopcloud.tech/).
|
||||
[](https://build.coopcloud.tech/coop-cloud/discourse)
|
||||
|
||||
A platform for community discussion
|
||||
|
||||
## Deploying the app with Docker Swarm
|
||||
<!-- metadata -->
|
||||
* **Category**: Apps
|
||||
* **Status**: 3, experimental
|
||||
* **Image**: [`discourse/discourse`](https://hub.docker.com/r/discourse/discourse), 4, upstream
|
||||
* **Healthcheck**: yes
|
||||
* **Backups**: yes
|
||||
* **Email**: yes
|
||||
* **Tests**: yes
|
||||
* **SSO**: no
|
||||
<!-- endmetadata -->
|
||||
|
||||
Set the environment variables from the .env file during the shell session.
|
||||
> **Note**: this recipe runs the official, **experimental** `discourse/discourse`
|
||||
> image. Upstream does not yet recommend it for production — see
|
||||
> <https://meta.discourse.org/t/380646>. Use with care.
|
||||
|
||||
## Basic usage
|
||||
|
||||
1. Set up Docker Swarm and [`abra`]
|
||||
2. Deploy [`coop-cloud/traefik`]
|
||||
3. `abra app new discourse --secrets`
|
||||
4. `abra app config YOURAPPDOMAIN` — set `DOMAIN` and `DISCOURSE_DEVELOPER_EMAILS`
|
||||
5. `abra app deploy YOURAPPDOMAIN`
|
||||
6. Open the configured domain in your browser to finish set-up. The first account
|
||||
that registers with an address listed in `DISCOURSE_DEVELOPER_EMAILS` becomes
|
||||
an admin.
|
||||
|
||||
[`abra`]: https://docs.coopcloud.tech/abra/
|
||||
[`coop-cloud/traefik`]: https://git.coopcloud.tech/coop-cloud/traefik
|
||||
|
||||
The app serves plain HTTP on port 80; Traefik terminates TLS in front of it. The
|
||||
image's built-in nginx/Let's Encrypt is disabled by the recipe (`install-ssl`
|
||||
override) so it works behind the reverse proxy.
|
||||
|
||||
## Add an admin user
|
||||
|
||||
```
|
||||
set -a && source .env && set +a
|
||||
abra app run YOURAPPDOMAIN app discourse admin create
|
||||
```
|
||||
|
||||
Set the secrets.
|
||||
## Migrating from the previous (bitnami) recipe
|
||||
|
||||
The official image stores uploads under `/shared` rather than bitnami's
|
||||
`/bitnami/discourse`. On first boot the recipe copies uploads + backups from the
|
||||
old bitnami volume (mounted read-only at `/legacy`) into `/shared`, once,
|
||||
idempotently. The Postgres database is reused as-is. After a successful migration
|
||||
a later recipe version will drop the transitional `/legacy` mount.
|
||||
|
||||
If you are upgrading from the bitnami recipe, also remove the now-unused sidekiq
|
||||
service that swarm leaves behind (sidekiq runs inside the app container now):
|
||||
|
||||
```
|
||||
printf "SECRET_HERE" | docker secret create SECRET_NAME -
|
||||
```
|
||||
|
||||
Deploy using the `-c` flag to specify one or multiple compose files.
|
||||
|
||||
```
|
||||
docker stack deploy discourse --detach=true -c compose.yaml -c compose.smtpauth.yaml
|
||||
docker service rm YOURSTACK_sidekiq
|
||||
```
|
||||
|
||||
@@ -0,0 +1,5 @@
|
||||
export DB_ENTRYPOINT_VERSION=v3
|
||||
export PG_BACKUP_VERSION=v2
|
||||
export APP_ENTRYPOINT_VERSION=v2
|
||||
export APP_INSTALL_SSL_VERSION=v1
|
||||
export APP_MIGRATE_UPLOADS_VERSION=v1
|
||||
@@ -1,3 +1,6 @@
|
||||
---
|
||||
version: "3.8"
|
||||
|
||||
services:
|
||||
app:
|
||||
# the wrapper entrypoint reads /run/secrets/smtp_password and exports
|
||||
@@ -8,4 +11,4 @@ services:
|
||||
secrets:
|
||||
smtp_password:
|
||||
external: true
|
||||
name: ${STACK_NAME}_smtp_password
|
||||
name: ${STACK_NAME}_smtp_password_${SECRET_SMTP_PASSWORD_VERSION}
|
||||
+29
-35
@@ -1,7 +1,9 @@
|
||||
---
|
||||
version: "3.8"
|
||||
|
||||
services:
|
||||
app:
|
||||
image: discourse/discourse:2026.7.4
|
||||
image: discourse/discourse:3.5.3
|
||||
networks:
|
||||
- proxy
|
||||
- internal
|
||||
@@ -25,6 +27,8 @@ services:
|
||||
- DISCOURSE_NOTIFICATION_EMAIL
|
||||
volumes:
|
||||
- 'discourse_shared:/shared'
|
||||
# transition only: legacy bitnami volume, read-only, for one-time upload migration
|
||||
- 'discourse_data:/legacy:ro'
|
||||
secrets:
|
||||
- db_password
|
||||
configs:
|
||||
@@ -50,9 +54,7 @@ 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}"
|
||||
- "caddy=${DOMAIN}"
|
||||
- "caddy.reverse_proxy={{upstreams 80}}"
|
||||
- "caddy.tls.on_demand="
|
||||
- "coop-cloud.${STACK_NAME}.version=1.0.0+3.5.3"
|
||||
healthcheck:
|
||||
test: "curl -fsS http://localhost/srv/status || exit 1"
|
||||
interval: 30s
|
||||
@@ -61,48 +63,35 @@ services:
|
||||
start_period: 25m
|
||||
|
||||
db:
|
||||
# discourse/postgres = pgvector + discourse's postgres management layer, which
|
||||
# auto-upgrades an older cluster in place on boot (pg_upgrade into the versioned
|
||||
# PGDATA /var/lib/postgresql/${MAJOR}/docker); everything is driven by the env below.
|
||||
image: discourse/postgres:pg18
|
||||
image: pgvector/pgvector:pg17
|
||||
networks:
|
||||
- internal
|
||||
secrets:
|
||||
- db_password
|
||||
volumes:
|
||||
# the image expects the whole cluster tree mounted here (not the data subdir);
|
||||
# an existing pg17 cluster at the volume root is found and upgraded into /18/docker
|
||||
- 'postgresql_data:/var/lib/postgresql'
|
||||
- 'postgresql_data:/var/lib/postgresql/data'
|
||||
configs:
|
||||
- source: db_entrypoint
|
||||
target: /docker-entrypoint.sh
|
||||
mode: 0555
|
||||
- source: pg_backup
|
||||
target: /pg_backup.sh
|
||||
mode: 0555
|
||||
entrypoint:
|
||||
- /bin/bash
|
||||
- -c
|
||||
- |
|
||||
if [ -f /run/secrets/db_password ]; then
|
||||
DB_PASSWORD="$$(cat /run/secrets/db_password)"
|
||||
export DB_PASSWORD POSTGRES_PASSWORD="$$DB_PASSWORD"
|
||||
fi
|
||||
exec run-postgres.sh postgres
|
||||
entrypoint: /docker-entrypoint.sh
|
||||
environment:
|
||||
# internal-only overlay network; keep all-trust so the app and the
|
||||
# backup/restore hooks connect without juggling the superuser password
|
||||
- POSTGRES_HOST_AUTH_METHOD=trust
|
||||
- POSTGRES_USER=discourse
|
||||
- POSTGRES_DB=discourse
|
||||
- DB_USER=discourse
|
||||
# pg_upgrade runs as this role and initdb's the new cluster with it; it must
|
||||
# match the OLD cluster's bootstrap superuser (oid 10). The image default
|
||||
# `postgres` matches fresh installs and bitnami-origin clusters. Override in
|
||||
# the app .env (POSTGRES_USER=...) only for a cluster bootstrapped differently.
|
||||
- POSTGRES_USER=${POSTGRES_USER:-postgres}
|
||||
- POSTGRES_PASSWORD_FILE=/run/secrets/db_password
|
||||
healthcheck:
|
||||
test: "pg_isready -U discourse -d discourse"
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 5
|
||||
start_period: 15m
|
||||
# generous: a postgres major-version upgrade (apt install + pg_upgrade) runs
|
||||
# in the entrypoint before the server accepts connections — don't let the
|
||||
# healthcheck kill an in-progress migration
|
||||
start_period: 10m
|
||||
deploy:
|
||||
labels:
|
||||
backupbot.backup: "true"
|
||||
@@ -111,7 +100,7 @@ services:
|
||||
backupbot.restore.post-hook: "/pg_backup.sh restore"
|
||||
|
||||
redis:
|
||||
image: redis:8.10-alpine
|
||||
image: redis:7.4-alpine
|
||||
networks:
|
||||
- internal
|
||||
volumes:
|
||||
@@ -126,12 +115,13 @@ services:
|
||||
secrets:
|
||||
db_password:
|
||||
external: true
|
||||
name: ${STACK_NAME}_db_password
|
||||
name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
|
||||
|
||||
volumes:
|
||||
postgresql_data:
|
||||
redis_data:
|
||||
discourse_shared:
|
||||
discourse_data:
|
||||
|
||||
networks:
|
||||
proxy:
|
||||
@@ -140,14 +130,18 @@ networks:
|
||||
|
||||
configs:
|
||||
app_entrypoint:
|
||||
name: ${STACK_NAME}_app_entrypoint
|
||||
name: ${STACK_NAME}_app_entrypoint_${APP_ENTRYPOINT_VERSION}
|
||||
file: cc-app-entrypoint.sh
|
||||
app_install_ssl:
|
||||
name: ${STACK_NAME}_app_install_ssl
|
||||
name: ${STACK_NAME}_app_install_ssl_${APP_INSTALL_SSL_VERSION}
|
||||
file: app-install-ssl.sh
|
||||
app_migrate_uploads:
|
||||
name: ${STACK_NAME}_app_migrate_uploads
|
||||
name: ${STACK_NAME}_app_migrate_uploads_${APP_MIGRATE_UPLOADS_VERSION}
|
||||
file: migrate-uploads.sh
|
||||
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
|
||||
name: ${STACK_NAME}_pg_backup_${PG_BACKUP_VERSION}
|
||||
file: pg_backup.sh
|
||||
@@ -0,0 +1,64 @@
|
||||
#!/bin/bash
|
||||
|
||||
set -e
|
||||
|
||||
OLDDATA=$PGDATA/old_data
|
||||
NEWDATA=$PGDATA/new_data
|
||||
|
||||
echo "Running as $(id)"
|
||||
|
||||
# The migration uses $OLDDATA/$NEWDATA as scratch and removes them when it
|
||||
# finishes; a leftover *empty* one means a run was interrupted before any data
|
||||
# moved (data still intact at $PGDATA) so we clear it and retry, while a
|
||||
# *non-empty* one means data may live only there, so we stop for manual recovery.
|
||||
for scratch in $OLDDATA $NEWDATA; do
|
||||
if [ -d "$scratch" ] && [ -n "$(ls -A "$scratch")" ]; then
|
||||
echo "FATAL: $scratch exists and is not empty - a previous migration did not"
|
||||
echo "complete and the data may only exist there. manual recovery necessary."
|
||||
exit 1
|
||||
fi
|
||||
done
|
||||
rm -rf $OLDDATA $NEWDATA
|
||||
|
||||
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/*
|
||||
# pg_upgrade must run as the old cluster's bootstrap superuser (the "install
|
||||
# user", oid 10), and the new cluster must be initialised with that same
|
||||
# user. It is not necessarily $POSTGRES_USER (e.g. clusters created with the
|
||||
# default "postgres" superuser and a separate app role), so read it from the
|
||||
# old cluster: briefly start it and ask, connecting as the app role we know.
|
||||
PGBIN=/usr/lib/postgresql/$DATA_VERSION/bin
|
||||
gosu postgres $PGBIN/pg_ctl -D $PGDATA -w \
|
||||
-o "-c listen_addresses= -c unix_socket_directories=/tmp" start
|
||||
INSTALL_USER=$(gosu postgres psql -h /tmp -U "$POSTGRES_USER" -d postgres -tAc \
|
||||
"select rolname from pg_roles where oid = 10")
|
||||
gosu postgres $PGBIN/pg_ctl -D $PGDATA -w stop
|
||||
echo "old cluster install user: $INSTALL_USER"
|
||||
echo "shuffling around"
|
||||
gosu postgres mkdir $OLDDATA $NEWDATA
|
||||
chmod 700 $OLDDATA $NEWDATA
|
||||
mv $PGDATA/* $OLDDATA/ || true
|
||||
echo "running initdb"
|
||||
# abuse entrypoint script for initdb by making server error out; initialise
|
||||
# the new cluster with the same superuser as the old one so pg_upgrade matches
|
||||
gosu postgres bash -c "export PGDATA=$NEWDATA POSTGRES_USER=$INSTALL_USER ; /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 $INSTALL_USER
|
||||
cp $OLDDATA/pg_hba.conf $NEWDATA/
|
||||
mv $NEWDATA/* $PGDATA
|
||||
rm -rf $OLDDATA
|
||||
rmdir $NEWDATA
|
||||
echo "migration complete"
|
||||
fi
|
||||
fi
|
||||
|
||||
/usr/local/bin/docker-entrypoint.sh postgres
|
||||
+13
-16
@@ -1,47 +1,44 @@
|
||||
#!/bin/bash
|
||||
|
||||
# Postgres backup/restore hook for the discourse `db` service (discourse/postgres image).
|
||||
# Postgres backup/restore hook for the discourse `db` service.
|
||||
|
||||
set -e
|
||||
|
||||
# dump goes at the volume root so backupbot's backup.sql label finds it
|
||||
BACKUP_FILE='/var/lib/postgresql/backup.sql'
|
||||
DATADIR="${PGDATA:-/var/lib/postgresql/18/docker}"
|
||||
BACKUP_FILE='/var/lib/postgresql/data/backup.sql'
|
||||
export PGPASSWORD=$(cat "${POSTGRES_PASSWORD_FILE:-/run/secrets/db_password}")
|
||||
DB_USER="${POSTGRES_USER:-discourse}"
|
||||
DB_NAME="${POSTGRES_DB:-discourse}"
|
||||
|
||||
# bootstrap superuser for the dump/drop/recreate; same POSTGRES_USER the db service sets
|
||||
SU="${POSTGRES_USER:-postgres}"
|
||||
|
||||
function backup {
|
||||
pg_dump -U "$SU" "$DB_NAME" | gzip > "$BACKUP_FILE"
|
||||
pg_dump -U "$DB_USER" "$DB_NAME" | gzip > "$BACKUP_FILE"
|
||||
}
|
||||
|
||||
function restore {
|
||||
cd "$DATADIR"
|
||||
cd /var/lib/postgresql/data/
|
||||
|
||||
# Block all non-local connections so the running discourse app + sidekiq cannot reconnect and
|
||||
# interfere with the drop/recreate/reimport. Restored on exit.
|
||||
restore_hba() {
|
||||
cat pg_hba.conf.bak > pg_hba.conf
|
||||
rm -f pg_hba.conf.bak
|
||||
su postgres -c "pg_ctl -D '$DATADIR' reload"
|
||||
su postgres -c 'pg_ctl reload'
|
||||
}
|
||||
cp pg_hba.conf pg_hba.conf.bak
|
||||
echo 'local all all trust' > pg_hba.conf
|
||||
su postgres -c "pg_ctl -D '$DATADIR' reload"
|
||||
su postgres -c 'pg_ctl reload'
|
||||
trap restore_hba EXIT INT TERM
|
||||
|
||||
# terminate any lingering local sessions before recreate
|
||||
# see https://stackoverflow.com/questions/5108876/kill-a-postgresql-session-connection
|
||||
psql -U "$SU" -d postgres -c \
|
||||
psql -U "$DB_USER" -d postgres -c \
|
||||
"SELECT pg_terminate_backend(pid) FROM pg_stat_activity WHERE datname='${DB_NAME}' AND pid<>pg_backend_pid();"
|
||||
|
||||
# drop database and then recreate it
|
||||
psql -U "$SU" -d postgres -c "DROP DATABASE ${DB_NAME} WITH (FORCE);"
|
||||
createdb -U "$SU" "$DB_NAME"
|
||||
psql -U "$DB_USER" -d postgres -c "DROP DATABASE ${DB_NAME} WITH (FORCE);"
|
||||
createdb -U "$DB_USER" "$DB_NAME"
|
||||
|
||||
# reimport data
|
||||
gunzip -c "$BACKUP_FILE" | psql -U "$SU" -d "$DB_NAME" -1 -v ON_ERROR_STOP=1 -f -
|
||||
# reimport data
|
||||
gunzip -c "$BACKUP_FILE" | psql -U "$DB_USER" -d "$DB_NAME" -1 -v ON_ERROR_STOP=1 -f -
|
||||
}
|
||||
|
||||
$@
|
||||
|
||||
@@ -0,0 +1,10 @@
|
||||
This release switches from the bitnami image to the official discourse/discourse
|
||||
image. Some env vars need to be renamed for this migration; everything else
|
||||
should happen automatically.
|
||||
|
||||
Rename these in your app's .env (the values carry over):
|
||||
|
||||
DISCOURSE_SMTP_HOST --> DISCOURSE_SMTP_ADDRESS
|
||||
DISCOURSE_SMTP_USER --> DISCOURSE_SMTP_USER_NAME
|
||||
DISCOURSE_SMTP_AUTH --> DISCOURSE_SMTP_AUTHENTICATION
|
||||
DISCOURSE_SMTP_PROTOCOL --> DISCOURSE_SMTP_ENABLE_START_TLS (takes a boolean true/false, not the old tls/ssl value, so translate it rather than copying it straight across)
|
||||
Reference in New Issue
Block a user