diff --git a/README.md b/README.md index 451cae1..9829107 100644 --- a/README.md +++ b/README.md @@ -40,6 +40,12 @@ The aims is to provide a ready-to-run recipes that you can just copy, paste and +# Analytics +- [Matomo](apps/analytics/matomo.md) +- [Umami](apps/analytics/umami.md) + + + # Antivirus - [MalwareMultiScan](https://github.com/mindcollapse/MalwareMultiScan) 🔗 diff --git a/apps/analytics/matomo.md b/apps/analytics/matomo.md new file mode 100644 index 0000000..e2c1220 --- /dev/null +++ b/apps/analytics/matomo.md @@ -0,0 +1,48 @@ +# Matomo + +## Overview + +- no dark theme +- pretty complex +- can be private when setup that way +- lots of stats & metrics + +
+ +- [Homepage](https://matomo.org) +- [Github repo](https://github.com/matomo-org/docker) + + +## `docker-compose.yml` +```yml +--- +services: + db: + image: mariadb + command: --max-allowed-packet=64MB + restart: unless-stopped + environment: + MYSQL_ROOT_PASSWORD: matomo + MYSQL_USER: matomo + MYSQL_PASSWORD: matomo + MYSQL_DATABASE: matomo + MARIADB_AUTO_UPGRADE: 1 + MARIADB_INITDB_SKIP_TZINFO: 1 + volumes: + - ./db:/var/lib/mysql + + app: + image: matomo + restart: unless-stopped + environment: + MATOMO_DATABASE_HOST: db + MATOMO_DATABASE_ADAPTER: mysql + MATOMO_DATABASE_TABLES_PREFIX: + MATOMO_DATABASE_USERNAME: matomo + MATOMO_DATABASE_PASSWORD: matomo + MATOMO_DATABASE_DBNAME: matomo + ports: + - 3000:80 + volumes: + - ./data:/var/www/html +``` diff --git a/apps/analytics/umami.md b/apps/analytics/umami.md new file mode 100644 index 0000000..a1340dd --- /dev/null +++ b/apps/analytics/umami.md @@ -0,0 +1,133 @@ +# Umami + +## Overview + +- very simplistic +- very private (doesn't track much, only the anonymised vitals) +- one page view +- nice dark theme + +
+ +- [Homepage](https://umami.is) +- [Docs](https://umami.is/docs/) +- [Github repo](https://github.com/umami-software/umami) +- [Setup tutorial blog post](https://noted.lol/umami-a-self-hosted-privacy-focused-analytics-platform/) + + +## `schema.postgresql.sql` +Original here: [schema.postgresql.sql](https://github.com/umami-software/umami/blob/master/sql/schema.postgresql.sql). + +```sql +CREATE TABLE "account" ( + "user_id" SERIAL NOT NULL, + "username" VARCHAR(255) NOT NULL, + "password" VARCHAR(60) NOT NULL, + "is_admin" BOOLEAN NOT NULL DEFAULT false, + "created_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP, + "updated_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP, + PRIMARY KEY ("user_id") +); +CREATE TABLE "event" ( + "event_id" SERIAL NOT NULL, + "website_id" INTEGER NOT NULL, + "session_id" INTEGER NOT NULL, + "created_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP, + "url" VARCHAR(500) NOT NULL, + "event_type" VARCHAR(50) NOT NULL, + "event_value" VARCHAR(50) NOT NULL, + PRIMARY KEY ("event_id") +); +CREATE TABLE "pageview" ( + "view_id" SERIAL NOT NULL, + "website_id" INTEGER NOT NULL, + "session_id" INTEGER NOT NULL, + "created_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP, + "url" VARCHAR(500) NOT NULL, + "referrer" VARCHAR(500), + PRIMARY KEY ("view_id") +); +CREATE TABLE "session" ( + "session_id" SERIAL NOT NULL, + "session_uuid" UUID NOT NULL, + "website_id" INTEGER NOT NULL, + "created_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP, + "hostname" VARCHAR(100), + "browser" VARCHAR(20), + "os" VARCHAR(20), + "device" VARCHAR(20), + "screen" VARCHAR(11), + "language" VARCHAR(35), + "country" CHAR(2), + PRIMARY KEY ("session_id") +); +CREATE TABLE "website" ( + "website_id" SERIAL NOT NULL, + "website_uuid" UUID NOT NULL, + "user_id" INTEGER NOT NULL, + "name" VARCHAR(100) NOT NULL, + "domain" VARCHAR(500), + "share_id" VARCHAR(64), + "created_at" TIMESTAMPTZ(6) DEFAULT CURRENT_TIMESTAMP, + PRIMARY KEY ("website_id") +); +CREATE UNIQUE INDEX "account.username_unique" ON "account"("username"); +CREATE INDEX "event_created_at_idx" ON "event"("created_at"); +CREATE INDEX "event_session_id_idx" ON "event"("session_id"); +CREATE INDEX "event_website_id_idx" ON "event"("website_id"); +CREATE INDEX "pageview_created_at_idx" ON "pageview"("created_at"); +CREATE INDEX "pageview_session_id_idx" ON "pageview"("session_id"); +CREATE INDEX "pageview_website_id_created_at_idx" ON "pageview"("website_id", "created_at"); +CREATE INDEX "pageview_website_id_idx" ON "pageview"("website_id"); +CREATE INDEX "pageview_website_id_session_id_created_at_idx" ON "pageview"("website_id", "session_id", "created_at"); +CREATE UNIQUE INDEX "session.session_uuid_unique" ON "session"("session_uuid"); +CREATE INDEX "session_created_at_idx" ON "session"("created_at"); +CREATE INDEX "session_website_id_idx" ON "session"("website_id"); +CREATE UNIQUE INDEX "website.website_uuid_unique" ON "website"("website_uuid"); +CREATE UNIQUE INDEX "website.share_id_unique" ON "website"("share_id"); +CREATE INDEX "website_user_id_idx" ON "website"("user_id"); +ALTER TABLE "event" ADD FOREIGN KEY ("session_id") REFERENCES "session"("session_id") ON DELETE CASCADE ON UPDATE CASCADE; +ALTER TABLE "event" ADD FOREIGN KEY ("website_id") REFERENCES "website"("website_id") ON DELETE CASCADE ON UPDATE CASCADE; +ALTER TABLE "pageview" ADD FOREIGN KEY ("session_id") REFERENCES "session"("session_id") ON DELETE CASCADE ON UPDATE CASCADE; +ALTER TABLE "pageview" ADD FOREIGN KEY ("website_id") REFERENCES "website"("website_id") ON DELETE CASCADE ON UPDATE CASCADE; +ALTER TABLE "session" ADD FOREIGN KEY ("website_id") REFERENCES "website"("website_id") ON DELETE CASCADE ON UPDATE CASCADE; +ALTER TABLE "website" ADD FOREIGN KEY ("user_id") REFERENCES "account"("user_id") ON DELETE CASCADE ON UPDATE CASCADE; +INSERT INTO account (username, password, is_admin) values ('admin', '$2b$10$BUli0c.muyCW1ErNJc3jL.vFRFtFJWrT8/GcR4A.sUdCznaXiqFXa', true); +``` + +## `docker-compose.yml` + +Original here: [docker-compose.yml](https://github.com/umami-software/umami/blob/master/docker-compose.yml). + +```yml +--- +services: + db: + image: postgres:12-alpine + container_name: umami-db + restart: unless-stopped + environment: + POSTGRES_DB: umami + POSTGRES_USER: umami + POSTGRES_PASSWORD: umami + volumes: + - ./schema.postgresql.sql:/docker-entrypoint-initdb.d/schema.postgresql.sql:ro + - ./db:/var/lib/postgresql/data + + umami: + image: ghcr.io/umami-software/umami:postgresql-latest + container_name: umami + restart: unless-stopped + environment: + DATABASE_URL: postgresql://umami:umami@db:5432/umami + DATABASE_TYPE: postgresql + HASH_SALT: Q6VsXKweJK6sn1yk6euTWFV2U2WGjN + depends_on: + - db + ports: + - 3000:3000 +``` + +Open `:3000` and login with: +u: admin +p: umami