Aller au contenu

Installer Kledg

Déployez votre propre instance de Kledg en quelques minutes avec Vercel et Neon, ou sur Railway, Render, Fly.io, Clever Cloud, Coolify, Dokploy ou Docker, puis créez le compte administrateur.

Kledg ne s’utilise pas comme un service en ligne : vous installez votre propre instance. Vos écritures sont stockées dans votre base de données, et personne d’autre n’y a accès. Cette page décrit d’abord le chemin le plus simple, Vercel pour l’application et Neon pour la base de données, puis l’essentiel pour chaque autre hébergeur. Pour comparer les options, voir Choisir son hébergement.

Ce qu’il vous faut

  • un compte GitHub, qui hébergera votre copie du code ;
  • un compte Vercel, qui exécutera l’application ;
  • un compte Neon, créé automatiquement depuis Vercel, pour la base PostgreSQL ;
  • plus tard, un compte Resend pour l’envoi des emails (mot de passe oublié, accès des collaborateurs).

Comptez une dizaine de minutes.

Déployer sur Vercel

1. Créer votre compte Vercel

Commencez par créer votre compte sur vercel.com/signup, avec Continue with GitHub : Vercel y copiera le code de Kledg. Créer le compte à part, avant le déploiement, évite les écrans d’inscription mêlés à ceux du projet. Pour essayer, l’offre Hobby suffit ; pour une société, Vercel demande l’offre Pro. Si vous avez déjà un compte, passez à l’étape suivante.

2. Lancer le déploiement

Ce bouton vous demande votre email, puis ouvre Vercel avec Kledg et Neon choisis et votre email déjà rempli. Dans Chrome et Edge, une petite fenêtre flottante garde la liste des étapes sous vos yeux pendant que vous êtes sur Vercel.

Déployer sur VercelVotre email, et un guide pas à pas vous accompagne sur Vercel.

Si Vercel vous demande de vous connecter, choisissez Continue with GitHub.

vercel.com/new/clone

New Project

Kledg

kledghq/kledg

Sign in to clone and deploy.

Choisir Continue with GitHub
Continue with GitLabContinue with Bitbucket
Sans compte Vercel, celui-ci est créé au passage.

3. Créer le dépôt GitHub

Ouvrez le menu Git Scope et cliquez sur Add GitHub Scope.

vercel.com/new/clone

Create Git Repository

Git Scope

Select Git Scope
Cliquer
Add GitHub Scope
Switch Git Provider
Add GitHub Scope ouvre GitHub, pour y installer Vercel.

GitHub s’ouvre pour installer Vercel sur votre compte. Gardez All repositories : le dépôt kledg n’existe pas encore, et Vercel doit pouvoir le créer. Cliquez sur Install ; vous revenez sur Vercel. Une fois Kledg déployé, vous pourrez limiter l’accès de Vercel au seul dépôt kledg dans les réglages de GitHub (Settings, Applications).

github.com/apps/vercel/installations/new

Install Vercel

Install on your personal account votre-compte

for these repositories:

Garder

All repositories

All current and future repositories owned by the resource owner.

Only select repositories

with these permissions: read and write access to code, deployments, pull requests…

InstallInstall
Cancel
Gardez All repositories : le dépôt kledg n’existe pas encore. Vous pourrez restreindre l’accès ensuite.

Choisissez alors votre compte dans Git Scope. Gardez le nom kledg et le dépôt privé, puis cliquez sur Create : Vercel y copie le code de Kledg, et c’est là qu’arriveront les mises à jour.

vercel.com/new/clone

Create Git Repository

Git Scope

Votre compte GitHub
votre-compte

Private Repository Name

kledg
CreateCreate
Votre compte GitHub dans Git Scope, le dépôt privé kledg, puis Create.

4. Ajouter Neon

Vercel demande ensuite la base de données, Neon, gratuite pour démarrer : cliquez sur Add à côté de Neon. Un panneau de réglages s’ouvre à droite.

vercel.com/new/clone

Storage

