Add stop_grace_period of 60s to all containers

This reverts commit 43e8842846.

.github/ISSUE_TEMPLATE/best-place-for-self-hosting-issues-is-the-community-forum.md

@@ -0,0 +1,10 @@
+---
+name: Best place for self-hosting issues is the community forum
+about: Please do not submit issues here
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+Please do not submit issues here. Best place for self-hosting issues, questions and ideas is [the community forum here on GitHub](https://github.com/plausible/analytics/discussions/categories/self-hosted-support). Thanks!

.github/workflows/spellcheck.yml

@@ -0,0 +1,20 @@
+name: spellcheck
+
+on:
+  pull_request:
+  push:
+
+jobs:
+  codespell:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: codespell-project/actions-codespell@v2
+        with:
+          check_filenames: true
+
+  typos:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: crate-ci/typos@master

.gitignore

@@ -1,7 +1,2 @@
-*
+data/
-!compose.yml
+.env
-!clickhouse/logs.xml
-!clickhouse/ipv4-only.xml
-!README.md
-!LICENSE
-!.gitignore

.prettierignore

@@ -0,0 +1 @@
+*

clickhouse/clickhouse-config.xml

@@ -0,0 +1,23 @@
+<clickhouse>
+    <logger>
+        <level>warning</level>
+        <console>true</console>
+    </logger>
+    
+    <!-- 
+    Avoid the warning: "Listen [::]:9009 failed: Address family for hostname not supported". 
+    If Docker has IPv6 disabled, bind ClickHouse to IPv4 to prevent this issue. 
+    Add this to the configuration to ensure it listens on all IPv4 interfaces:
+    <listen_host>0.0.0.0</listen_host>
+    -->
+
+    <!-- Stop all the unnecessary logging -->
+    <query_thread_log remove="remove"/>
+    <query_log remove="remove"/>
+    <text_log remove="remove"/>
+    <trace_log remove="remove"/>
+    <metric_log remove="remove"/>
+    <asynchronous_metric_log remove="remove"/>
+    <session_log remove="remove"/>
+    <part_log remove="remove"/>
+</clickhouse>

clickhouse/clickhouse-user-config.xml

@@ -0,0 +1,8 @@
+<clickhouse>
+    <profiles>
+        <default>
+            <log_queries>0</log_queries>
+            <log_query_threads>0</log_query_threads>
+        </default>
+    </profiles>
+</clickhouse>

clickhouse/ipv4-only.xml

@@ -1,3 +0,0 @@
-<clickhouse>
-    <listen_host>0.0.0.0</listen_host>
-</clickhouse>

clickhouse/logs.xml

@@ -1,36 +0,0 @@
-<clickhouse>
-    <logger>
-        <level>warning</level>
-        <console>true</console>
-    </logger>
-
-    <query_log replace="1">
-        <database>system</database>
-        <table>query_log</table>
-        <flush_interval_milliseconds>7500</flush_interval_milliseconds>
-        <engine>
-            ENGINE = MergeTree
-            PARTITION BY event_date
-            ORDER BY (event_time)
-            TTL event_date + interval 30 day
-            SETTINGS ttl_only_drop_parts=1
-        </engine>
-    </query_log>
-
-    <metric_log>
-        <partition_by>event_date</partition_by>
-        <ttl>event_date + INTERVAL 30 DAY DELETE</ttl>
-    </metric_log>
-
-    <asynchronous_metric_log>
-        <partition_by>event_date</partition_by>
-        <ttl>event_date + INTERVAL 30 DAY DELETE</ttl>
-    </asynchronous_metric_log>
-
-    <!-- Stops unnecessary logging -->
-    <query_thread_log remove="remove" />
-    <text_log remove="remove" />
-    <trace_log remove="remove" />
-    <session_log remove="remove" />
-    <part_log remove="remove" />
-</clickhouse>

compose.override.yml

@@ -1,4 +0,0 @@
-services:
-  plausible:
-    ports:
-      - 127.0.0.1:84:80

compose.yml

@@ -1,88 +0,0 @@
-services:
-  plausible_db:
-    image: postgres:16-alpine
-    stop_grace_period: 60s
-    restart: always
-    volumes:
-      - ./data/postgres:/var/lib/postgresql/data
-    environment:
-      - POSTGRES_PASSWORD=postgres
-    healthcheck:
-      test: ["CMD-SHELL", "pg_isready -U postgres"]
-      start_interval: 2s
-      start_period: 1m
-
-  plausible_events_db:
-    image: clickhouse/clickhouse-server:24.3.3.102-alpine
-    stop_grace_period: 60s
-    restart: always
-    volumes:
-      - ./data/clickhouse:/var/lib/clickhouse
-      - ./data/clickhouse-logs:/var/log/clickhouse-server
-      - ./clickhouse/logs.xml:/etc/clickhouse-server/config.d/logs.xml:ro
-      # This makes ClickHouse bind to IPv4 only, since Docker doesn't enable IPv6 in bridge networks by default.
-      # Fixes "Listen [::]:9000 failed: Address family for hostname not supported" warnings.
-      - ./clickhouse/ipv4-only.xml:/etc/clickhouse-server/config.d/ipv4-only.xml:ro
-    ulimits:
-      nofile:
-        soft: 262144
-        hard: 262144
-    healthcheck:
-      test: ["CMD-SHELL", "wget --no-verbose --tries=1 --spider http://127.0.0.1:8123/ping || exit 1"]
-      start_interval: 2s
-      start_period: 1m
-
-  plausible:
-    image: ghcr.io/plausible/community-edition:v2.1.2
-    stop_grace_period: 60s
-    restart: always
-    command: sh -c "/entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh run"
-    depends_on:
-      plausible_db:
-        condition: service_healthy
-      plausible_events_db:
-        condition: service_healthy
-    volumes:
-      - ./data/plausible:/var/lib/plausible
-    ulimits:
-      nofile:
-        soft: 65535
-        hard: 65535
-    environment:
-      # required: https://github.com/plausible/community-edition/wiki/configuration#required
-      - BASE_URL=${BASE_URL}
-      - SECRET_KEY_BASE=${SECRET_KEY_BASE}
-      # optional: https://github.com/plausible/community-edition/wiki/configuration#optional
-      # registration: https://github.com/plausible/community-edition/wiki/configuration#registration
-      - TOTP_VAULT_KEY
-      - DISABLE_REGISTRATION
-      - ENABLE_EMAIL_VERIFICATION
-      # web: https://github.com/plausible/community-edition/wiki/configuration#web
-      - HTTP_PORT
-      - HTTPS_PORT
-      # databases: https://github.com/plausible/community-edition/wiki/configuration#database
-      - DATABASE_URL
-      - CLICKHOUSE_DATABASE_URL
-      # Google: https://github.com/plausible/community-edition/wiki/configuration#google
-      - GOOGLE_CLIENT_ID
-      - GOOGLE_CLIENT_SECRET
-      # geolocation: https://github.com/plausible/community-edition/wiki/configuration#ip-geolocation
-      - IP_GEOLOCATION_DB
-      - GEONAMES_SOURCE_FILE
-      - MAXMIND_LICENSE_KEY
-      - MAXMIND_EDITION
-      # email: https://github.com/plausible/community-edition/wiki/configuration#email
-      - MAILER_ADAPTER
-      - MAILER_EMAIL
-      - MAILER_NAME
-      - SMTP_HOST_ADDR
-      - SMTP_HOST_PORT
-      - SMTP_USER_NAME
-      - SMTP_USER_PWD
-      - SMTP_HOST_SSL_ENABLED
-      - POSTMARK_API_KEY
-      - MAILGUN_API_KEY
-      - MAILGUN_DOMAIN
-      - MAILGUN_BASE_URI
-      - MANDRILL_API_KEY
-      - SENDGRID_API_KEY

docker-compose.yml

@@ -0,0 +1,38 @@
+services:
+  plausible_db:
+    # Plausible v2.1.1 was tested against PostgreSQL versions 15 and 16
+    # https://github.com/plausible/analytics/blob/v2.1.1/.github/workflows/elixir.yml#L21-L32
+    image: postgres:16-alpine
+    stop_grace_period: 60s
+    restart: always
+    volumes:
+      - ./data/postgres:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_PASSWORD=postgres
+
+  plausible_events_db:
+    image: clickhouse/clickhouse-server:24.3.3.102-alpine
+    stop_grace_period: 60s
+    restart: always
+    volumes:
+      - ./data/clickhouse:/var/lib/clickhouse
+      - ./data/clickhouse-logs:/var/log/clickhouse-server
+      - ./clickhouse/clickhouse-config.xml:/etc/clickhouse-server/config.d/logging.xml:ro
+      - ./clickhouse/clickhouse-user-config.xml:/etc/clickhouse-server/users.d/logging.xml:ro
+    ulimits:
+      nofile:
+        soft: 262144
+        hard: 262144
+
+  plausible:
+    image: ghcr.io/plausible/community-edition:v2.1.1
+    stop_grace_period: 60s
+    restart: always
+    command: sh -c "sleep 10 && /entrypoint.sh db createdb && /entrypoint.sh db migrate && /entrypoint.sh run"
+    depends_on:
+      - plausible_db
+      - plausible_events_db
+    ports:
+      - 127.0.0.1:84:8000
+    env_file:
+      - .env

images/logo_dark.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 245.4992501 66.0242793"><defs><style>.cls-1{fill:url(#New_Gradient_Swatch_1);}.cls-1,.cls-2,.cls-3,.cls-4{stroke-width:0px;}.cls-2{fill:url(#New_Gradient_Swatch_1-2);}.cls-3{fill:#5850eb;}.cls-4{fill:#fff;}</style><linearGradient id="New_Gradient_Swatch_1" x1="14.8413403" y1="22.5436904" x2="27.4731407" y2="44.6493411" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#909cf7"/><stop offset="1" stop-color="#4b38d8"/></linearGradient><linearGradient id="New_Gradient_Swatch_1-2" x1="7.9837957" y1="-1.3582919" x2="21.0009873" y2="21.4217935" xlink:href="#New_Gradient_Swatch_1"/></defs><g id="Plausible_-_Branding"><g id="CE_Gradient_Logo_-_Color_Gradient_on_Black"><g id="Symbol_-_Purple_Gradient"><path class="cls-1" d="M45.2456059,22.6027536c-1.0911024,10.4557623-10.2327486,18.2272825-20.7452872,18.2272807h-4.047804v9.570007c0,5.3019285-4.2980623,9.5999908-9.5999908,9.5999908H3.3599854c-1.8556687,0-3.3599854-1.5043167-3.3599854-3.3599854v-19.7025146l5.0380685-7.0686343c.9118097-1.2793096,2.587965-1.7566996,4.0369945-1.1497867l2.8657142,1.2002785c1.4444817.6050081,3.1153774.12945,4.0247968-1.1455083l6.7172007-9.417163c.9071158-1.2717288,2.5743943-1.7450816,4.0144283-1.1397262l5.5198678,2.3204187c1.4430268.6066135,3.1137697.1319561,4.0223175-1.1427389l6.4594145-9.0625757c2.0248091,3.5597961,3.0145069,7.7887694,2.5468032,12.2706573Z"/><path class="cls-2" d="M3.2920959,28.8726296c.82329-1.1551271,2.0209115-2.0434967,3.4138697-2.3114381,1.0861554-.2089265,2.156905-.0992829,3.1472499.3155174l2.8649902,1.1999512c.1651001.0691528.3388672.104187.5164795.104187.4365845,0,.8488159-.2124634,1.1026611-.5683594l6.5942097-9.2447929c.8231505-1.154021,2.0204067-2.0410099,3.4124878-2.3083136,1.0821376-.2077892,2.1463585-.0989034,3.1282512.3138487l5.5198364,2.3204346c.1665649.0700684.3417969.1055298.5206909.1055298.4351807,0,.8456421-.2113647,1.0979614-.5653687l6.9192505-9.7077637C37.8272145,3.3644409,31.7802174,0,24.9450124,0H3.3599904C1.5043217,0,.000005,1.5043167.000005,3.3599854v30.1316528l3.2920909-4.6190085Z"/></g><path id="Tagline_-_Purple" class="cls-3" d="M67.839381,61.6763437c-1.0007553,0-1.9159114-.1711984-2.7467271-.5135952-.8295569-.3423968-1.5483384-.8333333-2.1538268-1.4728097-.6067472-.6382175-1.0775428-1.3960222-1.4136455-2.2721551-.3348439-.8761329-.5035247-1.8340886-.5035247-2.8751259,0-1.0020141.1774924-1.9297583.5337362-2.7870091.3562437-.8559919.8496979-1.6075025,1.4816213-2.2532729.6331823-.6445116,1.3708459-1.1455186,2.2142497-1.5017623.842145-.3549849,1.7585599-.5337362,2.7467271-.5337362.6722054,0,1.3242699.0994461,1.9561934.2970796s1.2122356.4707956,1.7396777.8194864c.5261833.3499496.9680262.755287,1.3230111,1.2160121l-1.6402316,1.7975831c-.3423968-.3549849-.694864-.6545821-1.056143-.8987915-.3625378-.2429507-.7389225-.427996-1.1266365-.5526183-.3889728-.1258812-.7880161-.1888218-1.1958711-.1888218-.6067472,0-1.1757301.1132931-1.7094663.3361027-.5337362.2240685-.9944612.541289-1.383434.949144s-.694864.8924975-.9189325,1.4526687-.3361027,1.1820242-.3361027,1.8668177c0,.6986405.1082578,1.3318228.3260322,1.8970292.2177744.5677241.5274421,1.0548842.929003,1.4627392.4015609.4091138.882427.7212991,1.4425982.9390735s1.1757301.3260322,1.8479355.3260322c.43429,0,.8559919-.0591641,1.2651057-.1774924.407855-.1195871.7867573-.2870091,1.1354481-.5047835.3499496-.2165156.668429-.4707956.9592145-.7603223l1.2638469,2.0354985c-.3159617.3549849-.7376636.6784995-1.2638469.9680262-.5274421.2895267-1.116566.5173716-1.7686304.6822759-.6520645.1636455-1.3016113.2467271-1.9473817.2467271ZM79.8157153,61.6763437c-1.0410373,0-1.9700403-.234139-2.7870091-.7011581-.8169688-.4682779-1.4614804-1.1102719-1.9360524-1.9272407s-.7112286-1.7459718-.7112286-2.7870091c0-1.0397784.2366566-1.9687815.7112286-2.7857503s1.1190836-1.4589627,1.9360524-1.9272407c.8169688-.4670191,1.7459718-.7011581,2.7870091-.7011581,1.0271903,0,1.9498993.234139,2.7668681.7011581.81571.4682779,1.4589627,1.1102719,1.9259819,1.9272407.4682779.8169688.7024169,1.7459718.7024169,2.7857503,0,1.0410373-.234139,1.9700403-.7024169,2.7870091-.4670191.8169688-1.1102719,1.4589627-1.9259819,1.9272407-.8169688.4670191-1.7396777.7011581-2.7668681.7011581ZM79.8157153,59.522517c.5664653,0,1.0699899-.1447633,1.5118328-.4355488.4405841-.2895267.7905337-.6772407,1.0473313-1.1656596.2567976-.4871601.3789023-1.0397784.3650554-1.6603726.0138469-.6319235-.1082578-1.1920947-.3650554-1.6792548s-.6067472-.8723565-1.0473313-1.1555891c-.4418429-.2832326-.9453676-.4254783-1.5118328-.4254783s-1.0775428.1422457-1.5319738.4254783-.8068983.6709466-1.0574018,1.1656596c-.2505035.4934542-.3751259,1.0511078-.3751259,1.6691843,0,.6205942.1246224,1.1732125.3751259,1.6603726.2505035.4884189.6029708.8761329,1.0574018,1.1656596.454431.2907855.9655086.4355488,1.5319738.4355488ZM87.344668,61.4787103v-10.414149h2.3917422l.0390232,2.0946626-.3952669.157351Line truncated

images/logo_light.svg

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><svg id="Layer_2" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" viewBox="0 0 245.4992501 66.0242793"><defs><style>.cls-1{fill:url(#New_Gradient_Swatch_1);}.cls-1,.cls-2,.cls-3,.cls-4{stroke-width:0px;}.cls-2{fill:url(#New_Gradient_Swatch_1-2);}.cls-3{fill:#5850eb;}.cls-4{fill:#1f2961;}</style><linearGradient id="New_Gradient_Swatch_1" x1="14.8413403" y1="22.5436904" x2="27.4731407" y2="44.6493411" gradientUnits="userSpaceOnUse"><stop offset="0" stop-color="#909cf7"/><stop offset="1" stop-color="#4b38d8"/></linearGradient><linearGradient id="New_Gradient_Swatch_1-2" x1="7.9837957" y1="-1.3582919" x2="21.0009873" y2="21.4217935" xlink:href="#New_Gradient_Swatch_1"/></defs><g id="Plausible_-_Branding"><g id="CE_Gradient_Logo_-_Purple_Gradient_on_White"><g id="Symbol_-_Purple_Gradient"><path class="cls-1" d="M45.2456059,22.6027536c-1.0911024,10.4557623-10.2327486,18.2272825-20.7452872,18.2272807h-4.047804v9.570007c0,5.3019285-4.2980623,9.5999908-9.5999908,9.5999908H3.3599854c-1.8556687,0-3.3599854-1.5043167-3.3599854-3.3599854v-19.7025146l5.0380685-7.0686343c.9118097-1.2793096,2.587965-1.7566996,4.0369945-1.1497867l2.8657142,1.2002785c1.4444817.6050081,3.1153774.12945,4.0247968-1.1455083l6.7172007-9.417163c.9071158-1.2717288,2.5743943-1.7450816,4.0144283-1.1397262l5.5198678,2.3204187c1.4430268.6066135,3.1137697.1319561,4.0223175-1.1427389l6.4594145-9.0625757c2.0248091,3.5597961,3.0145069,7.7887694,2.5468032,12.2706573Z"/><path class="cls-2" d="M3.2920959,28.8726296c.82329-1.1551271,2.0209115-2.0434967,3.4138697-2.3114381,1.0861554-.2089265,2.156905-.0992829,3.1472499.3155174l2.8649902,1.1999512c.1651001.0691528.3388672.104187.5164795.104187.4365845,0,.8488159-.2124634,1.1026611-.5683594l6.5942097-9.2447929c.8231505-1.154021,2.0204067-2.0410099,3.4124878-2.3083136,1.0821376-.2077892,2.1463585-.0989034,3.1282512.3138487l5.5198364,2.3204346c.1665649.0700684.3417969.1055298.5206909.1055298.4351807,0,.8456421-.2113647,1.0979614-.5653687l6.9192505-9.7077637C37.8272145,3.3644409,31.7802174,0,24.9450124,0H3.3599904C1.5043217,0,.000005,1.5043167.000005,3.3599854v30.1316528l3.2920909-4.6190085Z"/></g><path id="Tagline_-_Purple" class="cls-3" d="M67.839381,61.6763437c-1.0007553,0-1.9159114-.1711984-2.7467271-.5135952-.8295569-.3423968-1.5483384-.8333333-2.1538268-1.4728097-.6067472-.6382175-1.0775428-1.3960222-1.4136455-2.2721551-.3348439-.8761329-.5035247-1.8340886-.5035247-2.8751259,0-1.0020141.1774924-1.9297583.5337362-2.7870091.3562437-.8559919.8496979-1.6075025,1.4816213-2.2532729.6331823-.6445116,1.3708459-1.1455186,2.2142497-1.5017623.842145-.3549849,1.7585599-.5337362,2.7467271-.5337362.6722054,0,1.3242699.0994461,1.9561934.2970796s1.2122356.4707956,1.7396777.8194864c.5261833.3499496.9680262.755287,1.3230111,1.2160121l-1.6402316,1.7975831c-.3423968-.3549849-.694864-.6545821-1.056143-.8987915-.3625378-.2429507-.7389225-.427996-1.1266365-.5526183-.3889728-.1258812-.7880161-.1888218-1.1958711-.1888218-.6067472,0-1.1757301.1132931-1.7094663.3361027-.5337362.2240685-.9944612.541289-1.383434.949144s-.694864.8924975-.9189325,1.4526687-.3361027,1.1820242-.3361027,1.8668177c0,.6986405.1082578,1.3318228.3260322,1.8970292.2177744.5677241.5274421,1.0548842.929003,1.4627392.4015609.4091138.882427.7212991,1.4425982.9390735.5601712.2177744,1.1757301.3260322,1.8479355.3260322.43429,0,.8559919-.0591641,1.2651057-.1774924.407855-.1195871.7867573-.2870091,1.1354481-.5047835.3499496-.2165156.668429-.4707956.9592145-.7603223l1.2638469,2.0354985c-.3159617.3549849-.7376636.6784995-1.2638469.9680262-.5274421.2895267-1.116566.5173716-1.7686304.6822759-.6520645.1636455-1.3016113.2467271-1.9473817.2467271ZM79.8157153,61.6763437c-1.0410373,0-1.9700403-.234139-2.7870091-.7011581-.8169688-.4682779-1.4614804-1.1102719-1.9360524-1.9272407s-.7112286-1.7459718-.7112286-2.7870091c0-1.0397784.2366566-1.9687815.7112286-2.7857503s1.1190836-1.4589627,1.9360524-1.9272407c.8169688-.4670191,1.7459718-.7011581,2.7870091-.7011581,1.0271903,0,1.9498993.234139,2.7668681.7011581.81571.4682779,1.4589627,1.1102719,1.9259819,1.9272407.4682779.8169688.7024169,1.7459718.7024169,2.7857503,0,1.0410373-.234139,1.9700403-.7024169,2.7870091-.4670191.8169688-1.1102719,1.4589627-1.9259819,1.9272407-.8169688.4670191-1.7396777.7011581-2.7668681.7011581ZM79.8157153,59.522517c.5664653,0,1.0699899-.1447633,1.5118328-.4355488.4405841-.2895267.7905337-.6772407,1.0473313-1.1656596.2567976-.4871601.3789023-1.0397784.3650554-1.6603726.0138469-.6319235-.1082578-1.1920947-.3650554-1.6792548s-.6067472-.8723565-1.0473313-1.1555891c-.4418429-.2832326-.9453676-.4254783-1.5118328-.4254783s-1.0775428.1422457-1.5319738.4254783-.8068983.6709466-1.0574018,1.1656596c-.2505035.4934542-.3751259,1.0511078-.3751259,1.6691843,0,.6205942.1246224,1.1732125.3751259,1.6603726.2505035.4884189.6029708.8761329,1.0574018,1.1656596.454431.2907855.9655086.4355488,1.5319738.4355488ZM87.344668,61.4787103v-10.414149h2.3917422l.0390232,2.0946Line truncated

plausible-conf.env

@@ -0,0 +1,3 @@
+BASE_URL=replace-me
+SECRET_KEY_BASE=replace-me
+TOTP_VAULT_KEY=replace-me

reverse-proxy/README.md

@@ -0,0 +1,47 @@
+This directory contains pre-made configurations for various reverse proxies. Which flavor you should choose depends on your setup.
+
+## No existing reverse proxy
+
+If you aren't running an existing reverse proxy, then you can use the [`caddy-gen`](https://github.com/wemake-services/caddy-gen) based docker-compose file. Update it to include the domain name you use for your server, then combine it with the existing docker-compose files:
+
+```shell
+$ docker-compose -f docker-compose.yml -f reverse-proxy/docker-compose.caddy-gen.yml up
+```
+
+## Existing reverse proxy
+
+If you are already running a reverse proxy, then the above will not work as it will clash with the existing port bindings. You should instead use one of the available configuration files:
+
+### NGINX
+
+If you already have NGINX running as a system service, use the configuration file in the `nginx` directory.
+
+Edit the file `reverse-proxy/nginx/plausible` to contain the domain name you use for your server, then copy it into NGINX's configuration folder. Enable it by creating a symlink in NGINX's enabled sites folder. Finally use Certbot to create a TLS certificate for your site:
+
+```shell
+$ sudo cp reverse-proxy/nginx/plausible /etc/nginx/sites-available
+$ sudo ln -s /etc/nginx/sites-available/plausible /etc/nginx/sites-enabled/plausible
+$ sudo certbot --nginx
+```
+
+### Traefik 2
+
+If you already have a Traefik container running on Docker, use the docker-compose file in the `traefik` directory. Note that it assumes that your Traefik container is set up to support certificate generation.
+
+Edit the file `reverse-proxy/traefik/docker-compose.traefik.yml` to contain the domain name you use for your server, then combine it with the existing docker-compose files:
+
+```shell
+$ docker-compose -f docker-compose.yml -f reverse-proxy/traefik/docker-compose.traefik.yml up
+```
+
+### Apache2
+Install the necessary Apache modules and restart Apache. Edit the file `reverse-proxy/apache2/plausible.conf` to contain the domain name you use for your server, then copy it into Apache's configuration folder. Enable it by creating a symlink in Apache's enabled sites folder with `a2ensite` command. Finally use Certbot to create a TLS certificate for your site:
+
+```shell
+$ sudo a2enmod proxy proxy_http proxy_ajp remoteip headers proxy_wstunnel
+$ sudo systemctl restart apache2
+$ sudo cp reverse-proxy/apache2/plausible.conf /etc/apache2/sites-available/
+$ sudo a2ensite plausible.conf
+$ sudo systemctl restart apache2
+$ sudo certbot --apache
+```

reverse-proxy/apache2/plausible.conf

@@ -0,0 +1,20 @@
+<VirtualHost *:80>
+
+ ServerAdmin admin@example.com
+ ServerName example.com
+
+ ProxyPreserveHost On
+ ProxyAddHeaders On
+ ProxyPassMatch ^/(live/websocket)$  ws://localhost:8000/$1
+ ProxyPass / http://localhost:8000/
+ ProxyPassReverse / http://localhost:8000/
+
+ SetEnvIf X-Forwarded-For "^.*\..*\..*\..*" forwarded
+ LogFormat "%h %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" combined
+ LogFormat "%{X-Forwarded-For}i %l %u %t \"%r\" %>s %b \"%{Referer}i\" \"%{User-Agent}i\"" forwarded
+
+ ErrorLog ${APACHE_LOG_DIR}/error.log
+ CustomLog ${APACHE_LOG_DIR}/access.log combined env=!forwarded
+ CustomLog ${APACHE_LOG_DIR}/access.log forwarded env=forwarded
+    
+</VirtualHost>

reverse-proxy/docker-compose.caddy-gen.yml

@@ -0,0 +1,24 @@
+version: "3.3"
+services:
+  caddy-gen:
+    container_name: caddy-gen
+    image: "wemakeservices/caddy-gen:latest"
+    restart: always
+    volumes:
+      - /var/run/docker.sock:/tmp/docker.sock:ro
+      - caddy-certificates:/data/caddy
+    ports:
+      - "80:80"
+      - "443:443"
+    depends_on:
+      - plausible
+
+  plausible:
+    labels:
+      virtual.host: "example.com" # change to your domain name
+      virtual.port: "8000"
+      virtual.tls-email: "admin@example.com" # change to your email
+        
+volumes:
+    caddy-certificates:
+        driver: local

reverse-proxy/nginx/plausible

@@ -0,0 +1,19 @@
+server {
+	# replace example.com with your domain name
+	server_name example.com;
+	
+	listen 80;
+	listen [::]:80;
+
+	location / {
+		proxy_pass http://127.0.0.1:8000;
+		proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+
+		location = /live/websocket {
+			proxy_pass http://127.0.0.1:8000;
+			proxy_http_version 1.1;
+			proxy_set_header Upgrade $http_upgrade;
+			proxy_set_header Connection "Upgrade";
+		}
+	}
+}

reverse-proxy/traefik/docker-compose.traefik.yml

@@ -0,0 +1,8 @@
+version: "3.3"
+services:
+  plausible:
+    labels:
+      traefik.enable: "true"
+      traefik.http.routers.plausible.rule: "Host(`example.com`)" # change to your domain name
+      traefik.http.routers.plausible.entrypoints: "websecure"
+      traefik.http.services.plausible.loadbalancer.server.port: "8000"

upgrade/postgres.md

@@ -0,0 +1,159 @@
+Guide to upgrading PostgreSQL version `>= 12` to version `14` using `pg_dump` and `psql`. Based on [Upgrade a PostgreSQL database with docker.](https://hollo.me/devops/upgrade-postgresql-database-with-docker.html)
+
+**Note:** following this guide you'd need to stop some containers and it would make your plausible instance temporarily unavailable.
+
+---
+
+### Plan
+
+1. dump contents of the old version PostgreSQL to a file
+1. copy the dump to the host
+1. replace old version PostgreSQL with new version PostgreSQL
+1. copy and load the dump into new version PostgreSQL
+
+---
+
+### Steps
+
+1. Stop `plausible` to avoid writing to old `plausible_db`
+
+```console
+> docker compose stop plausible
+[+] Running 2/2
+ ⠿ Container hosting-plausible-1     Stopped           6.5s
+```
+
+2. Dump old `plausible_db` contents to a backup file
+
+```console
+> docker compose exec plausible_db sh -c "pg_dump -U postgres plausible_db > plausible_db.bak"
+```
+
+3. Copy the backup to the host
+
+```console
+> docker compose cp plausible_db:plausible_db.bak plausible_db.bak
+```
+
+4. (Optional) verify backup went OK
+
+```console
+> head plausible_db.bak
+--
+-- PostgreSQL database dump
+--
+
+-- Dumped from database version 12.12 (Debian 12.12-1.pgdg110+1)
+-- Dumped by pg_dump version 12.12 (Debian 12.12-1.pgdg110+1)
+
+SET statement_timeout = 0;
+SET lock_timeout = 0;
+SET idle_in_transaction_session_timeout = 0;
+```
+
+5. Edit `docker-compose.yml` to use new PostgreSQL version, here we update from `v12` to `v14`, alpine flavour.
+
+```diff
+  plausible_db:
+-   image: postgres:12
++   image: postgres:14-alpine
+    restart: always
+    volumes:
+      - db-data:/var/lib/postgresql/data
+    environment:
+      - POSTGRES_PASSWORD=postgres
+```
+
+6. Ensure relevant containers are stopped
+
+```console
+> docker compose stop plausible plausible_db
+[+] Running 2/2
+ ⠿ Container hosting-plausible-1     Stopped           0.0s
+ ⠿ Container hosting-plausible_db-1  Stopped           0.2s
+```
+
+7. Remove old `plausible_db` container to be able to nuke its volume in the next step
+
+```console
+> docker compose rm plausible_db
+? Going to remove hosting-plausible_db-1 Yes
+[+] Running 1/0
+ ⠿ Container hosting-plausible_db-1  Removed           0.0s
+```
+
+8. Remove old `plausible_db` volume, mine is named `hosting_db-data`
+
+```console
+> docker volume ls
+DRIVER    VOLUME NAME
+<...snip...>
+local     hosting_db-data
+local     hosting_event-data
+<...snip...>
+
+> docker volume rm hosting_db-data
+hosting_db-data
+```
+
+9. Start new version `plausible_db` container
+
+```console
+> docker compose up plausible_db -d
+[+] Running 9/9
+ ⠿ plausible_db Pulled                                 9.3s
+   ⠿ 9b18e9b68314 Already exists                       0.0s
+   ⠿ 75aada9edfc5 Pull complete                        1.2s
+   ⠿ 820773693750 Pull complete                        1.2s
+   ⠿ 8812bb04ef2e Pull complete                        5.2s
+   ⠿ 2ccec0f7805c Pull complete                        5.2s
+   ⠿ 833f9b98598e Pull complete                        5.3s
+   ⠿ 1eb578dc04e6 Pull complete                        5.4s
+   ⠿ c873bf6204df Pull complete                        5.4s
+[+] Running 2/2
+ ⠿ Volume "hosting_db-data"          Created           0.0s
+ ⠿ Container hosting-plausible_db-1  Started           0.5s
+```
+
+10. Create new DB and load data into it
+
+```console
+> docker compose exec plausible_db createdb -U postgres plausible_db
+> docker compose cp plausible_db.bak plausible_db:plausible_db.bak
+
+> docker compose exec plausible_db sh -c "psql -U postgres -d plausible_db < plausible_db.bak"
+SET
+SET
+SET
+SET
+SET
+ set_config
+------------
+
+(1 row)
+
+SET
+SET
+SET
+SET
+CREATE EXTENSION
+<...snip...>
+```
+
+11. Start all other containers
+
+```console
+> docker compose up -d
+[+] Running 4/4
+ ⠿ Container hosting-plausible_events_db-1  Running           0.0s
+ ⠿ Container hosting-mail-1                 Running           0.0s
+ ⠿ Container hosting-plausible_db-1         Started           0.5s
+ ⠿ Container hosting-plausible-1            Started           0.5s
+```
+
+12. (Optional) Remove backups from the container and the host
+
+```console
+> rm plausible_db.bak
+> docker compose exec plausible_db rm plausible_db.bak
+```