- TypeScript 64.6%
- Svelte 33.2%
- JavaScript 0.8%
- CSS 0.8%
- Dockerfile 0.3%
- Other 0.3%
|
|
||
|---|---|---|
| .claude | ||
| .forgejo/workflows | ||
| apps | ||
| docker | ||
| docs | ||
| packages | ||
| .dockerignore | ||
| .editorconfig | ||
| .env.example | ||
| .env.prod.example | ||
| .gitattributes | ||
| .gitignore | ||
| .nvmrc | ||
| .prettierignore | ||
| .prettierrc.json | ||
| CLAUDE.md | ||
| docker-compose.prod.yml | ||
| docker-compose.yml | ||
| eslint.config.js | ||
| package.json | ||
| pnpm-lock.yaml | ||
| pnpm-workspace.yaml | ||
| README.md | ||
| tsconfig.base.json | ||
| turbo.json | ||
Branding Studio
Plateforme interne du Studio Eliophot pour publier les maquettes HTML (exports zip) et les partager aux clients par un lien stable, éventuellement protégé par mot de passe.
- Back-office :
https://branding.eliophot.com - API :
https://api.branding.eliophot.com - Liens client :
https://preview.branding.eliophot.com/{slug}/latest/(ou/{slug}/v{n}/pour une version précise)
Les décisions d'architecture sont dans docs/adr/, la référence développeur dans CLAUDE.md.
Prérequis
- Node 24, pnpm 10 (
corepack enable) - Docker (Postgres de dev, images de prod)
Démarrer en local
pnpm install
cp .env.example .env # puis remplacez les valeurs CHANGE_ME / dev-only si besoin
docker compose up -d postgres # Postgres 18 sur le port 5433
pnpm --filter @studio/db db:migrate
pnpm --filter @studio/api user:create --email vous@eliophot.com --name "Votre nom" --role admin
pnpm dev
- Back-office : http://localhost:5173
- API : http://localhost:3000 (Swagger : http://localhost:3000/docs)
- Previews : http://preview.localhost:3000/{slug}/latest/ (les navigateurs résolvent
*.localhosten local)
Tout conteneurisé (hot reload par polling, plus lent sous Windows) : docker compose up.
Commandes
| Commande | Rôle |
|---|---|
pnpm dev |
API + back-office en watch |
pnpm lint, pnpm typecheck, pnpm test, pnpm build |
ce que la CI exécute |
pnpm format / pnpm format:check |
Prettier |
pnpm --filter @studio/db db:generate |
génère une migration après modification de packages/db/src/schema.ts |
pnpm --filter @studio/db db:migrate |
applique les migrations (DATABASE_URL) |
pnpm --filter @studio/api user:create |
crée un compte (--email, --name, --role admin, editeur ou commun, --password) |
pnpm --filter @studio/api fixtures |
écrit les zips de test dans storage/fixtures/ |
Les tests d'intégration ont besoin d'un Postgres joignable : ils créent et migrent eux-mêmes studio_test_db et studio_test_api (TEST_DATABASE_URL_BASE, défaut postgres://studio:studio@localhost:5433).
Variables d'environnement
| Variable | Service | Rôle |
|---|---|---|
DATABASE_URL |
api | connexion PostgreSQL |
ADMIN_ORIGIN |
api | origine du back-office (https://branding.eliophot.com) : CORS, CSRF, cookie Secure |
API_ORIGIN |
api | origine publique de l'API (https://api.branding.eliophot.com) |
PREVIEW_ORIGIN |
api | origine des liens client (https://preview.branding.eliophot.com) ; les requêtes sur cet hôte sont des previews |
COOKIE_DOMAIN |
api | domaine du cookie de session, commun à l'admin et à l'API (branding.eliophot.com) ; vide en dev |
STORAGE_ROOT |
api | dossier des zips et fichiers extraits (volume persistant) |
PREVIEW_PASSWORD_KEYS |
api | clés AES-256 id:base64(32 octets) séparées par des virgules ; la première chiffre, toutes déchiffrent |
PREVIEW_COOKIE_SECRET |
api | signature des cookies d'accès client (≥ 32 caractères) |
IP_HASH_SALT |
api | sel du hash des IP dans les journaux de consultation (≥ 16 caractères) |
PREVIEW_FRAME_ANCESTORS |
api | sources autorisées à encadrer les previews (self par défaut) |
ZIP_MAX_BYTES, ZIP_MAX_FILES, ZIP_MAX_UNCOMPRESSED_BYTES, ZIP_MAX_RATIO |
api | limites d'ingestion (200 Mo, 2000, 1 Go, 100) |
SESSION_TTL_DAYS, LOGIN_MAX_ATTEMPTS |
api | sessions admin (7 jours, 5 échecs / 15 min) |
BREVO_API_KEY, BREVO_SENDER_EMAIL, BREVO_SENDER_NAME |
api | e-mails « mot de passe oublié » (sans clé : rien n'est envoyé) ; expéditeur noreply@eliophot.com, à valider dans Brevo |
PASSWORD_RESET_TTL_MINUTES |
api | validité du lien de réinitialisation (60 min) |
LOG_LEVEL, PORT |
api | pino, port d'écoute (3000) |
PUBLIC_API_ORIGIN |
web | origine de l'API appelée par le navigateur (https://api.branding.eliophot.com) |
API_INTERNAL_URL |
web | URL de l'API vue depuis le conteneur web (http://branding-studio-api:3000, alias unique) |
PROTOCOL_HEADER, ADDRESS_HEADER, XFF_DEPTH |
web | déjà fixés dans l'image (x-forwarded-proto, x-forwarded-for, 1) : SvelteKit déduit l'origine publique des en-têtes Traefik |
PORT |
web | port d'écoute (3001) |
Générer une clé ou un secret : node -e "console.log(require('crypto').randomBytes(32).toString('base64'))".
Déploiement sur Dokploy
Les images sont produites par la CI sur main et poussées sur le registry Forgejo (paquets privés de l'organisation) : git.eliophot.dev/eliophot/branding/api et .../web, tags latest et <sha>. Elles se construisent aussi à la main depuis la racine :
docker build -f docker/api.Dockerfile -t studio-api .
docker build -f docker/web.Dockerfile -t studio-web .
0. Secrets de CI
Le job images pousse sur le registry avec deux secrets du dépôt Forgejo (Paramètres → Actions → Secrets) : REGISTRY_USERNAME (un compte membre de l'organisation eliophot) et REGISTRY_TOKEN (jeton d'accès de ce compte avec la permission package: write). Le jeton automatique des Actions ne peut pas écrire les paquets de l'organisation.
1. Registry et base de données
- Déclarez
git.eliophot.devcomme registry dans Dokploy avec un compte et un jetonpackage: read: les paquets sont privés. - Créez un service Postgres 18 dans Dokploy (ou utilisez une instance existante) et notez son
DATABASE_URL; le compose de production ne l'embarque pas.
2. Application Compose
Créez une application Compose pointant sur docker-compose.prod.yml (modèle de variables : .env.prod.example). Variables obligatoires : DATABASE_URL, PREVIEW_PASSWORD_KEYS, PREVIEW_COOKIE_SECRET, IP_HASH_SALT. Les trois origines et COOKIE_DOMAIN ont branding.eliophot.com pour défaut.
Onglet Domaines, trois lignes, toutes avec le chemin / :
| Hôte | Service | Port |
|---|---|---|
branding.eliophot.com |
web |
3001 |
api.branding.eliophot.com |
api |
3000 |
preview.branding.eliophot.com |
api |
3000 |
Les services sont attachés au réseau dokploy-network par le compose : c'est par lui que Traefik les joint. Ce réseau est partagé par tous les projets Dokploy : le web ne doit jamais y joindre l'API par le nom api (le DNS Docker peut répondre le service api d'un autre projet, d'où des sessions « perdues » et des 500 aléatoires) ; il passe par l'alias branding-studio-api, déclaré sur le réseau interne du projet. Le volume studio_storage (monté sur /data) contient tous les zips et fichiers extraits : à sauvegarder avec la base.
Les migrations sont jouées automatiquement au démarrage du conteneur api (étape idempotente, verrou Postgres).
3. Premier compte
Renseignez SEED_ADMIN_EMAIL et SEED_ADMIN_PASSWORD (12 caractères minimum, SEED_ADMIN_NAME optionnel) : l'API crée ce compte admin à son démarrage s'il n'existe pas encore, et ne le modifie jamais ensuite (changer la variable ne change pas le mot de passe). Les autres comptes se gèrent depuis la section « Utilisateurs » du back-office (réservée aux admins : création avec mot de passe généré, rôle admin ou commun, réinitialisation, suppression), ou en ligne de commande depuis un shell du conteneur api :
node dist/cli/user-create.js --email vous@eliophot.com --name "Votre nom" --role admin
4. Vérifications
https://api.branding.eliophot.com/health→{"status":"ok","checks":{"database":"up","storage":"up"}}https://branding.eliophot.com/→ page de connexion ;https://branding.eliophot.com/healthz→okhttps://preview.branding.eliophot.com/robots.txt→Disallow: /;https://preview.branding.eliophot.com/→ redirection vers le back-office- Après un premier upload : le lien
latestdu projet s'ouvre surpreview.branding.eliophot.com, et la page affiche l'en-têteContent-Security-Policy: sandbox …. - Connecteur MCP :
https://api.branding.eliophot.com/.well-known/oauth-authorization-serverrépond en JSON,POST https://api.branding.eliophot.com/mcpsans jeton répond401avecWWW-Authenticate; ajouter le connecteur dans Claude (voir docs/mcp.md).
Rotation des secrets
- Mot de passe des previews : ajoutez une nouvelle clé en tête de
PREVIEW_PASSWORD_KEYSen conservant les anciennes ; les projets sont re-chiffrés à leur prochaine modification. PREVIEW_COOKIE_SECRET: le changer déconnecte tous les clients (ils ressaisissent le mot de passe).- Les sessions admin sont en base : supprimer les lignes de
sessionsdéconnecte tout le monde. - Connecteur MCP : supprimer les lignes de
mcp_connectionscoupe tous les clients MCP (ils se reconnectent par OAuth).PREVIEW_COOKIE_SECRETsigne aussi les liens de téléchargement et de dépôt du connecteur (15 min / 1 h).
Pas couvert en V1
Commentaires clients, driver S3, expiration des liens, comparaison visuelle, notifications, tests end-to-end navigateur (Playwright).