Lewati ke konten utama

Install di Traefik dengan plugin

Tianji menyediakan plugin Traefik yang memungkinkan Anda untuk mengintegrasikan fungsi analitik situs web Tianji ke dalam proxy Traefik dengan mudah.

Ikhtisar Plugin​

traefik-tianji-plugin adalah plugin middleware Traefik yang dikembangkan khusus untuk Tianji yang dapat secara otomatis menyuntikkan skrip pelacakan Tianji ke dalam situs web Anda tanpa memodifikasi kode situs web Anda untuk mulai mengumpulkan data pengunjung.

Instalasi Plugin​

1. Tambahkan Plugin dalam Konfigurasi Statis​

Pertama, Anda perlu menambahkan referensi plugin dalam konfigurasi statis Traefik. Nomor versi plugin merujuk ke tag git.

Konfigurasi YAML​

Tambahkan yang berikut ini ke traefik.yml atau file konfigurasi statis Anda:

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

Konfigurasi TOML​

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

Baris Perintah​

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

2. Konfigurasikan Middleware​

Setelah memasang plugin, Anda perlu mengkonfigurasi middleware dalam konfigurasi dinamis.

Konfigurasi Dinamis YAML​

Di dalam config.yml Anda atau file konfigurasi dinamis:

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

Konfigurasi Dinamis TOML​

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

Label Docker Compose​

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"

Parameter Konfigurasi​

Parameter Wajib​

  • tianjiHost: URL lengkap dari server Tianji Anda

    • Contoh: https://tianji.your-domain.com
    • Jika menggunakan layanan resmi yang dihosting: https://app-tianji.msgbyte.com

  • websiteId: ID situs web yang dibuat di Tianji

    • Dapat ditemukan dalam pengaturan situs web dari panel admin Tianji Anda

Parameter Opsional​

Plugin ini juga mendukung parameter konfigurasi lainnya untuk menyesuaikan perilaku. Untuk parameter spesifik, silakan merujuk ke dokumentasi repositori GitHub.

Menggunakan Middleware​

Setelah konfigurasi, Anda perlu menggunakan middleware ini dalam router Anda:

Konfigurasi YAML​

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

Label Docker Compose​

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

Cara Kerjanya​

  1. Saat permintaan melewati proxy Traefik, plugin memeriksa konten respons
  2. Jika respons berupa konten HTML, plugin secara otomatis menyuntikkan skrip pelacakan Tianji
  3. Skrip mulai mengumpulkan data pengunjung dan mengirimkannya ke server Tianji saat halaman dimuat

Catatan Penting​

  • Pastikan bahwa alamat server Tianji dapat diakses dari browser klien
  • ID situs web harus valid, jika tidak data tidak dapat dikumpulkan dengan benar
  • Plugin hanya efektif saat tipe konten respons adalah HTML
  • Disarankan untuk menggunakan versi terbaru dari plugin untuk kinerja dan fitur optimal

Referensi​