thibaud-lclr/api-client

Fork 0

thibaud-leclere 860000d0b3 fix: expose coolify production envs

2026-05-06 16:30:10 +02:00

4.6 KiB

Raw Blame History

Hoppscotch Self-Hosted

Fork interne de Hoppscotch pour déploiement self-host.

Contenu

App web : packages/hoppscotch-selfhost-web
Backend NestJS et Prisma : packages/hoppscotch-backend
Admin : packages/hoppscotch-sh-admin
Image Docker multi-target : prod.Dockerfile
Compose dev live : docker-compose.yml
Compose prod image-only : docker-compose.prod.yml

Images Docker

Les images sont buildées en local puis poussées à la main sur le registry.

Images utilisées en prod :

forge.lclr.dev/thibaud-lclr/api-client-backend:latest
forge.lclr.dev/thibaud-lclr/api-client-app:latest
forge.lclr.dev/thibaud-lclr/api-client-sh-admin:latest

Targets Docker :

backend   -> backend + Caddy backend
app       -> app web + webapp-server + Caddy app
sh_admin  -> admin + Caddy admin

Préparer l'environnement

Créer .env si besoin :

make ensure-env

Variables importantes :

POSTGRES_PASSWORD=<mot-de-passe-fort>
POSTGRES_DB=hoppscotch
DATA_ENCRYPTION_KEY=<chaine-de-32-caracteres>

VITE_BASE_URL=https://<domaine-app>
VITE_SHORTCODE_BASE_URL=https://<domaine-app>
VITE_ADMIN_URL=https://<domaine-admin>
VITE_BACKEND_GQL_URL=https://<domaine-backend>/graphql
VITE_BACKEND_WS_URL=wss://<domaine-backend>/graphql
VITE_BACKEND_API_URL=https://<domaine-backend>/v1

WHITELISTED_ORIGINS=https://<domaine-app>,https://<domaine-admin>
TRUST_PROXY=true

Pour le compose prod local, ces variables pilotent les images :

API_CLIENT_REGISTRY=forge.lclr.dev
API_CLIENT_NAMESPACE=thibaud-lclr
API_CLIENT_IMAGE_PREFIX=api-client
API_CLIENT_TAG=latest

Build et push registry

Se connecter au registry :

docker login forge.lclr.dev

Builder les trois images en latest :

make docker-build-images TAG=latest

Pousser les trois images :

make docker-push-images TAG=latest

Faire les deux en une commande :

make docker-build-push-images TAG=latest

Pour publier un tag de test :

make docker-build-push-images TAG=fork-v1.0.0

Déploiement prod

La prod utilise uniquement docker-compose.prod.yml.

Ce compose ne contient pas de build:. Il tire les images du registry.

Sur Coolify, docker-compose.prod.yml est la source de vérité des variables d'environnement. Les variables sont déclarées dans les blocs environment: des services pour que Coolify les crée dans son UI au chargement du compose. Il ne faut pas compter sur un fichier .env du dépôt en prod : il est ignoré par Git.

Variables générées/préremplies pour Coolify :

SERVICE_PASSWORD_POSTGRES : mot de passe PostgreSQL partagé entre la base et le backend
SERVICE_BASE64_DATA_ENCRYPTION_KEY : clé stable de 32 caractères pour DATA_ENCRYPTION_KEY
SERVICE_URL_HOPPSCOTCH_APP : URL publique de l'app
SERVICE_URL_HOPPSCOTCH_ADMIN : URL publique de l'admin
SERVICE_URL_HOPPSCOTCH_BACKEND : URL publique du backend
SERVICE_FQDN_HOPPSCOTCH_BACKEND : domaine du backend, utilisé pour VITE_BACKEND_WS_URL

Après l'import du compose dans Coolify, vérifier au minimum que les trois URLs publiques correspondent aux domaines assignés aux services app, admin et backend.

Démarrer avec le tag latest :

make prod-up

Démarrer avec un autre tag :

make prod-up TAG=fork-v1.0.0

Voir les logs :

make prod-logs

Voir l'état des services :

make prod-ps

Arrêter :

make prod-down

Services prod :

hoppscotch-db : PostgreSQL 15 avec volume persistant
hoppscotch-backend : backend + migrations Prisma au démarrage
hoppscotch-app : app web self-host
hoppscotch-sh-admin : admin

Ports prod :

3000 : app web
3100 : admin
3170 : backend
3200 : serveur de bundles webapp

Développement local

Le compose dev est docker-compose.yml.

Il build une image de base locale et monte le repo en volume.

Démarrer :

make dev-up

Alias :

make up

Voir les logs :

make dev-logs

Voir l'état :

make dev-ps