diff --git a/.gitignore b/.gitignore index 1097480..e69de29 100644 --- a/.gitignore +++ b/.gitignore @@ -1,5 +0,0 @@ -* -!compose.example.yml -!README.md -!./clickhouse/** -!.gitignore diff --git a/.prettierignore b/.prettierignore deleted file mode 100644 index 72e8ffc..0000000 --- a/.prettierignore +++ /dev/null @@ -1 +0,0 @@ -* diff --git a/compose.example.yml b/compose.example.yml index 76e9ad4..6be1c5f 100644 --- a/compose.example.yml +++ b/compose.example.yml @@ -33,24 +33,20 @@ services: - 80:8000 - 443:8001 volumes: - - plausible-tmp:/tmp + - plausible-data:/var/lib/plausible environment: - BASE_URL=replace-me - SECRET_KEY_BASE=replace-me - TOTP_VAULT_KEY=replace-me - - DATA_DIR=/tmp + - DATA_DIR=/var/lib/plausible - SITE_ENCRYPT_DIRECTORY_URL=https://acme-v02.api.letsencrypt.org/directory - - SITE_ENCRYPT_DB_FOLDER=/tmp/site_encrypt_db + - SITE_ENCRYPT_DB_FOLDER=/var/lib/plausible/site_encrypt_db - SITE_ENCRYPT_MODE=auto - SITE_ENCRYPT_CLIENT=certbot - LOG_LEVEL=notice volumes: db-data: - driver: local event-data: - driver: local event-logs: - driver: local - plausible-tmp: - driver: local + plausible-data: diff --git a/images/0-google-cloud.png b/images/0-google-cloud.png deleted file mode 100644 index 448cb70..0000000 Binary files a/images/0-google-cloud.png and /dev/null differ diff --git a/images/1-project-create.png b/images/1-project-create.png deleted file mode 100644 index 93cad14..0000000 Binary files a/images/1-project-create.png and /dev/null differ diff --git a/images/1-project-created.png b/images/1-project-created.png deleted file mode 100644 index 6177505..0000000 Binary files a/images/1-project-created.png and /dev/null differ diff --git a/images/1-project-new.png b/images/1-project-new.png deleted file mode 100644 index 7ac4f41..0000000 Binary files a/images/1-project-new.png and /dev/null differ diff --git a/images/1-project-select.png b/images/1-project-select.png deleted file mode 100644 index 15a59e6..0000000 Binary files a/images/1-project-select.png and /dev/null differ diff --git a/images/2-app-registration-api-and-services-pick.png b/images/2-app-registration-api-and-services-pick.png deleted file mode 100644 index fd0d757..0000000 Binary files a/images/2-app-registration-api-and-services-pick.png and /dev/null differ diff --git a/images/2-app-registration-consent-screen-0.png b/images/2-app-registration-consent-screen-0.png deleted file mode 100644 index ad60bbe..0000000 Binary files a/images/2-app-registration-consent-screen-0.png and /dev/null differ diff --git a/images/2-app-registration-consent-screen-1.png b/images/2-app-registration-consent-screen-1.png deleted file mode 100644 index 9ed6cdb..0000000 Binary files a/images/2-app-registration-consent-screen-1.png and /dev/null differ diff --git a/images/2-app-registration-external.png b/images/2-app-registration-external.png deleted file mode 100644 index 2a6a1de..0000000 Binary files a/images/2-app-registration-external.png and /dev/null differ diff --git a/images/2-app-registration-pick.png b/images/2-app-registration-pick.png deleted file mode 100644 index b163059..0000000 Binary files a/images/2-app-registration-pick.png and /dev/null differ diff --git a/images/2-app-registration-scopes-skip.png b/images/2-app-registration-scopes-skip.png deleted file mode 100644 index f5d2e06..0000000 Binary files a/images/2-app-registration-scopes-skip.png and /dev/null differ diff --git a/images/2-app-registration-test-users.png b/images/2-app-registration-test-users.png deleted file mode 100644 index 2e6a02c..0000000 Binary files a/images/2-app-registration-test-users.png and /dev/null differ diff --git a/images/3-oauth-client-create.png b/images/3-oauth-client-create.png deleted file mode 100644 index 9f138a9..0000000 Binary files a/images/3-oauth-client-create.png and /dev/null differ diff --git a/images/3-oauth-client-created.png b/images/3-oauth-client-created.png deleted file mode 100644 index 95d2e47..0000000 Binary files a/images/3-oauth-client-created.png and /dev/null differ diff --git a/images/3-oauth-client-credentials-pick.png b/images/3-oauth-client-credentials-pick.png deleted file mode 100644 index 979c307..0000000 Binary files a/images/3-oauth-client-credentials-pick.png and /dev/null differ diff --git a/images/3-oauth-client-pick.png b/images/3-oauth-client-pick.png deleted file mode 100644 index 33ea3d8..0000000 Binary files a/images/3-oauth-client-pick.png and /dev/null differ diff --git a/images/4-search-console-new.png b/images/4-search-console-new.png deleted file mode 100644 index a637a1a..0000000 Binary files a/images/4-search-console-new.png and /dev/null differ diff --git a/images/4-search-console-verified.png b/images/4-search-console-verified.png deleted file mode 100644 index 00dac29..0000000 Binary files a/images/4-search-console-verified.png and /dev/null differ diff --git a/images/4-search-console-verify.png b/images/4-search-console-verify.png deleted file mode 100644 index 170d8f9..0000000 Binary files a/images/4-search-console-verify.png and /dev/null differ diff --git a/images/5-search-console-api-enable.png b/images/5-search-console-api-enable.png deleted file mode 100644 index 288b70c..0000000 Binary files a/images/5-search-console-api-enable.png and /dev/null differ diff --git a/images/5-search-console-api-search.png b/images/5-search-console-api-search.png deleted file mode 100644 index e12c380..0000000 Binary files a/images/5-search-console-api-search.png and /dev/null differ diff --git a/images/6-choose-google-account.png b/images/6-choose-google-account.png deleted file mode 100644 index 825cd36..0000000 Binary files a/images/6-choose-google-account.png and /dev/null differ diff --git a/images/6-continue.png b/images/6-continue.png deleted file mode 100644 index 6d0124b..0000000 Binary files a/images/6-continue.png and /dev/null differ diff --git a/images/6-data-continue.png b/images/6-data-continue.png deleted file mode 100644 index 801bac6..0000000 Binary files a/images/6-data-continue.png and /dev/null differ diff --git a/images/6-data-import.png b/images/6-data-import.png deleted file mode 100644 index 9ceb97c..0000000 Binary files a/images/6-data-import.png and /dev/null differ diff --git a/images/6-enabled-apis.png b/images/6-enabled-apis.png deleted file mode 100644 index 6afbdc4..0000000 Binary files a/images/6-enabled-apis.png and /dev/null differ diff --git a/images/6-import-continue.png b/images/6-import-continue.png deleted file mode 100644 index 09d1ab9..0000000 Binary files a/images/6-import-continue.png and /dev/null differ diff --git a/images/6-import.png b/images/6-import.png deleted file mode 100644 index 799392b..0000000 Binary files a/images/6-import.png and /dev/null differ diff --git a/images/6-pick-view.png b/images/6-pick-view.png deleted file mode 100644 index 97dd473..0000000 Binary files a/images/6-pick-view.png and /dev/null differ diff --git a/images/6-plausible-settings-pick.png b/images/6-plausible-settings-pick.png deleted file mode 100644 index 25d395a..0000000 Binary files a/images/6-plausible-settings-pick.png and /dev/null differ diff --git a/images/6-plausible-settings-search-console.png b/images/6-plausible-settings-search-console.png deleted file mode 100644 index 7ce596c..0000000 Binary files a/images/6-plausible-settings-search-console.png and /dev/null differ diff --git a/images/6-property.png b/images/6-property.png deleted file mode 100644 index dbdf618..0000000 Binary files a/images/6-property.png and /dev/null differ diff --git a/images/6-sign-in-copycat.png b/images/6-sign-in-copycat.png deleted file mode 100644 index f9abb6a..0000000 Binary files a/images/6-sign-in-copycat.png and /dev/null differ diff --git a/images/6-view-search-console-data.png b/images/6-view-search-console-data.png deleted file mode 100644 index e38fc95..0000000 Binary files a/images/6-view-search-console-data.png and /dev/null differ diff --git a/images/7-analytics-admin-api-enable.png b/images/7-analytics-admin-api-enable.png deleted file mode 100644 index fc98bcf..0000000 Binary files a/images/7-analytics-admin-api-enable.png and /dev/null differ diff --git a/images/7-analytics-admin-api-search.png b/images/7-analytics-admin-api-search.png deleted file mode 100644 index 763d16e..0000000 Binary files a/images/7-analytics-admin-api-search.png and /dev/null differ diff --git a/images/7-analytics-api-enable.png b/images/7-analytics-api-enable.png deleted file mode 100644 index acfde35..0000000 Binary files a/images/7-analytics-api-enable.png and /dev/null differ diff --git a/images/7-analytics-api-search.png b/images/7-analytics-api-search.png deleted file mode 100644 index 0a7950b..0000000 Binary files a/images/7-analytics-api-search.png and /dev/null differ diff --git a/images/7-analytics-data-api-enable.png b/images/7-analytics-data-api-enable.png deleted file mode 100644 index 7f25f08..0000000 Binary files a/images/7-analytics-data-api-enable.png and /dev/null differ diff --git a/images/7-analytics-data-api-search.png b/images/7-analytics-data-api-search.png deleted file mode 100644 index 043adb1..0000000 Binary files a/images/7-analytics-data-api-search.png and /dev/null differ diff --git a/images/7-analytics-reporting-api-enable.png b/images/7-analytics-reporting-api-enable.png deleted file mode 100644 index a1aa088..0000000 Binary files a/images/7-analytics-reporting-api-enable.png and /dev/null differ diff --git a/images/7-analytics-reporting-api-search.png b/images/7-analytics-reporting-api-search.png deleted file mode 100644 index 1b65b7b..0000000 Binary files a/images/7-analytics-reporting-api-search.png and /dev/null differ diff --git a/images/logo_dark.svg b/images/logo_dark.svg deleted file mode 100644 index a5e0dfb..0000000 --- a/images/logo_dark.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/images/logo_light.svg b/images/logo_light.svg deleted file mode 100644 index afa776d..0000000 --- a/images/logo_light.svg +++ /dev/null @@ -1 +0,0 @@ - diff --git a/upgrade/postgres.md b/upgrade/postgres.md deleted file mode 100644 index c57d97a..0000000 --- a/upgrade/postgres.md +++ /dev/null @@ -1,159 +0,0 @@ -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 -```