Déployez votre propre instance Kledg

Choisir son hébergement

Kledg se déploie sur Vercel avec une base Neon, sur Railway, Render, Fly.io ou Clever Cloud (hébergeur français) grâce aux fichiers de configuration du dépôt, ou avec l’image Docker sur votre propre serveur. Le reste de cette page détaille Vercel ; le guide Choisir son hébergement compare toutes les options et chaque hébergeur a sa page de documentation.

Ce dont vous avez besoin

• Vercel

  Hébergement de l’application Next.js

  Requis
• Neon

  Base de données Postgres

  Requis
• Resend

  Envoi des emails

  Requis

Un compte GitHub est aussi nécessaire : le déploiement crée une copie du dépôt Kledg dans votre compte.

Variables d’environnement

Dans les paramètres du projet Vercel (le bouton de déploiement vous les demande) ou dans l’environnement de votre serveur. Pour générer un secret robuste, une commande suffit :

Étape par étape

1. 1

   Lancer le déploiement

   Cliquez sur « Déployer sur Vercel ». Vercel crée un dépôt dans votre compte GitHub à partir du code de Kledg, puis le projet.

2. 2

   Créer la base Neon

   Acceptez la base Neon proposée par Vercel (région Frankfurt, option Auth désactivée, offre Free) : elle est reliée au projet automatiquement.

3. 3

   Renseigner les variables

   Saisissez BETTER_AUTH_SECRET et ADMIN_EMAIL, les deux seules variables demandées. Le build applique les migrations de la base tout seul.

4. 4

   Créer le compte administrateur

   Le guide de déploiement donne le lien d’installation, calculé dans votre navigateur à partir du secret : il ouvre la création du compte administrateur.

5. 5

   Ajouter les emails

   Une fois Kledg en ligne, ajoutez Resend depuis l’onglet Storage du projet, revendiquez votre domaine dans Domains, renseignez EMAIL_FROM, puis redéployez.

6. 6

   Reprendre vos données

   Créez votre société, puis importez votre FEC, vos fichiers CSV ou Excel, ou vos relevés bancaires.

Le README du dépôt fait foi pour le détail propre à chaque version. README

Mettre à jour votre instance

Votre dépôt contient le workflow GitHub Actions « Update from Kledg ». Chaque lundi, il vérifie si une nouvelle version de Kledg est disponible et, si c’est le cas, ouvre une pull request « Mise à jour Kledg x.y.z » dans votre dépôt.

1. 1

   Vercel construit un aperçu de la pull request : ouvrez-le et vérifiez votre instance.

2. 2

   Fusionnez la pull request : Vercel déploie la nouvelle version et applique les migrations de la base.

Pour ne pas attendre lundi, lancez-le à la main : onglet Actions de votre dépôt, « Update from Kledg », puis « Run workflow ». Pour choisir ce que le workflow suit, créez la variable de dépôt KLEDG_UPDATES (Settings, Secrets and variables, Actions, Variables) : releases (par défaut, les versions publiées), main (chaque changement) ou off (aucune pull request). Chaque pull request liste les migrations de la base qu’elle apporte.

Si le réglage « Allow GitHub Actions to create and approve pull requests » (Settings, Actions, General) est désactivé, le workflow pousse quand même la branche kledg-update et affiche un lien pour ouvrir la pull request en un clic. Activez ce réglage pour que tout soit automatique.

Si votre instance a été déployée avant l’arrivée de ce workflow, faites une première mise à jour à la main (ci-dessous) : il sera ensuite présent dans votre dépôt.

Autres méthodes

• Si vous préférez le bouton « Sync fork » de GitHub : forkez Kledg sur GitHub, puis importez votre fork dans Vercel (avec l’intégration Neon et les variables d’environnement) au lieu d’utiliser le bouton de déploiement.

  Documentation GitHub sur la synchronisation d’un fork

• À la main, depuis une copie de votre dépôt : ajoutez le dépôt Kledg comme source amont, une fois pour toutes, puis fusionnez ses changements.

  git remote add upstream https://github.com/kledghq/kledg.git
  git pull upstream main
  git push

• Avec Docker, la mise à jour se fait sur le serveur : git pull, puis docker compose up -d --build. Les migrations s’appliquent au démarrage du conteneur. Si la version apporte des migrations, le conteneur sauvegarde d’abord la base avec pg_dump et s’arrête si la sauvegarde échoue.

  git pull
  docker compose up -d --build

Avant une mise à jour, lisez les notes de version et faites une sauvegarde de votre base (une branche Neon, ou un pg_dump avec Docker) ainsi qu’un export FEC.

Combien ça coûte ?

Kledg lui-même est gratuit. Pour démarrer, les offres gratuites de Vercel, Neon et Resend peuvent suffire pour un petit volume. Leurs conditions et leurs limites évoluent : vérifiez-les avant de vous lancer. L’offre Hobby de Vercel, par exemple, est réservée à un usage personnel et non commercial ; pour une société, l’offre Pro peut être nécessaire.

Ailleurs que sur Vercel

Kledg est une application Node.js qui s’appuie sur Postgres. Le dépôt fournit une configuration prête pour Railway, Render, Fly.io et Clever Cloud, et un fichier Docker Compose complet pour un serveur virtuel, Coolify, Dokploy ou une machine interne. Il vous faudra fournir les mêmes variables d’environnement et, hors Vercel, planifier vous-même la synchronisation bancaire quotidienne.