Install all the mandatory products

Add

Neon

Serverless Postgres

Add
Add, à côté de Neon, ouvre son panneau de réglages.

5. Régler la base Neon

Dans le panneau, choisissez la région Frankfurt, la plus proche des serveurs de Kledg. Désactivez l’option Auth : Kledg gère lui-même ses comptes, et Neon Auth ajouterait un second système d’authentification inutile.

vercel.com/new/clone · Neon
Configuration and Plan

Region (required)

Frankfurt
Frankfurt, Germany (West)fra1

Choose your database region

Désactiver

Auth

Provide built-in authentication for app users, with profiles synced to Postgres.

Région Frankfurt, option Auth désactivée.

Sous Installation Plans, gardez l’offre Free : elle suffit pour démarrer et ne demande pas de carte bancaire.

vercel.com/new/clone · Neon

Installation Plans

Free

Free Free

Neon's generous free tier, no credit card required.

Storage
1 GB per project
Maximum projects
100
Sizes up to
2 CU, 8 GB RAM
Compute time
100 CU-hours per project
L’offre Free suffit pour démarrer, sans carte bancaire.

À l’étape Confirmation, remplacez le nom tiré au hasard dans Resource Name par un nom reconnaissable, comme kledg : c’est sous ce nom que la base apparaît dans Vercel et dans Neon. Cliquez sur Create.

vercel.com/new/clone · Neon
Confirmation

Resource Name

Renommer
neon-copper-prismkledg

This is how we call your Database in the Vercel dashboard and in Neon.

Parameters

RegionFrankfurt, Germany (West) fra1
AuthFalse
BackCreate
Un nom reconnaissable, puis Create.

6. Coller les deux variables

Tout en bas de la page, dans Add Environment Variables, collez une valeur dans chaque champ. Le guide flottant vous les donne, chacune avec un bouton Copier ; sans lui, générez le secret ici :

  • BETTER_AUTH_SECRET : un secret aléatoire. Cliquez sur Générer ci-dessous et collez la valeur dans Vercel. Gardez-la : elle protège aussi les accès bancaires enregistrés.
  • ADMIN_EMAIL : votre adresse email, la seule autorisée à créer le compte administrateur.
vercel.com/new/clone

Add Environment Variables

Provide values for the required Environment Variables.

NameValueBETTER_AUTH_SECRET
Générer, coller
Collez la valeur générée Générer
ADMIN_EMAIL
Votre email
vous@votre-societe.fr
Deploy
Deux variables seulement. Le secret se génère dans votre navigateur, sur une page à part.

7. Deploy

Cliquez sur Deploy. Pendant la construction, Kledg crée automatiquement les tables de la base. À la fin, Vercel vous renvoie vers une page qui récapitule la suite.

Le stockage des justificatifs

Le bouton crée aussi un magasin Vercel Blob privé, où Kledg range les photos et PDF des justificatifs : rien à configurer, Kledg le détecte. Le magasin est privé : un justificatif ne s’ouvre que depuis Kledg, après vérification de vos droits. Sauvegardez ce magasin en plus de la base.

Pour une instance installée avant Kledg 0.4.0 : dans Vercel, ouvrez le projet, Storage, Create Storage, Blob, accès Private, région Frankfurt, et reliez-le au projet. Après la mise à jour en 0.4.0, définissez KLEDG_STORAGE_MIGRATE=on le temps d’un déploiement pour y déplacer les justificatifs déjà enregistrés, puis retirez la variable. Sans magasin, les justificatifs restent dans la base de données.

Créer le compte administrateur

À la fin du déploiement, Vercel vous renvoie vers kledg.com, qui transmet l’adresse de votre instance au guide de déploiement. Le guide affiche alors le lien d’installation, https://<votre-instance>/setup?token=… : il ouvre la page de configuration, où vous choisissez votre nom et votre mot de passe. L’email est celui de ADMIN_EMAIL.

