diff --git a/clickhouse/README.org b/clickhouse/README.org index 60a5e15..eda0e46 100644 --- a/clickhouse/README.org +++ b/clickhouse/README.org @@ -4,4 +4,23 @@ This charm is provided to work with plausible charm -* Usage \ No newline at end of file +Configuration files come from +https://github.com/plausible/community-edition/ (=clickhouse/=). + +* Usage + +Added automatically by the =plausible= charm (=event-db= relation). + +* Low memory settings + +- =config.d/low-resources.xml=: server settings (=mark_cache_size=). +- =users.d/default-profile-low-resources-overrides.xml=: settings of the + =default= profile (=max_threads= 1, …). ClickHouse reads profiles + only from users configuration files: in =config.d= they were ignored. + +Check that they apply: + +#+begin_src sh +docker exec clickhouse-client -q \ + "SELECT name, value FROM system.settings WHERE name = 'max_threads'" +#+end_src diff --git a/clickhouse/metadata.yml b/clickhouse/metadata.yml index e52a27e..ddacb04 100644 --- a/clickhouse/metadata.yml +++ b/clickhouse/metadata.yml @@ -9,6 +9,9 @@ charm-resources: - /etc/clickhouse-server/config.d/logs.xml - /etc/clickhouse-server/config.d/ipv4-only.xml - /etc/clickhouse-server/config.d/low-resources.xml + ## Profile settings are only read from users.d (they were ignored when + ## they lived in config.d/low-resources.xml). + - /etc/clickhouse-server/users.d/default-profile-low-resources-overrides.xml provides: event-db: diff --git a/clickhouse/resources/etc/clickhouse-server/config.d/low-resources.xml b/clickhouse/resources/etc/clickhouse-server/config.d/low-resources.xml index aab3cd8..7734a62 100644 --- a/clickhouse/resources/etc/clickhouse-server/config.d/low-resources.xml +++ b/clickhouse/resources/etc/clickhouse-server/config.d/low-resources.xml @@ -1,23 +1,4 @@ - - + 524288000 - - - - - 1 - - 8192 - - 1 - - 0 - - 0 - - - \ No newline at end of file + diff --git a/clickhouse/resources/etc/clickhouse-server/users.d/default-profile-low-resources-overrides.xml b/clickhouse/resources/etc/clickhouse-server/users.d/default-profile-low-resources-overrides.xml new file mode 100644 index 0000000..20874e1 --- /dev/null +++ b/clickhouse/resources/etc/clickhouse-server/users.d/default-profile-low-resources-overrides.xml @@ -0,0 +1,19 @@ + + + + + + 1 + + 8192 + + 1 + + 0 + + 0 + + + diff --git a/plausible/README.org b/plausible/README.org index f8d1908..e4275cf 100644 --- a/plausible/README.org +++ b/plausible/README.org @@ -4,4 +4,40 @@ From: https://github.com/plausible/community-edition/ -* Usage \ No newline at end of file +* Usage + +#+begin_src yaml +plausible: + relations: + web-proxy: + frontend: + domain: stats.example.com +#+end_src + +A =clickhouse= (statistics) and a =postgres= (accounts, sites) service +are added automatically. + +* Security + +- Plausible before 3.2.1 serves =/storybook=, which runs any code sent + to it without authentication (CVE-2026-8467, GHSA-mhcv-h7gf-57cf). + This charm uses 3.2.1, and its default web-proxy rules refuse + =/storybook= in case an older image is deployed again. +- The Erlang release cookie of the image is generated when the image is + built, so it is the same for every installation. The charm generates + its own (=release-cookie= in the service datastore) and sets + =RELEASE_DISTRIBUTION= to =none=: this single node opens no =epmd= nor + Erlang distribution port. + +* Upgrading from 3.0.x + +- Migrations run at each start (=db migrate= in the entrypoint), for + both PostgreSQL and ClickHouse. They cannot be reverted: back up both + databases first. +- Deploy together with the =clickhouse= charm of the same revision: the + ClickHouse low-memory profile moved to =users.d= (upstream change of + 3.2.0). +- Sites keep working with their existing tracking snippet. +- Changing =secret-key= signs everybody out, invalidates every API key, + and makes the 2FA secrets unreadable unless =TOTP_VAULT_KEY= is set + to the key derived from the previous one. diff --git a/plausible/hooks/init b/plausible/hooks/init index 251127b..586d5be 100755 --- a/plausible/hooks/init +++ b/plausible/hooks/init @@ -1,6 +1,10 @@ #!/bin/bash SECRET_KEY_BASE="$SERVICE_DATASTORE"/secret-key +## Erlang release cookie. The image ships one in ``/app/releases/COOKIE`` +## that is generated when the image is built, so it is the same for every +## installation of that image: replace it by one of our own. +RELEASE_COOKIE_FILE="$SERVICE_DATASTORE"/release-cookie SHARE_DIR="$SERVICE_DATASTORE"/var/lib/plausible mkdir -p $SHARE_DIR @@ -16,12 +20,25 @@ else info "Using existing secret key" fi -secret_key_base=$(cat "$SECRET_KEY_BASE") +if ! [ -f "$RELEASE_COOKIE_FILE" ]; then + info "Generating Erlang release cookie" + mkdir -p "${RELEASE_COOKIE_FILE%/*}" + (umask 077; openssl rand -hex 32 > "$RELEASE_COOKIE_FILE") +fi +secret_key_base=$(cat "$SECRET_KEY_BASE") +release_cookie=$(cat "$RELEASE_COOKIE_FILE") + +## ``RELEASE_DISTRIBUTION: none``: Plausible Community Edition runs a +## single node and never needs Erlang distribution (the ``db createdb`` and +## ``db migrate`` commands use ``eval``), so the node opens no ``epmd`` nor +## distribution port that anything else could connect to. init-config-add " $SERVICE_NAME: environment: SECRET_KEY_BASE: \"$secret_key_base\" + RELEASE_COOKIE: \"$release_cookie\" + RELEASE_DISTRIBUTION: \"none\" " chown -v "$uid" "$SHARE_DIR" diff --git a/plausible/metadata.yml b/plausible/metadata.yml index cdc46f5..386dc4f 100644 --- a/plausible/metadata.yml +++ b/plausible/metadata.yml @@ -1,5 +1,6 @@ -docker-image: docker.0k.io/plausible:3.0.1 -#docker-image: ghcr.io/plausible/community-edition:v3.0.1 +## 3.2.1 or later is required: earlier versions expose ``/storybook``, +## an unauthenticated remote code execution (CVE-2026-8467). +docker-image: docker.0k.io/plausible:3.2.1 ## from: ghcr.io/plausible/community-edition:v3.2.1 data-resources: - /var/lib/plausible @@ -49,6 +50,11 @@ uses: RewriteCond %{HTTP:Connection} upgrade [NC] RewriteRule ^/(live/websocket)$ ws://${MASTER_BASE_SERVICE_NAME}:8000/\$1 [P,L] + ## Plausible < 3.2.1 runs any code sent to /storybook + ## (CVE-2026-8467). 3.2.1 removed it; keep it closed in case + ## an older image is ever deployed again. + RewriteRule ^/storybook(/|$) - [F,L] + backup: constraint: recommended