Skip to content

Commit 422fbde

Browse files
committed
docs: move traefik with plugin document position
1 parent 1493d4a commit 422fbde

5 files changed

Lines changed: 564 additions & 0 deletions

File tree

website/docs/install/other/install-in-traefik-with-plugin.md renamed to website/docs/website/framework/install-in-traefik-with-plugin.md

File renamed without changes.
Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
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/)
Lines changed: 141 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,141 @@
1+
---
2+
sidebar_position: 2
3+
_i18n_hash: 8142a07cc46361e9e72d8c883ab7869a
4+
---
5+
# Installation dans Traefik avec plugin
6+
7+
Tianji fournit un plugin Traefik qui vous permet d'intégrer facilement la fonctionnalité d'analyse de site Web Tianji dans votre proxy Traefik.
8+
9+
## Aperçu du Plugin
10+
11+
[traefik-tianji-plugin](https://github.com/msgbyte/traefik-tianji-plugin) est un plugin middleware Traefik spécifiquement développé pour Tianji qui peut automatiquement injecter le script de suivi Tianji dans votre site Web sans modifier le code de votre site afin de commencer à collecter des données de visiteurs.
12+
13+
## Installation du Plugin
14+
15+
### 1. Ajouter le Plugin dans la Configuration Statique
16+
17+
Tout d'abord, vous devez ajouter la référence du plugin dans la configuration statique de Traefik. Le numéro de version du plugin fait référence au tag git.
18+
19+
#### Configuration YAML
20+
21+
Ajoutez ce qui suit à votre `traefik.yml` ou fichier de configuration statique :
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+
#### Configuration TOML
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+
#### Ligne de Commande
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. Configurer le Middleware
47+
48+
Après avoir installé le plugin, vous devez configurer le middleware dans la configuration dynamique.
49+
50+
#### Configuration Dynamique YAML
51+
52+
Dans votre `config.yml` ou fichier de configuration dynamique :
53+
54+
```yaml
55+
http:
56+
middlewares:
57+
my-tianji-middleware:
58+
plugin:
59+
traefik-tianji-plugin:
60+
tianjiHost: "https://tianji.votre-domaine.com"
61+
websiteId: "votre-id-du-site"
62+
```
63+
64+
#### Configuration Dynamique TOML
65+
66+
```toml
67+
[http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin]
68+
tianjiHost = "https://tianji.votre-domaine.com"
69+
websiteId = "votre-id-du-site"
70+
```
71+
72+
#### Labels Docker Compose
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.votre-domaine.com"
84+
- "traefik.http.middlewares.my-tianji-middleware.plugin.traefik-tianji-plugin.websiteId=votre-id-du-site"
85+
```
86+
87+
## Paramètres de Configuration
88+
89+
### Paramètres Requis
90+
91+
- **tianjiHost** : L'URL complète de votre serveur Tianji
92+
- Exemple : `https://tianji.votre-domaine.com`
93+
- Si vous utilisez le service hébergé officiel : `https://app-tianji.msgbyte.com`
94+
95+
- **websiteId** : L'ID du site créé dans Tianji
96+
- Peut être trouvé dans les paramètres du site de votre panneau d'administration Tianji
97+
98+
### Paramètres Optionnels
99+
100+
Le plugin prend également en charge d'autres paramètres de configuration pour personnaliser le comportement. Pour des paramètres spécifiques, veuillez consulter la [documentation du dépôt GitHub](https://github.com/msgbyte/traefik-tianji-plugin).
101+
102+
## Utilisation du Middleware
103+
104+
Après la configuration, vous devez utiliser ce middleware dans votre routeur :
105+
106+
### Configuration YAML
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+
### Labels Docker Compose
119+
120+
```yaml
121+
labels:
122+
- "traefik.http.routers.my-app.middlewares=my-tianji-middleware"
123+
```
124+
125+
## Comment ça Marche
126+
127+
1. Lorsque les requêtes passent par le proxy Traefik, le plugin vérifie le contenu de la réponse
128+
2. Si la réponse est un contenu HTML, le plugin injecte automatiquement le script de suivi Tianji
129+
3. Le script commence à collecter des données de visiteurs et les envoie au serveur Tianji lorsque la page se charge
130+
131+
## Notes Importantes
132+
133+
- Assurez-vous que l'adresse du serveur Tianji est accessible depuis les navigateurs clients
134+
- L'ID du site doit être valide, sinon les données ne peuvent pas être collectées correctement
135+
- Le plugin n'agit que lorsque le type de contenu de la réponse est HTML
136+
- Il est recommandé d'utiliser la dernière version du plugin pour des performances et des fonctionnalités optimales
137+
138+
## Référence
139+
140+
- [Code Source du Plugin](https://github.com/msgbyte/traefik-tianji-plugin)
141+
- [Documentation des Plugins Traefik](https://doc.traefik.io/traefik/plugins/)

0 commit comments

Comments
 (0)