Le jeton du lien est calculé à partir de BETTER_AUTH_SECRET, dans votre navigateur : seul celui qui connaît le secret peut le produire, et il ne sert plus une fois le compte créé. Ce compte administre l’instance : il crée les sociétés et donne accès aux autres utilisateurs.

Vous avez déployé sans le guide, ou fermé sa fenêtre ? Calculez le lien ici, à partir de l’adresse de l’instance et de son BETTER_AUTH_SECRET (onglet Settings, Environment Variables du projet Vercel). Rien n’est envoyé :

Le lien se calcule sur une page à part, sans outil de mesure d’audience ni script tiers, qui ne peut rien envoyer : votre secret ne quitte pas votre navigateur.

Calculer mon lien d’installation

Sur les autres hébergeurs, vous pouvez aussi définir SETUP_TOKEN, un jeton d’au moins 16 caractères (openssl rand -base64 24 Générer), puis ouvrir /setup?token=<SETUP_TOKEN> : s’il est défini, c’est le seul jeton accepté.

Ajouter les emails

Kledg envoie des emails pour les invitations et les mots de passe oubliés. En attendant, l’ajout d’un membre affiche un mot de passe temporaire à lui transmettre. Resend n’est pas dans le bouton de déploiement : tant que son domaine n’est pas vérifié, il bloquerait le déploiement. Ajoutez-le une fois Kledg en ligne :

  1. dans le projet Vercel, onglet Storage, ajoutez Resend : acceptez ses conditions d’utilisation, gardez l’offre gratuite et tapez le domaine d’où partiront les emails, par exemple votre-societe.fr ;
  2. ouvrez Domains, ajoutez le domaine (Add) et revendiquez-le (claim ownership) : Vercel indique l’enregistrement DNS à créer chez votre registraire (OVH, Gandi, Ionos…) ;
  3. une fois le domaine vérifié, renseignez EMAIL_FROM, par exemple Kledg <compta@votre-societe.fr>, puis redéployez.

Changer l’adresse email d’un utilisateur

Avec les emails, chacun change sa propre adresse depuis son profil, confirmée par un lien. Sans eux, seul l’administrateur de l’instance peut changer une adresse. Le pas à pas : Changer l’adresse email d’un utilisateur.

Utiliser votre propre domaine

Par défaut, votre instance répond à l’adresse que lui donne l’hébergeur (par exemple l’URL de production Vercel). Pour utiliser votre domaine, comme compta.votre-societe.fr, ajoutez-le dans le projet Vercel puis définissez BETTER_AUTH_URL : voir Utiliser son propre domaine, qui dit aussi quoi mettre à jour pour Revolut Business et vos assistants IA.

Sur un autre hébergeur

Chaque hébergeur a son guide pas à pas. Pour comparer les options, voir Choisir son hébergement.

Railway, Render, Fly.io ou Clever Cloud

Docker, Coolify ou Dokploy

Sur votre propre serveur, le fichier docker-compose.yml du dépôt lance Kledg et sa base PostgreSQL. Renseignez les variables dans un fichier .env (dont BETTER_AUTH_URL, obligatoire ici), lancez docker compose up -d --build, puis placez un reverse proxy HTTPS devant l’application. Coolify et Dokploy lisent le même fichier. Le pas à pas : Héberger Kledg avec Docker.

Mettre à jour

Kledg se met à jour depuis l’application : menu du compte, Paramètres, puis Mises à jour. La page indique la version installée, la dernière version publiée, ses nouveautés et les migrations de la base qu’elle apporte. Une fois GitHub connecté, la mise à jour se fait en deux clics sur Vercel, et sur les autres hébergeurs qui redéploient depuis GitHub ; ailleurs, la page affiche les commandes à lancer. Sans rien faire, votre dépôt reçoit aussi chaque lundi une pull request « Mise à jour Kledg x.y.z ». Tout est détaillé dans Mettre à jour son instance.

Et ensuite

Cette documentation aide à comprendre et à utiliser Kledg. Elle ne remplace pas les conseils d’un expert-comptable : en cas de doute sur votre situation, faites-vous accompagner.