Create LICENSE

allow ws proxying in nginx

.prettierignore

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

LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Plausible Analytics
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

docker-compose.yml

@@ -1,12 +1,8 @@
-version: "3.3"
 services:
-  mail:
-    image: bytemark/smtp
-    restart: always
-
   plausible_db:
-    # supported versions are 12, 13, and 14
-    image: postgres:14-alpine
+    # Plausible v2.1.0 was tested against PostgreSQL versions 15 and 16
+    # https://github.com/plausible/analytics/blob/v2.1.0/.github/workflows/elixir.yml#L21-L32
+    image: postgres:16-alpine
     restart: always
     volumes:
       - db-data:/var/lib/postgresql/data
@@ -14,10 +10,11 @@ services:
       - POSTGRES_PASSWORD=postgres
 
   plausible_events_db:
-    image: clickhouse/clickhouse-server:23.3.7.5-alpine
+    image: clickhouse/clickhouse-server:24.3.3.102-alpine
     restart: always
     volumes:
       - event-data:/var/lib/clickhouse
+      - event-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:
@@ -26,15 +23,14 @@ services:
         hard: 262144
 
   plausible:
-    image: plausible/analytics:v2.0
+    image: ghcr.io/plausible/community-edition:v2.1.0
     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
-      - mail
     ports:
-      - 8000:8000
+      - 127.0.0.1:8000:8000
     env_file:
       - plausible-conf.env
 
@@ -43,3 +39,5 @@ volumes:
     driver: local
   event-data:
     driver: local
+  event-logs:
+    driver: local

plausible-conf.env

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

reverse-proxy/README.md

@@ -38,7 +38,7 @@ $ docker-compose -f docker-compose.yml -f reverse-proxy/traefik/docker-compose.t
 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
+$ 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

reverse-proxy/nginx/plausible

@@ -8,5 +8,12 @@ server {
 	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";
+		}
 	}
 }

upgrade/postgres.md

@@ -6,57 +6,39 @@ Guide to upgrading PostgreSQL version `>= 12` to version `14` using `pg_dump` an
 
 ### Plan
 
-1. dump contents of the old version PostgreSQL to a file in a mounted volume
+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. load dump from the mounted volume into new version PostgreSQL
+1. copy and load the dump into new version PostgreSQL
 
 ---
 
 ### Steps
 
-1. Add a backup volume to `plausible_db` in your `docker-compose.yml`
-
-```diff
-  plausible_db:
-    image: postgres:12
-    restart: always
-    volumes:
-      - db-data:/var/lib/postgresql/data
-+     - ./backup:/backup
-    environment:
-      - POSTGRES_PASSWORD=postgres
-```
-
-2. Stop relevant containers to avoid writing to old `plausible_db`
+1. Stop `plausible` to avoid writing to old `plausible_db`
 
 ```console
-> docker compose stop plausible plausible_db
+> docker compose stop plausible
 [+] Running 2/2
  ⠿ Container hosting-plausible-1     Stopped           6.5s
- ⠿ Container hosting-plausible_db-1  Stopped           0.2s
 ```
 
-3. Restart `plausible_db` container to attach volume
+2. Dump old `plausible_db` contents to a backup file
 
 ```console
-> docker compose up plausible_db -d
-[+] Running 1/1
- ⠿ Container hosting-plausible_db-1  Started           0.3s
+> docker compose exec plausible_db sh -c "pg_dump -U postgres plausible_db > plausible_db.bak"
 ```
 
-4. Dump old `plausible_db` contents to a backup file
+3. Copy the backup to the host
 
 ```console
-> docker compose exec plausible_db sh -c "pg_dump -U postgres plausible_db > /backup/plausible_db.bak"
+> docker compose cp plausible_db:plausible_db.bak plausible_db.bak
 ```
 
-5. (Optional) verify backup went OK
+4. (Optional) verify backup went OK
 
 ```console
-> ls backup
-plausible_db.bak
-
-> head backup/plausible_db.bak
+> head plausible_db.bak
 --
 -- PostgreSQL database dump
 --
@@ -69,7 +51,7 @@ SET lock_timeout = 0;
 SET idle_in_transaction_session_timeout = 0;
 ```
 
-6. Edit `docker-compose.yml` to use new PostgreSQL version, here we update from `v12` to `v14`, alpine flavour.
+5. Edit `docker-compose.yml` to use new PostgreSQL version, here we update from `v12` to `v14`, alpine flavour.
 
 ```diff
   plausible_db:
@@ -78,12 +60,11 @@ SET idle_in_transaction_session_timeout = 0;
     restart: always
     volumes:
       - db-data:/var/lib/postgresql/data
-      - ./backup:/backup
     environment:
       - POSTGRES_PASSWORD=postgres
 ```
 
-7. Ensure relevant containers are stopped
+6. Ensure relevant containers are stopped
 
 ```console
 > docker compose stop plausible plausible_db
@@ -92,7 +73,7 @@ SET idle_in_transaction_session_timeout = 0;
  ⠿ Container hosting-plausible_db-1  Stopped           0.2s
 ```
 
-8. Remove old `plausible_db` container to be able to nuke its volume in the next step
+7. Remove old `plausible_db` container to be able to nuke its volume in the next step
 
 ```console
 > docker compose rm plausible_db
@@ -101,7 +82,7 @@ SET idle_in_transaction_session_timeout = 0;
  ⠿ Container hosting-plausible_db-1  Removed           0.0s
 ```
 
-9. Remove old `plausible_db` volume, mine is named `hosting_db-data`
+8. Remove old `plausible_db` volume, mine is named `hosting_db-data`
 
 ```console
 > docker volume ls
@@ -115,7 +96,7 @@ local     hosting_event-data
 hosting_db-data
 ```
 
-10. Start new version `plausible_db` container
+9. Start new version `plausible_db` container
 
 ```console
 > docker compose up plausible_db -d
@@ -134,12 +115,13 @@ hosting_db-data
  ⠿ Container hosting-plausible_db-1  Started           0.5s
 ```
 
-11. Create new DB and load data into it
+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 < /backup/plausible_db.bak"
+> docker compose exec plausible_db sh -c "psql -U postgres -d plausible_db < plausible_db.bak"
 SET
 SET
 SET
@@ -158,7 +140,7 @@ CREATE EXTENSION
 <...snip...>
 ```
 
-12. Start all other containers
+11. Start all other containers
 
 ```console
 > docker compose up -d
@@ -169,19 +151,9 @@ CREATE EXTENSION
  ⠿ Container hosting-plausible-1            Started           0.5s
 ```
 
-13. (Optional) Remove backups from `docker-compose.yml` and your filesystem
+12. (Optional) Remove backups from the container and the host
 
-```diff
-  plausible_db:
-    image: postgres:14-alpine
-    restart: always
-    volumes:
-      - db-data:/var/lib/postgresql/data
--     - ./backup:/backup
-    environment:
-      - POSTGRES_PASSWORD=postgres
-```
-
-```
-> rm -rf ./backup
+```console
+> rm plausible_db.bak
+> docker compose exec plausible_db rm plausible_db.bak
 ```