La configuration technique de KiwiDesk se fait dans le fichier .env placé à côté de
docker-compose.yml (ou dans les variables de la stack Portainer). Le modèle .env.example du
dépôt contient toutes les variables avec un commentaire. Les réglages métier (boutiques, TVA,
messages, matériel) ne sont pas ici : ils se font dans l’application, menu Paramètres.
Après toute modification du fichier, appliquez-la avec
docker compose -f docker-compose.yml up -d : seuls les conteneurs concernés redémarrent.
Mode d’exécution. Les conteneurs tournent toujours en production ; la valeur du fichier ne sert qu’à un lancement depuis les sources.
APP_PUBLIC_URL
http://localhost:3000
Adresse que les utilisateurs tapent dans leur navigateur. Sert aux liens des e-mails et SMS, aux QR codes de suivi, aux adresses de retour OAuth et aux cookies.
WEB_PORT
3000
Port du serveur sur lequel le service web est publié.
KIWIDESK_IMAGE_PREFIX
ghcr.io/kaipicpic/kiwidesk
Début du nom des images. À changer seulement si vous publiez vos propres images.
KIWIDESK_VERSION
latest
Version des images : latest, une version (1.2.0) ou un commit (sha-1a2b3c4).
Port de l’API, publié sur 127.0.0.1 du serveur seulement.
API_INTERNAL_URL
http://api:4000
Adresse de l’API vue par le service web. Fixée par le fichier compose ; ne sert que hors Docker.
CORS_ORIGINS
http://localhost:3000
Origines autorisées à appeler l’API, séparées par des virgules. Mettez-y la valeur de APP_PUBLIC_URL.
TRUST_PROXY
1
Proxys dont l’API croit l’en-tête X-Forwarded-For. Dans Docker, 1 (le service web). Jamais true ni uniquelocal. Voir Reverse proxy et HTTPS.
WEB_TRUSTED_PROXIES
vide
Adresses ou plages CIDR de votre reverse proxy, dont le service web croit l’en-tête X-Forwarded-For. Vide : l’adresse de la connexion est celle du client.
SWAGGER_ENABLED
false
Documentation interactive de l’API sur /api/docs (port de l’API, donc depuis le serveur seulement). Laissez false en production.
LOG_LEVEL
log
Niveau de détail du journal : error, warn, log, debug ou verbose.
Clé maîtresse AES-256-GCM (32 octets en base64) qui chiffre les codes de déverrouillage, les secrets de double authentification, les mots de passe SMTP, IMAP et SMS, les clés des intégrations. Obligatoire.
ENCRYPTION_KEY_VERSION
1
Numéro de la clé actuelle, enregistré avec chaque valeur chiffrée.
ENCRYPTION_PREVIOUS_KEYS
vide
Anciennes clés gardées pour relire les données, sous la forme <version>:<clé>,.... Ne sert que pendant une rotation de clé.
JWT_ACCESS_SECRET
aucun
Secret de signature des jetons de session courts. Obligatoire.
JWT_ACCESS_TTL
15m
Durée de vie d’un jeton de session court.
JWT_REFRESH_SECRET
aucun
Secret des jetons de renouvellement, différent du précédent. Obligatoire.
JWT_REFRESH_TTL_DAYS
30
Durée maximale d’une session sans nouvelle connexion, en jours.
COOKIE_SECURE
false
true dès que KiwiDesk est servi en HTTPS : les cookies de session ne partent alors jamais en clair.
Ces variables définissent un serveur d’envoi commun, utilisé par les boutiques qui n’ont pas
configuré le leur dans Paramètres > Communications & SMS. Voir
E-mail : SMTP et IMAP.
Variable
Défaut
Rôle
SMTP_HOST
vide
Serveur SMTP. Vide : pas de serveur d’instance.
SMTP_PORT
587
Port du serveur.
SMTP_SECURE
false
true pour une connexion TLS directe (port 465).
SMTP_USER
vide
Identifiant.
SMTP_PASSWORD
vide
Mot de passe.
SMTP_FROM
KiwiDesk <no-reply@kiwidesk.local>
Adresse d’expédition. Le nom affiché est celui de la boutique.
Les webhooks sortants ne visent que des adresses publiques. Exceptions pour un récepteur du réseau local, séparées par des virgules : n8n.lan,192.168.1.0/24.
Son mot de passe initial. Vide : un mot de passe est généré et affiché une seule fois dans le journal de l’API. Dans les deux cas, il doit être changé à la première connexion.
SEED_STORE_NAME
Boutique principale
Nom de la première boutique.
KIWIDESK_SEED_ON_START
true
À chaque démarrage du conteneur api, applique les migrations puis complète les données de départ manquantes, sans jamais modifier l’existant.
Le super administrateur et la boutique ne sont créés que s’ils n’existent pas : changer ces
variables après le premier démarrage n’a pas d’effet.
Port du serveur sur lequel le service docs (cette documentation) est publié.
DOCS_URL
http://localhost:3080
Adresse de la documentation ouverte par le lien Documentation de l’application. Vide : le lien indique que la documentation n’est pas configurée. Voir Héberger cette documentation.
KIWIDESK_COMMIT_SHA et KIWIDESK_BUILD_DATE sont remplies lors de la construction des images
et affichées dans Paramètres > À propos / Système. Ne les renseignez pas vous-même.
Les variables KIWIDESK_SERVER_URL, KIWIDESK_PAIRING_CODE, KIWIDESK_BRIDGE_ACCESS_CODE,
KIWIDESK_BRIDGE_ALLOWED_NETWORKS, KIWIDESK_BRIDGE_REMOTE_ACCESS, KIWIDESK_BRIDGE_HOME et
KIWIDESK_BRIDGE_DEBUG concernent le Bridge installé sur le poste du comptoir, pas le serveur.
Elles sont décrites dans Installer le Bridge.