Documentation technique d'Ekylibre

Cible : la branche 5.0-beta d'ekylibre/ekylibre. Les commandes, fichiers Docker et variables d'environnement décrits ici correspondent à cette branche, qui deviendra main à la sortie de la version 5.0.

Bienvenue dans la documentation technique d'Ekylibre. Elle s'adresse aux personnes qui veulent installer, opérer ou contribuer à Ekylibre — par opposition à la documentation utilisateur qui couvre l'usage métier de l'application.

Par où commencer ?

Stack technique en un coup d'œil

Composant Version Rôle
Ruby on Rails Ruby 2.6.6 Cœur applicatif, serveur web (Puma)
Sidekiq dernière Jobs asynchrones (imports, exports, intégrations tierces)
PostgreSQL + PostGIS 13 + 2.5 Stockage relationnel et géospatial (multi-tenant via schémas)
Redis 7 Cache + file de jobs Sidekiq
Node.js + Yarn LTS (14+) Compilation assets via Webpacker
Caddy 2.x Reverse-proxy HTTPS, certificats Let's Encrypt automatiques (prod)
Docker / Compose 24+ / v2 Empaquetage et déploiement (dev, test, prod)

Conventions de cette documentation

  • Tous les chemins sont relatifs à la racine du repo ekylibre/ekylibre (sauf indication contraire).
  • Blocs de code : la première ligne précise le contexte d'exécution quand il est ambigu (hôte vs container, dev vs prod).
  • Admonitions : > Note : information complémentaire utile. > Attention : point à ne pas manquer sous peine d'erreur.

Cette documentation est open-source. Aidez-nous à l'améliorer en ouvrant une issue ou une pull request.