insights/content/tutorials/running-wakapi-a-self-hosted-wakatime-compatible-backend-for-coding-stats/index.id.md at b354c38c95fcb99ce04142270203491e7e0c2ea4

mirror of https://github.com/ditatompel/insights.git synced 2025-01-08 03:12:06 +07:00

Menginstall Wakapi, Sebuah Self-Hosted Koding Statistik yang Kompatible Dengan WakaTime Client API

2023-08-25 06:42:18 +07:00

7.9 KiB

Raw Blame History

title

description

date

lastmod

draft

noindex

featured

nav_weight

series

Pengantar

Saya yang sehari-harinya banyak berinteraksi dengan komputer, terutama melakukan maintenance server dan koding selalu ingin tahu apa saja yang sudah saya kerjakan, projek mana yang paling banyak menyita waktu, dan bahasa program apa yang paling banyak saya gunakan. Ada beberapa jasa yang pernah saya cobaselama setahun terakhir, dari Activity Watch, CodeStats, hingga WakaTime.

Untuk Activity Watch, memang backend bisa diinstall di lokal / remote server, tetapi saya rasa cukup berat dijalankan. Untuk CodeStats dan WakaTime cukup memuaskan, tetapi ada yang kurang, yaitu data statistik koding dikirimkan ke server mereka. Tentu saja hal tersebut cukup mengganggu pikiran saya.

Beruntungnya, beberapa hari yang lalu ketika saya melakukan "window shopping" ke GitHub menemukan solusi dari yang selama ini saya inginkan yaitu Wakapi; sebuah endpoint API yang kompatibel dengan WakaTime client yang bisa di-self-hosted.

Wakapi server dibuat dengan bahasa program Go, dan dapat dijalankan di sistem operasi Windows, MacOS (baik ARM maupun x86_64), maupun Linux (baik ARM maupun x86_64). Di artikel kali ini saya ingin berbagi pengalaman menginstall dan menjalankan Wakapi di Linux server.

Installasi Server

Sebelum memulai, ada beberapa prasyarat yang harus dipenuhi untuk mengikuti artikel ini:

Nyaman menggunakan Linux terminal
Salah satu WakaTime client sudah terinstall dan berjalan dengan baik
Sebuah Linux server / Laptop / PC
Sebuah Web Server (pada artikel ini saya menggunakan Nginx. Optional, tapi recommended jika Wakapi dapat diakses dari publik)

Ada beberapa cara menjalankan Wakapi server sendiri:

Menggunakan precompiled binary
menggunakan Docker
Compile dari source-code

Karena di server saya sudah terinstall Go, maka pada artikel ini saya akan menggunakan opsi ketiga, yaitu melakukan compile langsung dari source-code-nya.

Mempersiapkan Sistem & Compile Executable Binary

Pertama, persiapkan sistem dengan membuat sistem user baru:

sudo useradd -r -m --system -d /opt/wakapi -s /bin/bash wakapi

Clone repositori mutey/wakapi dan lakukan compile executable binary-nya:

# clone repo
git clone https://github.com/muety/wakapi.git

# build executable binary
cd wakapi
go build -o wakapi

Setting Konfigurasi Wakapi

Setelah proses compile selesai, pindahkan executable binary ke $HOME milik user wakapi yang sudah kita buat sebelumnya.

sudo mv wakapi /opt/wakapi/

Download contoh konfigurasi

sudo curl -o /opt/wakapi/wakapi.yml https://raw.githubusercontent.com/muety/wakapi/master/config.default.yml
# ubah kepemilikan file ke user wakapi
sudo chown wakapi:wakapi /opt/wakapi/wakapi.yml /opt/wakapi/wakapi

Kemudian edit file konfigurasi /opt/wakapi/wakapi.yml sesuai dengan yang dibutuhkan. Misalnya, saya akan menggunakan subdomain wakapi.example.com dengan Nginx sebagai reverse proxy untuk Wakapi, maka saya set listen_ipv4 nya ke 127.0.0.1 dan public_url nya ke https://wakapi.example.com. Sesuaikan konfigurasi yang lain seperti koneksi database, SMTP email, dan lain-lain.

