14 Commits

Author SHA1 Message Date
3wc
738fbe7a4e Re-add SECRET_SESSION_SECRET_VERSION..
..which I accidentally removed while rebasing
2024-10-27 12:36:57 -04:00
f
f05234338e fix: backup bot configuration 2024-10-27 12:36:15 -04:00
f
cb4219e7c3 fix: chown the database 2024-10-27 12:36:15 -04:00
f
b206e7a386 fix: db_password secret not needed 2024-10-27 12:36:13 -04:00
f
b4dd6ddbbd fix: don't overwrite CMD_DB_URL 2024-10-27 12:35:49 -04:00
f
a24809ab38 feat: postgresql support is optional 2024-10-27 12:35:49 -04:00
f
543f0823bb feat: support sqlite 2024-10-27 12:35:48 -04:00
6feab6a99e Merge pull request 'envvars' (#16) from fauno/hedgedoc:envvars into main
Some checks failed
continuous-integration/drone/push Build is failing
Reviewed-on: #16
2024-10-27 06:22:01 +00:00
f
ca5a95bea6 fix: load secret from file into env var
Some checks failed
continuous-integration/drone/pr Build is failing
2024-10-26 11:01:18 -03:00
f
6a036c4c82 fix: set session secret
Some checks failed
continuous-integration/drone/pr Build is failing
2024-10-25 17:47:27 -03:00
f
d19f286c11 fix: require authentication for free urls 2024-10-25 17:46:47 -03:00
635eee710b chore: publish 1.2.1+1.10.0 release
All checks were successful
continuous-integration/drone/tag Build is passing
continuous-integration/drone/push Build is passing
2024-10-25 21:04:02 +02:00
49f06173e9 fix drone runner
All checks were successful
continuous-integration/drone/push Build is passing
2024-10-24 13:31:31 +02:00
9194256835 update backupbot label
Some checks failed
continuous-integration/drone/push Build is failing
2024-10-24 13:22:27 +02:00
7 changed files with 116 additions and 44 deletions

View File

@ -19,6 +19,7 @@ steps:
LETS_ENCRYPT_ENV: production LETS_ENCRYPT_ENV: production
SECRET_DB_PASSWORD_VERSION: v1 SECRET_DB_PASSWORD_VERSION: v1
ENTRYPOINT_CONF_VERSION: v1 ENTRYPOINT_CONF_VERSION: v1
PG_BACKUP_VERSION: v1
trigger: trigger:
branch: branch:
- main - main

View File

@ -1,16 +1,22 @@
TYPE=hedgedoc TYPE=hedgedoc
TIMEOUT=300 TIMEOUT=300
ENABLE_AUTO_UPDATE=true ENABLE_AUTO_UPDATE=true
ENABLE_BACKUPS=true
DOMAIN=hedgedoc.example.com DOMAIN=hedgedoc.example.com
## Domain aliases ## Domain aliases
#EXTRA_DOMAINS=', `www.hedgedoc.example.com`' #EXTRA_DOMAINS=', `www.hedgedoc.example.com`'
LETS_ENCRYPT_ENV=production LETS_ENCRYPT_ENV=production
SECRET_DB_PASSWORD_VERSION=v1
COMPOSE_FILE="compose.yml" COMPOSE_FILE="compose.yml"
SECRET_SESSION_SECRET_VERSION=v1
# PostgreSQL
#COMPOSE_FILE="$COMPOSE_FILE:compose.postgresql.yml"
#SECRET_DB_PASSWORD_VERSION=v1
# OAuth, see https://docs.hedgedoc.org/guides/auth/keycloak/ # OAuth, see https://docs.hedgedoc.org/guides/auth/keycloak/
#COMPOSE_FILE="$COMPOSE_FILE:compose.oauth.yml" #COMPOSE_FILE="$COMPOSE_FILE:compose.oauth.yml"
@ -33,6 +39,7 @@ COMPOSE_FILE="compose.yml"
# CMD_ALLOW_ANONYMOUS_EDITS=false # CMD_ALLOW_ANONYMOUS_EDITS=false
# CMD_ALLOW_EMAIL_REGISTER=true # CMD_ALLOW_EMAIL_REGISTER=true
# CMD_ALLOW_FREEURL=false # CMD_ALLOW_FREEURL=false
# CMD_REQUIRE_FREEURL_AUTHENTICATION=true
# CMD_ALLOW_GRAVATAR=true # CMD_ALLOW_GRAVATAR=true
# CMD_ALLOW_ORIGIN=localhost # CMD_ALLOW_ORIGIN=localhost
# CMD_COOKIE_POLICY=lax # CMD_COOKIE_POLICY=lax

View File

@ -1 +1,2 @@
export ENTRYPOINT_CONF_VERSION=v9 export ENTRYPOINT_CONF_VERSION=v10
export PG_BACKUP_VERSION=v1

55
compose.postgresql.yml Normal file
View File

@ -0,0 +1,55 @@
version: "3.8"
services:
app:
environment:
- CMD_DB_URL=
- CMD_DB_NAME=codimd
- CMD_DB_USER=codimd
- CMD_DB_HOST=db
- CMD_DB_PASSWORD_FILE=/run/secrets/db_password
depends_on:
- db
networks:
- internal
secrets:
- db_password
db:
image: postgres:16.4-alpine
environment:
- POSTGRES_USER=codimd
- POSTGRES_PASSWORD_FILE=/run/secrets/db_password
- POSTGRES_DB=codimd
volumes:
- "postgres:/var/lib/postgresql/data"
secrets:
- db_password
networks:
- internal
deploy:
labels:
backupbot.backup: "${ENABLE_BACKUPS:-true}"
backupbot.backup.pre-hook: "/pg_backup.sh backup"
backupbot.backup.volumes.postgres.path: "backup.sql"
backupbot.restore.post-hook: '/pg_backup.sh restore'
healthcheck:
test: "pg_isready"
interval: 30s
timeout: 10s
retries: 5
start_period: 1m
configs:
- source: pg_backup
target: /pg_backup.sh
mode: 0555
volumes:
postgres:
secrets:
db_password:
external: true
name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION}
networks:
internal:
configs:
pg_backup:
name: ${STACK_NAME}_pg_backup_${PG_BACKUP_VERSION}
file: pg_backup.sh

