Guide de déploiement

Wakapi sur VPS : vos statistiques de temps de code, chez vous

Déployer sur un VPS Cloud →

Tutoriel

Self-hosting

Wakapi sur VPS : vos statistiques de temps de code, chez vous

Les extensions WakaTime mesurent très bien le temps passé à coder, mais elles envoient chaque fichier ouvert, chaque projet et chaque branche à un service tiers. Wakapi est un serveur open source compatible avec ces mêmes extensions : vous changez une ligne de configuration et vos statistiques restent sur votre VPS. Ce guide l'installe avec Docker Compose, ferme les inscriptions, le publie en HTTPS derrière nginx et y branche votre éditeur.

6 min de lecture4 étapes
Sommaire· Ce que fait Wakapi1/11
  1. 01Ce que fait Wakapi
  2. 02Ce que Wakapi vous donne
  3. 03WakaTime hébergé ou Wakapi sur votre VPS
  4. 04Prérequis
  5. 05Installer Wakapi avec Docker Compose
  6. 06Ne laissez pas les inscriptions ouvertes
  7. 07Publier Wakapi en HTTPS avec nginx
  8. 08Brancher votre éditeur
  9. 09Lire vos statistiques et l'API
  10. 10Sauvegarder et mettre à jour
  11. 11Installer Wakapi en un clic sur ServOrbit

Ce que fait Wakapi

Wakapi reçoit les « pulsations » (heartbeats) que les extensions WakaTime envoient pendant que vous codez : le fichier, le projet, le langage, l'éditeur, la machine et la branche, toutes les deux minutes environ. Il les agrège en statistiques consultables dans un tableau de bord web et par une API compatible avec celle de WakaTime.

Le projet est publié sous licence MIT. Il tient dans une seule application Go et stocke ses données dans SQLite par défaut (MySQL et PostgreSQL sont aussi pris en charge). Sur un VPS, il occupe environ 100 Mo de mémoire au repos.

Ce que Wakapi vous donne

  • Le temps par projet, langage, éditeur, machine et branche — sur la journée, la semaine ou la période de votre choix.
  • Vos extensions actuelles — VS Code, JetBrains, Vim, Neovim, Sublime Text : seule l'adresse du serveur change.
  • Une API compatible WakaTime — barres d'état et outils qui lisent l'API WakaTime pointent vers votre instance.
  • Des comptes sur invitation — inscriptions publiques fermées, liens d'invitation à usage unique valables 24 heures.
  • L'import de votre historique — depuis WakaTime ou une autre instance Wakapi, dans les paramètres.
  • Des données qui restent chez vous — rien ne sort du VPS, sauf si vous activez le relais vers WakaTime.

WakaTime hébergé ou Wakapi sur votre VPS

Faites défiler le tableau

WakaTime (service hébergé)Wakapi sur votre VPS
Où vont les pulsationsServeurs de WakaTimeVotre VPS
Extensions de l'éditeurExtensions WakaTimeLes mêmes extensions
Historique conservéSelon l'offre souscriteTant que vous le gardez
Comptes de l'équipeComptes WakaTimeComptes sur votre instance, par invitation
Licence du serveurService propriétaireMIT

Prérequis

Un VPS Ubuntu 24.04 avec 1 Go de RAM et 1 vCPU suffit largement. Il vous faut Docker avec le plugin Compose, nginx et certbot sur l'hôte, et un nom (wakapi.example.com dans ce guide) qui pointe vers l'IP du VPS. Les extensions WakaTime envoient leurs données en HTTPS : prévoyez le certificat dès le départ.

Installer Wakapi avec Docker Compose

  1. Préparer le dossier et le fichier .env

    WAKAPI_PASSWORD_SALT est le sel ajouté aux mots de passe avant leur hachage : générez-le une fois et ne le changez plus, sinon plus aucun compte ne pourra se connecter. Les inscriptions sont ouvertes le temps de créer votre compte, puis refermées à l'étape 4.

    mkdir -p /opt/wakapi && cd /opt/wakapi
    cat > .env <<EOF
    DOMAIN=wakapi.example.com
    WAKAPI_PASSWORD_SALT=$(openssl rand -hex 32)
    WAKAPI_ALLOW_SIGNUP=true
    EOF
    chmod 600 .env
  2. Écrire le fichier docker-compose.yml

    L'image officielle tourne sous un utilisateur non privilégié et garde sa base SQLite dans le volume wakapi-data. Le port n'est publié que sur la boucle locale : seul nginx sera exposé à Internet. WAKAPI_LEADERBOARD_ENABLED coupe le classement public, et WAKAPI_INSECURE_COOKIES à false réserve les cookies de session au HTTPS.

    services:
      wakapi:
        image: ghcr.io/muety/wakapi:2.18.2
        restart: unless-stopped
        environment:
          WAKAPI_PASSWORD_SALT: "${WAKAPI_PASSWORD_SALT}"
          WAKAPI_PUBLIC_URL: "https://${DOMAIN}"
          WAKAPI_ALLOW_SIGNUP: "${WAKAPI_ALLOW_SIGNUP:-false}"
          WAKAPI_INVITE_CODES: "true"
          WAKAPI_LEADERBOARD_ENABLED: "false"
          WAKAPI_INSECURE_COOKIES: "false"
        ports:
          - "127.0.0.1:3000:3000"
        volumes:
          - wakapi-data:/data
    
    volumes:
      wakapi-data: {}
  3. Démarrer et créer votre compte

    Lancez la pile et vérifiez le point de santé, qui doit répondre app=1 et db=1 :

    docker compose up -d
    curl -s http://127.0.0.1:3000/api/health

    Une fois nginx et le certificat en place (section suivante), ouvrez https://wakapi.example.com/signup et créez votre compte : le premier compte créé devient administrateur.

  4. Fermer les inscriptions

    Dès votre compte créé, refermez les inscriptions et recréez le conteneur :

    sed -i 's/^WAKAPI_ALLOW_SIGNUP=true/WAKAPI_ALLOW_SIGNUP=false/' .env
    docker compose up -d

    Le formulaire d'inscription répond désormais « registration is disabled ». Pour ajouter un collègue, générez un lien d'invitation depuis les paramètres de votre compte (« Invite Friends ») : il est valable 24 heures et ne sert qu'une fois.