Membuat Systemd Service

Setelah konfigurasi sudah disesuaikan dengan kebutuhan, buat Systemd service Wakapi untuk mempermudah manajemen dalam menjalankan atau merestart Wakapi service.

Buat file /etc/systemd/system/wakapi.service dengan isi kurang lebih seperti berikut:

[Unit]
Description=Wakatime Wakapi
StartLimitIntervalSec=400
StartLimitBurst=3

# Optional, dan jika menggunakan SQL / PostgreSQL dengan Systemd
Requires=mysql.service
After=mysql.service

[Service]
Type=simple

WorkingDirectory=/opt/wakapi
ExecStart=/opt/wakapi/wakapi -config /opt/wakapi/wakapi.yml

User=wakapi
Group=wakapi
RuntimeDirectory=wakapi # creates /run/wakapi, useful to place your socket file there

Restart=on-failure
RestartSec=90

# Security hardening
PrivateTmp=true
PrivateUsers=true
NoNewPrivileges=true
ProtectSystem=full
ProtectHome=true
ProtectKernelTunables=true
ProtectKernelModules=true
ProtectKernelLogs=true
ProtectControlGroups=true
PrivateDevices=true
CapabilityBoundingSet=CAP_NET_BIND_SERVICE
ProtectClock=true
RestrictSUIDSGID=true
ProtectHostname=true
ProtectProc=invisible

[Install]
WantedBy=multi-user.target

Kemudian reload dan jalankan wakapi service:

sudo systemctl daemon-reload
sudo systemctl enable wakapi.service --now

# cek apakah service berjalan dengan baik
systemctl status wakapi.service

Jika semua berjalan dengan baik, masuk ke langkah selanjutnya untuk Nginx reverse proxy.

Nginx Reverse Proxy

Untuk konfigurasi Nginx, tidak memerlukan konfigurasi khusus. Cukup gunakan konfigurasi reverse proxy pada umumnya. Contoh:

server {
    listen 80;
    server_name wakapi.example.com;
    root /opt/wakapi;
    access_log  off;
    location /.well-known/acme-challenge/ { allow all; }
    location / { return 301 https://$host$request_uri; }
}

server {
    listen 443 ssl http2;
    server_name wakapi.example.com;
    access_log  off;

    ssl_certificate     /path/to/fullchain.pem;
    ssl_certificate_key /path/to/privkey.pem;
    
    # bla bla bla

    location / {
        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
        proxy_set_header X-Forwarded-Proto $scheme;
        proxy_set_header X-Real-IP $remote_addr;
        proxy_set_header Host $http_host;
        proxy_pass http://127.0.0.1:3000;
    }
}

Sesuaikan proxy_pass dengan konfigurasi listen_ipv4 dan port dari /opt/wakapi/wakapi.yml milik Anda.

Kemudian coba akses dari Wakapi server Anda dan lakukan registrasi. Setelah berhasil melakukan registrasi, Anda akan mendapatkan API key yang nantinya Anda perlukan untuk setting WakaTime client.

Konfigurasi WakaTime Client

Server sudah siap dan siap menerima "heartbeat"_ Anda. Selanjutnya sesuaikan konfigurasi WakaTime client Anda ke self-hosted Wakapi Anda. Ubah konfigurasi api_url dan api_key di .wakatime.cfg Anda ke server milik Anda. Misalnya:

[settings]

api_url = https://wakapi.example.com/api
api_key = API-Key-Anda-Dari-Wakapi-Server-Anda

Coba lakukan aktifitas koding dan cek aktifitas koding Anda dari Dashboard Wakapi.

Jika Anda kurang puas dengan tampilan dashboard pada Wakapi web UI, anda bisa mengekspose metrics ke format Prometheus kemudian memvisualisasikannya menggunakan Grafana.

Anda juga bisa mengintegrasikannya dengan GitHub Readme Stats sehingga aktifitas koding Anda dapat tampil di halaman Profile gitHub Anda.

Sekian pengalaman saya menginstall Wakapi server, semoga dapat menjadi inspirasi.

7.9 KiB Raw Blame History