|
| 1 | +--- |
| 2 | +sidebar_position: 2 |
| 3 | +_i18n_hash: 8142a07cc46361e9e72d8c883ab7869a |
| 4 | +--- |
| 5 | +# Installation in Traefik mit Plugin |
| 6 | + |
| 7 | +Tianji bietet ein Traefik-Plugin, das es Ihnen ermöglicht, die Website-Analyse-Funktionalität von Tianji einfach in Ihren Traefik-Proxy zu integrieren. |
| 8 | + |
| 9 | +## Plugin-Übersicht |
| 10 | + |
| 11 | +[traefik-tianji-plugin](https://github.com/msgbyte/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 Sie Ihren Website-Code ändern müssen, um mit der Sammlung von Besucherdaten zu beginnen. |
| 12 | + |
| 13 | +## Installation des Plugins |
| 14 | + |
| 15 | +### 1. Plugin in der statischen Konfiguration hinzufügen |
| 16 | + |
| 17 | +Zuerst müssen Sie den Plugin-Verweis in Traefiks statischer Konfiguration hinzufügen. Die Plugin-Versionsnummer verweist auf das Git-Tag. |
| 18 | + |
| 19 | +#### YAML-Konfiguration |
| 20 | + |
| 21 | +Fügen Sie das Folgende zu Ihrer `traefik.yml` oder statischen Konfigurationsdatei hinzu: |
| 22 | + |
| 23 | +```yaml |
| 24 | +experimental: |
| 25 | + plugins: |
| 26 | + traefik-tianji-plugin: |
| 27 | + moduleName: "github.com/msgbyte/traefik-tianji-plugin" |
| 28 | + version: "v0.2.1" |
| 29 | +``` |
| 30 | +
|
| 31 | +#### TOML-Konfiguration |
| 32 | +
|
| 33 | +```toml |
| 34 | +[experimental.plugins.traefik-tianji-plugin] |
| 35 | + moduleName = "github.com/msgbyte/traefik-tianji-plugin" |
| 36 | + version = "v0.2.1" |
| 37 | +``` |
| 38 | + |
| 39 | +#### Befehlszeile |
| 40 | + |
| 41 | +```bash |
| 42 | +--experimental.plugins.traefik-tianji-plugin.modulename=github.com/msgbyte/traefik-tianji-plugin |
| 43 | +--experimental.plugins.traefik-tianji-plugin.version=v0.2.1 |
| 44 | +``` |
| 45 | + |
| 46 | +### 2. Middleware konfigurieren |
| 47 | + |
| 48 | +Nach der Installation des Plugins müssen Sie die Middleware in der dynamischen Konfiguration einrichten. |
| 49 | + |
| 50 | +#### YAML-Dynamische Konfiguration |
| 51 | + |
| 52 | +In Ihrer `config.yml` oder dynamischen Konfigurationsdatei: |
| 53 | + |
| 54 | +```yaml |
| 55 | +http: |
| 56 | + middlewares: |
| 57 | + my-tianji-middleware: |
| 58 | + plugin: |
| 59 | + traefik-tianji-plugin: |
| 60 | + tianjiHost: "https://tianji.ihre-domain.com" |
| 61 | + websiteId: "ihre-website-id" |
| 62 | +``` |
| 63 | +
|
| 64 | +#### TOML-Dynamische Konfiguration |
| 65 | +
|
| 66 | +```toml |
| 67 | +[http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin] |
| 68 | + tianjiHost = "https://tianji.ihre-domain.com" |
| 69 | + websiteId = "ihre-website-id" |
| 70 | +``` |
| 71 | + |
| 72 | +#### Docker Compose Labels |
| 73 | + |
| 74 | +```yaml |
| 75 | +version: '3.7' |
| 76 | +services: |
| 77 | + my-app: |
| 78 | + image: nginx:latest |
| 79 | + labels: |
| 80 | + - "traefik.enable=true" |
| 81 | + - "traefik.http.routers.my-app.rule=Host(`my-app.local`)" |
| 82 | + - "traefik.http.routers.my-app.middlewares=my-tianji-middleware" |
| 83 | + - "traefik.http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin.tianjiHost=https://tianji.ihre-domain.com" |
| 84 | + - "traefik.http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin.websiteId=ihre-website-id" |
| 85 | +``` |
| 86 | +
|
| 87 | +## Konfigurationsparameter |
| 88 | +
|
| 89 | +### Erforderliche Parameter |
| 90 | +
|
| 91 | +- **tianjiHost**: Die vollständige URL Ihres Tianji-Servers |
| 92 | + - Beispiel: `https://tianji.ihre-domain.com` |
| 93 | + - Wenn Sie den offiziellen gehosteten Dienst nutzen: `https://app-tianji.msgbyte.com` |
| 94 | + |
| 95 | +- **websiteId**: Die in Tianji erstellte Website-ID |
| 96 | + - Kann in den Website-Einstellungen Ihres Tianji-Admin-Panels gefunden werden |
| 97 | + |
| 98 | +### Optionale Parameter |
| 99 | + |
| 100 | +Das Plugin unterstützt auch andere Konfigurationsparameter zur Anpassung des Verhaltens. Für spezifische Parameter konsultieren Sie bitte die [GitHub Repository Dokumentation](https://github.com/msgbyte/traefik-tianji-plugin). |
| 101 | + |
| 102 | +## Verwendung der Middleware |
| 103 | + |
| 104 | +Nach der Konfiguration müssen Sie diese Middleware in Ihrem Router verwenden: |
| 105 | + |
| 106 | +### YAML-Konfiguration |
| 107 | + |
| 108 | +```yaml |
| 109 | +http: |
| 110 | + routers: |
| 111 | + my-app: |
| 112 | + rule: "Host(`my-app.local`)" |
| 113 | + middlewares: |
| 114 | + - "my-tianji-middleware" |
| 115 | + service: "my-app-service" |
| 116 | +``` |
| 117 | +
|
| 118 | +### Docker Compose Labels |
| 119 | +
|
| 120 | +```yaml |
| 121 | +labels: |
| 122 | + - "traefik.http.routers.my-app.middlewares=my-tianji-middleware" |
| 123 | +``` |
| 124 | +
|
| 125 | +## So funktioniert's |
| 126 | +
|
| 127 | +1. Wenn Anfragen den Traefik-Proxy passieren, überprüft das Plugin den Antwortinhalt |
| 128 | +2. Wenn die Antwort HTML-Inhalte ist, fügt das Plugin das Tianji-Tracking-Skript automatisch ein |
| 129 | +3. Das Skript beginnt mit der Sammlung von Besucherdaten und sendet sie beim Laden der Seite an den Tianji-Server |
| 130 | +
|
| 131 | +## Wichtige Hinweise |
| 132 | +
|
| 133 | +- Stellen Sie sicher, dass die Tianji-Serveradresse von Client-Browsern aus zugänglich ist |
| 134 | +- Die Website-ID muss gültig sein, andernfalls können Daten nicht korrekt gesammelt werden |
| 135 | +- Das Plugin hat nur Effekte, wenn der Antwortinhaltstyp HTML ist |
| 136 | +- Es wird empfohlen, die neueste Version des Plugins für optimale Leistung und Funktionen zu verwenden |
| 137 | +
|
| 138 | +## Referenz |
| 139 | +
|
| 140 | +- [Quellcode des Plugins](https://github.com/msgbyte/traefik-tianji-plugin) |
| 141 | +- [Traefik Plugin Dokumentation](https://doc.traefik.io/traefik/plugins/) |
0 commit comments