Zum Hauptinhalt springen

Installation in Traefik mit Plugin

Tianji bietet ein Traefik-Plugin an, das es Ihnen ermöglicht, die Funktionalität der Website-Analyse von Tianji einfach in Ihren Traefik-Proxy zu integrieren.

Plugin-Übersicht​

traefik-tianji-plugin ist ein speziell für Tianji entwickeltes Traefik-Middleware-Plugin, das das Tianji-Tracking-Skript automatisch in Ihre Website einfügen kann, ohne dass der Website-Code geändert werden muss, um mit der Erfassung von Besucherdaten zu beginnen.

Plugin-Installation​

1. Plugin in der statischen Konfiguration hinzufügen​

Zuerst müssen Sie die Plugin-Referenz in der statischen Konfiguration von Traefik hinzufügen. Die Plugin-Versionsnummer bezieht sich auf den Git-Tag.

YAML-Konfiguration​

Fügen Sie das Folgende zu Ihrer traefik.yml oder statischen Konfigurationsdatei hinzu:

experimental:
  plugins:
    traefik-tianji-plugin:
      moduleName: "github.com/msgbyte/traefik-tianji-plugin"
      version: "v0.2.1"

TOML-Konfiguration​

[experimental.plugins.traefik-tianji-plugin]
  moduleName = "github.com/msgbyte/traefik-tianji-plugin"
  version = "v0.2.1"

Befehlszeile​

--experimental.plugins.traefik-tianji-plugin.modulename=github.com/msgbyte/traefik-tianji-plugin
--experimental.plugins.traefik-tianji-plugin.version=v0.2.1

2. Middleware konfigurieren​

Nach der Installation des Plugins müssen Sie die Middleware in der dynamischen Konfiguration einrichten.

YAML-Dynamische Konfiguration​

In Ihrer config.yml oder dynamischen Konfigurationsdatei:

http:
  middlewares:
    my-tianji-middleware:
      plugin:
        traefik-tianji-plugin:
          tianjiHost: "https://tianji.your-domain.com"
          websiteId: "your-website-id"

TOML-Dynamische Konfiguration​

[http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin]
  tianjiHost = "https://tianji.your-domain.com"
  websiteId = "your-website-id"

Docker-Compose-Labels​

version: '3.7'
services:
  my-app:
    image: nginx:latest
    labels:
      - "traefik.enable=true"
      - "traefik.http.routers.my-app.rule=Host(`my-app.local`)"
      - "traefik.http.routers.my-app.middlewares=my-tianji-middleware"
      - "traefik.http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin.tianjiHost=https://tianji.your-domain.com"
      - "traefik.http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin.websiteId=your-website-id"

Konfigurationsparameter​

Erforderliche Parameter​

  • tianjiHost: Die vollständige URL Ihres Tianji-Servers

    • Beispiel: https://tianji.your-domain.com
    • Wenn der offizielle Hosting-Service verwendet wird: https://app.tianji.dev

  • websiteId: Die in Tianji erstellte Website-ID

    • Kann in den Website-Einstellungen Ihres Tianji-Admin-Panels gefunden werden

Optionale Parameter​

Das Plugin unterstützt auch andere Konfigurationsparameter zur Anpassung des Verhaltens. Für spezifische Parameter beziehen Sie sich bitte auf die GitHub-Repository-Dokumentation.

Verwendung der Middleware​

Nach der Konfiguration müssen Sie diese Middleware in Ihrem Router verwenden:

YAML-Konfiguration​

http:
  routers:
    my-app:
      rule: "Host(`my-app.local`)"
      middlewares:
        - "my-tianji-middleware"
      service: "my-app-service"

Docker-Compose-Labels​

labels:
  - "traefik.http.routers.my-app.middlewares=my-tianji-middleware"

Funktionsweise​

  1. Wenn Anfragen den Traefik-Proxy passieren, überprüft das Plugin den Antwortinhalt
  2. Wenn der Antwortinhalt ein HTML-Inhalt ist, fügt das Plugin das Tianji-Tracking-Skript automatisch ein
  3. Das Skript beginnt mit der Erfassung von Besucherdaten und sendet sie beim Laden der Seite an den Tianji-Server

Wichtige Hinweise​

  • Stellen Sie sicher, dass die Tianji-Serveradresse von Client-Browsern zugänglich ist
  • Die Website-ID muss gültig sein, ansonsten können die Daten nicht ordnungsgemäß erfasst werden
  • Das Plugin wirkt nur, wenn der Antwortinhalt vom Typ HTML ist
  • Es wird empfohlen, die neueste Version des Plugins für optimale Leistung und Funktionen zu verwenden

Referenzen​