Ne laissez pas les inscriptions ouvertes

Une instance publiée sur un domaine avec WAKAPI_ALLOW_SIGNUP=true laisse n'importe qui y ouvrir un compte et y stocker des données. Gardez false, invitez vos collègues par lien, et laissez le port sur 127.0.0.1.

Publier Wakapi en HTTPS avec nginx

Créez /etc/nginx/sites-available/wakapi avec ce bloc serveur, puis activez-le avec un lien symbolique dans sites-enabled :

server {
    listen 80;
    server_name wakapi.example.com;

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

Vérifiez la configuration, rechargez nginx et demandez le certificat ; certbot ajoute lui-même le bloc HTTPS et la redirection depuis HTTP.

sudo nginx -t && sudo systemctl reload nginx
sudo certbot --nginx -d wakapi.example.com

Brancher votre éditeur

Installez l'extension WakaTime de votre éditeur depuis sa place de marché habituelle. Dans Wakapi, ouvrez les paramètres et copiez votre clé d'API, puis écrivez le fichier ~/.wakatime.cfg de votre poste :

[settings]
api_url = https://wakapi.example.com/api
api_key = <API_KEY>

Le client WakaTime déduit le nom du projet du dossier racine du dépôt Git et le nom de la machine du nom d'hôte du poste : vous retrouvez donc vos dépôts tels quels dans le tableau de bord, et vous distinguez sans effort le portable du poste fixe. Un fichier .wakatime-project placé à la racine d'un dépôt impose un autre nom de projet, utile quand plusieurs clones portent le même dossier. Pour exclure un dossier sensible, la clé exclude de ~/.wakatime.cfg accepte des expressions régulières sur les chemins.

Codez quelques minutes et rechargez le tableau de bord de Wakapi : vos premiers chiffres apparaissent. Le même fichier sert à toutes les extensions de la machine. Pour envoyer vos données à la fois à WakaTime et à Wakapi, le client WakaTime accepte une section [api_urls] qui ajoute des destinations.

Lire vos statistiques et l'API

Le tableau de bord présente le temps par projet, langage, éditeur, système, machine et branche, sur l'intervalle choisi. Les mêmes chiffres sont accessibles par l'API compatible WakaTime, en authentification Basic avec la clé d'API encodée en base64 :

curl -s https://wakapi.example.com/api/compat/wakatime/v1/users/current/statusbar/today \
  -H "Authorization: Basic $(printf %s '<API_KEY>' | base64)"

C'est ce point d'accès que lisent les extensions qui affichent le temps du jour dans la barre d'état. Les paramètres proposent aussi des badges pour un README, le partage public de certaines statistiques (désactivé par défaut) et l'import de votre historique WakaTime.

Sauvegarder et mettre à jour

Toutes les données tiennent dans le volume wakapi-data. Arrêtez le conteneur le temps de copier la base SQLite, pour qu'elle soit cohérente :

cd /opt/wakapi
docker compose stop wakapi
docker run --rm -v wakapi_wakapi-data:/data -v "$PWD":/backup alpine:3.22 \
  tar czf /backup/wakapi-$(date +%F).tar.gz -C /data .
docker compose start wakapi

Pour mettre à jour, lisez d'abord les notes de version sur GitHub, sauvegardez, puis changez le tag de l'image :

cd /opt/wakapi
sed -i 's|wakapi:2.18.2|wakapi:<NOUVELLE_VERSION>|' docker-compose.yml
docker compose pull && docker compose up -d

Installer Wakapi en un clic sur ServOrbit

Sur un VPS ServOrbit, Wakapi s'installe depuis le Marketplace. Le script déploie l'image officielle, génère le mot de passe administrateur et le sel de hachage, crée le compte admin, ferme les inscriptions publiques et coupe le classement public, puis configure le reverse proxy nginx en HTTPS — sur un sous-domaine de l'un de vos domaines ou sur le sous-domaine gratuit du VPS. Vous vous connectez avec l'utilisateur admin et le mot de passe affiché dans votre espace client, puis vous branchez votre éditeur comme ci-dessus.

Partager cet articleservorbit.com/ma-fr/blog/self-host-wakapi-vps