View File

@ -8,14 +8,12 @@ services:
- CMD_DOMAIN=$DOMAIN - CMD_DOMAIN=$DOMAIN
- CMD_PROTOCOL_USESSL=true - CMD_PROTOCOL_USESSL=true
- CMD_HSTS_ENABLE=false - CMD_HSTS_ENABLE=false
- CMD_DB_NAME=codimd - CMD_DB_URL=sqlite:/database/db.sqlite3
- CMD_DB_USER=codimd
- CMD_DB_HOST=db
- CMD_DB_PASSWORD_FILE=/run/secrets/db_password
- CMD_ALLOW_ANONYMOUS - CMD_ALLOW_ANONYMOUS
- CMD_ALLOW_ANONYMOUS_EDITS - CMD_ALLOW_ANONYMOUS_EDITS
- CMD_ALLOW_EMAIL_REGISTER - CMD_ALLOW_EMAIL_REGISTER
- CMD_ALLOW_FREEURL - CMD_ALLOW_FREEURL
- CMD_REQUIRE_FREEURL_AUTHENTICATION
- CMD_ALLOW_GRAVATAR - CMD_ALLOW_GRAVATAR
- CMD_ALLOW_ORIGIN - CMD_ALLOW_ORIGIN
- CMD_COOKIE_POLICY - CMD_COOKIE_POLICY
@ -26,16 +24,15 @@ services:
- CMD_DEFAULT_PERMISSION - CMD_DEFAULT_PERMISSION
- CMD_EMAIL - CMD_EMAIL
- CMD_SESSION_LIFE - CMD_SESSION_LIFE
- CMD_SESSION_SECRET_FILE=/run/secrets/session_secret
- DOCUMENT_MAX_LENGTH - DOCUMENT_MAX_LENGTH
depends_on:
- db
networks: networks:
- proxy - proxy
- internal
volumes: volumes:
- codimd_uploads:/hedgedoc/public/uploads - codimd_uploads:/hedgedoc/public/uploads
- codimd_database:/database
secrets: secrets:
- db_password - session_secret
entrypoint: /docker-entrypoint.sh entrypoint: /docker-entrypoint.sh
configs: configs:
- source: entrypoint_conf - source: entrypoint_conf
@ -57,51 +54,25 @@ services:
- "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:-120}" - "coop-cloud.${STACK_NAME}.timeout=${TIMEOUT:-120}"
- "coop-cloud.${STACK_NAME}.version=1.2.0+1.10.0" - "coop-cloud.${STACK_NAME}.version=1.2.1+1.10.0"
- "backupbot.backup=${ENABLE_BACKUPS:-true}"
healthcheck: healthcheck:
test: "nodejs -e \"http.get('http://localhost:3000', (res) => { console.log('status: ', res.statusCode); if (res.statusCode == 200) { process.exit(0); } else { process.exit(1); } });\"" test: "nodejs -e \"http.get('http://localhost:3000', (res) => { console.log('status: ', res.statusCode); if (res.statusCode == 200) { process.exit(0); } else { process.exit(1); } });\""
interval: 30s interval: 30s
timeout: 10s timeout: 10s
retries: 10 retries: 10
start_period: 1m start_period: 1m
db:
image: postgres:16.4-alpine
environment:
- POSTGRES_USER=codimd
- POSTGRES_PASSWORD_FILE=/run/secrets/db_password
- POSTGRES_DB=codimd
volumes:
- "postgres:/var/lib/postgresql/data"
secrets:
- db_password
networks:
- internal
deploy:
labels:
backupbot.backup: "true"
backupbot.backup.pre-hook: "PGPASSWORD=$$(cat $${POSTGRES_PASSWORD_FILE}) pg_dump -U $${POSTGRES_USER} $${POSTGRES_DB} > /var/lib/postgresql/data/backup.sql"
backupbot.backup.post-hook: "rm -f /var/lib/postgresql/data/backup.sql"
backupbot.backup.path: "/var/lib/postgresql/data/backup.sql"
backupbot.restore: "true"
backupbot.restore.post-hook: "sh -c 'psql -U $${POSTGRES_USER} -d $${POSTGRES_DB} < /var/lib/postgresql/data/backup.sql && rm -f /var/lib/postgresql/data/backup.sql'"
healthcheck:
test: "pg_isready"
interval: 30s
timeout: 10s
retries: 5
start_period: 1m
volumes: volumes:
postgres:
codimd_uploads: codimd_uploads:
codimd_database:
secrets: secrets:
db_password: session_secret:
external: true external: true
name: ${STACK_NAME}_db_password_${SECRET_DB_PASSWORD_VERSION} name: ${STACK_NAME}_session_secret_${SECRET_SESSION_SECRET_VERSION}
networks: networks:
proxy: proxy:
external: true external: true
internal:
configs: configs:
config_json: config_json:
name: ${STACK_NAME}_config_${ENTRYPOINT_CONF_VERSION} name: ${STACK_NAME}_config_${ENTRYPOINT_CONF_VERSION}

