Analytodon selbst hosten

Analytodon ist Open Source unter GPL-3.0. Sie können Ihre eigene Instanz betreiben und behalten die volle Kontrolle über Ihre Daten und Infrastruktur.

Architekturübersicht

Analytodon besteht aus folgenden Komponenten:

• Backend (REST API) – NestJS-Anwendung für Authentifizierung, Datenverarbeitung und den Mastodon-OAuth-Flow
• Frontend (Web App) – Remix-Anwendung für das Analytics-Dashboard
• CLI (Cron Jobs) – oclif-basiertes Tool für die automatische Datensynchronisation mit Mastodon
• MongoDB – Datenbank zur Speicherung von Kontodaten, Post-Metriken und Analysehistorie
• SMTP (optional) – Zum Versenden von E-Mail-Berichten

Ein Reverse Proxy (Caddy, nginx oder Traefik) wird in der Produktion benötigt – nur das Frontend muss öffentlich erreichbar sein.

Voraussetzungen

• Docker und Docker Compose
• Ein Domainname mit DNS-Eintrag auf Ihren Server
• Ein Reverse Proxy (Caddy, nginx oder Traefik)
• (Optional) SMTP-Zugangsdaten für E-Mail-Berichte

Secrets generieren

Analytodon benötigt drei kryptografische Secrets. Generieren Sie diese direkt in eine .env-Datei, bevor Sie fortfahren – so gelangen die Werte nicht in Ihre Zwischenablage oder Terminal-Historie:

# AES-256 Encryption Key (64-stellig, hex) – schützt OAuth-Tokens
echo "ENCRYPTION_KEY=$(openssl rand -hex 32)" >> .env

# JWT Secret – signiert Access-Tokens
echo "JWT_SECRET=$(openssl rand -base64 48)" >> .env

# Session Secret – Frontend-Session-Cookies
echo "SESSION_SECRET=$(openssl rand -base64 48)" >> .env

Docker Compose

Erstellen Sie eine docker-compose.yml mit folgender Konfiguration:

services:
  backend:
    image: ghcr.io/blazer82/analytodon-backend:latest
    environment:
      - JWT_SECRET=${JWT_SECRET}
      - JWT_EXPIRES_IN=1h
      - JWT_REFRESH_TOKEN_EXPIRES_IN=7d
      - DB_CLIENT_URL=mongodb://mongo:27017/analytodon
      - MASTODON_APP_NAME=Analytodon
      - FRONTEND_URL=https://ihre-domain.de
      - MARKETING_URL=https://ihre-domain.de
      - ENCRYPTION_KEY=${ENCRYPTION_KEY}
    depends_on:
      - mongo
    restart: unless-stopped

  frontend:
    image: ghcr.io/blazer82/analytodon-frontend:latest
    ports:
      - "127.0.0.1:3002:3002"
    environment:
      - API_URL=http://backend:3000
      - SESSION_SECRET=${SESSION_SECRET}
      - MARKETING_URL=https://ihre-domain.de
    depends_on:
      - backend
    restart: unless-stopped

  cli:
    image: ghcr.io/blazer82/analytodon-cli:latest
    environment:
      - MONGODB_URI=mongodb://mongo:27017
      - MONGODB_DATABASE=analytodon
      - ENCRYPTION_KEY=${ENCRYPTION_KEY}
      - APP_URL=https://ihre-domain.de
    depends_on:
      - mongo
    restart: unless-stopped

  mongo:
    image: mongo:8
    volumes:
      - mongo-data:/data/db
    restart: unless-stopped

volumes:
  mongo-data:

Die Compose-Datei liest diese Secrets aus der zuvor erzeugten .env-Datei (siehe Abschnitt „Umgebungsdatei“ weiter unten).

Umgebungsdatei

Der Schritt „Secrets generieren“ hat Ihre drei Secrets bereits in eine .env-Datei geschrieben. Belassen Sie sie im selben Verzeichnis wie Ihre docker-compose.yml – Docker Compose liest die Variablen automatisch daraus und setzt sie für die ${...}-Platzhalter in der Compose-Datei ein. Die Datei sieht so aus:

# Generierte Secrets (siehe Secrets generieren)
ENCRYPTION_KEY=ihr-64-stelliger-hex-schluessel
JWT_SECRET=ihr-jwt-secret
SESSION_SECRET=ihr-session-secret

Für E-Mail-Berichte und weitere Konfigurationsoptionen lesen Sie die Umgebungsvariablen-Referenz weiter unten.

Reverse Proxy

Nur das Frontend (Port 3002) muss öffentlich erreichbar sein. Backend und CLI kommunizieren intern über das Docker-Netzwerk.

Beispiel-Konfiguration für Caddy:

ihre-domain.de {
    reverse_proxy localhost:3002
}

Bei Verwendung von nginx oder Traefik leiten Sie den gesamten Traffic an Port 3002 weiter.

Analytodon starten

Starten Sie alle Dienste:

docker compose up -d

Öffnen Sie https://ihre-domain.de in Ihrem Browser. Sie sollten die Analytodon-Anmeldeseite sehen. Registrieren Sie Ihr erstes Konto und verbinden Sie es mit Ihrer Mastodon-Instanz.

Umgebungsvariablen

Die folgenden Tabellen listen die wichtigsten Konfigurationsoptionen für jeden Dienst auf.

Backend

Frontend

CLI

Die vollständige und aktuellste Liste der Umgebungsvariablen finden Sie in der README im GitHub-Repository.

Ressourcen

• GitHub-Repository – Quellcode, README und detaillierte Einrichtungsanleitung
• Issue Tracker – Fehler melden oder Funktionen anfragen
• Mastodon – Folgen Sie uns für Updates oder wenden Sie sich an uns, wenn Sie Hilfe brauchen