View File

@ -24,6 +24,7 @@ file_env() {
load_vars() { load_vars() {
file_env "CMD_DB_PASSWORD" file_env "CMD_DB_PASSWORD"
file_env "CMD_OAUTH2_CLIENT_SECRET" file_env "CMD_OAUTH2_CLIENT_SECRET"
file_env "CMD_SESSION_SECRET"
} }
main() { main() {
@ -33,11 +34,13 @@ main() {
mkdir -p "/hedgedoc/.npm" && \ mkdir -p "/hedgedoc/.npm" && \
chown -R 10000:65534 "/hedgedoc/.npm" && \ chown -R 10000:65534 "/hedgedoc/.npm" && \
chmod "u+rwx" "/hedgedoc/.npm" chmod "u+rwx" "/hedgedoc/.npm"
chown -R 10000:65534 /database
} }
main main
export CMD_DB_URL=postgres://$CMD_DB_USER:$CMD_DB_PASSWORD@$CMD_DB_HOST:5432/$CMD_DB_NAME export CMD_DB_URL="${CMD_DB_URL:-postgres://$CMD_DB_USER:$CMD_DB_PASSWORD@$CMD_DB_HOST:5432/$CMD_DB_NAME}"
# 3wc: `source /docker-entrypoint.sh -e` to load CMD_DB_URL for CLI scripts # 3wc: `source /docker-entrypoint.sh -e` to load CMD_DB_URL for CLI scripts
if [ ! "${1-}" == "-e" ]; then if [ ! "${1-}" == "-e" ]; then

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 /run/secrets/db_password)
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
}
$@