diff --git a/README.md b/README.md new file mode 100644 index 0000000..64f042f --- /dev/null +++ b/README.md @@ -0,0 +1,87 @@ +# dopbase-docker + +Déploiement de [Dopbase](https://github.com/dopbase/dopbase) en docker-compose. Le dépôt upstream ne fournit pas de Dockerfile de production : l'image est construite ici depuis les sources. + +Testé : build OK et conteneur `healthy` avec `DOPBASE_REF=0.1.10`. + +## Contenu + +| Fichier | Rôle | +|---|---| +| `Dockerfile` | Build multi-stage depuis les sources GitHub | +| `docker-compose.yml` | Service `dopbase`, volume `dopbase-data`, healthcheck | +| `.env.example` | Variables à copier dans `.env` | + +## Installation + +```bash +git clone git@gitea.vlab.bzh:vLab-BZH/dopbase-docker.git +cd dopbase-docker +cp .env.example .env +# éditer .env : DOPBASE_REF=0.1.10 (version figée, recommandé), DOPBASE_PUBLIC_URL, etc. +docker compose up -d --build +``` + +Les tags upstream n'ont **pas** de préfixe `v` : utiliser `DOPBASE_REF=0.1.10`, pas `v0.1.10`. `main` construit la dernière version de développement. + +### Premier démarrage + +```bash +docker compose logs dopbase +``` + +Au premier démarrage, Dopbase affiche dans les logs un token / lien de setup. L'interface d'admin redirige vers `/setup` tant que le compte root n'est pas créé. + +Alternative : renseigner `DOPBASE_ROOT_EMAIL` dans `.env` avant le premier démarrage. Le compte root est alors créé directement, avec un mot de passe généré affiché **une seule fois** dans les logs. + +### Vérification + +```bash +docker compose ps # état healthy attendu +curl http://localhost:8840/api/v1/health +``` + +## Variables (`.env`) + +| Variable | Défaut | Description | +|---|---|---| +| `DOPBASE_REF` | `main` | Branche ou tag de `dopbase/dopbase` à construire | +| `DOPBASE_PORT` | `8840` | Port publié sur l'hôte | +| `DOPBASE_PUBLIC_URL` | `http://localhost:8840` | URL vue par les clients (lien de setup, CLI). À adapter derrière un reverse proxy | +| `DOPBASE_ROOT_EMAIL` | vide | Optionnel : crée le root sans passer par le setup web | +| `DOPBASE_TRUSTED_PROXIES` | vide | IP/CIDR du reverse proxy, pour des logs d'audit corrects | + +## Architecture du Dockerfile + +Build multi-stage en 4 étapes : + +``` +┌──────────────┐ ┌──────────────────┐ ┌────────────────────┐ ┌──────────────────────┐ +│ 1. src │──▶│ 2. admin-ui │──▶│ 3. builder │──▶│ 4. runtime │ +│ alpine/git │ │ oven/bun:1 │ │ rust:1.98-bookworm │ │ debian:bookworm-slim │ +│ git clone │ │ bun build:ui │ │ cargo build │ │ binaire seul │ +│ DOPBASE_REF │ │ → dist/ (Vite) │ │ UI embarquée │ │ user dopbase (10001) │ +└──────────────┘ └──────────────────┘ └────────────────────┘ └──────────────────────┘ +``` + +1. **src** : clone shallow de `github.com/dopbase/dopbase` à la ref `DOPBASE_REF`. +2. **admin-ui** : installation des dépendances (`bun install --frozen-lockfile`) et build de l'UI d'admin (Vue/Vite) vers `dist/`. +3. **builder** : compilation du binaire Rust en release (`--locked`), avec `dist/` embarqué dans le binaire. Disposition reprise de `app/Dockerfile.test` upstream. +4. **runtime** : Debian slim avec `ca-certificates` uniquement, binaire copié dans `/usr/local/bin/dopbase`, exécution en utilisateur non-root `dopbase` (UID 10001). Écoute sur `0.0.0.0:8840`, données dans `/data`. Commande : `dopbase server start`. + +L'image finale ne contient ni toolchain Rust, ni Bun, ni les sources. + +## Données et sauvegarde + +Le volume `dopbase-data` (`/data`) contient la base SQLite, `master.key` et les sauvegardes `.dop`. Sauvegarder le volume, et conserver `master.key` **séparément** de la base. + +## Exposition réseau + +Par défaut le port est publié sur toutes les interfaces de l'hôte. Pour un accès réseau, placer un reverse proxy TLS devant (recommandé par la doc upstream) et renseigner `DOPBASE_PUBLIC_URL` et `DOPBASE_TRUSTED_PROXIES`. Pour limiter à l'hôte local, préfixer le mapping par `127.0.0.1:` dans `docker-compose.yml`. + +## Mise à jour + +```bash +# changer DOPBASE_REF dans .env, puis +docker compose up -d --build +``` diff --git a/docker-compose.yml b/docker-compose.yml index 96400f7..a1067a6 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -3,7 +3,7 @@ services: build: context: . args: - # branche ou tag du depot dopbase/dopbase (ex: main, v0.1.10) + # branche ou tag du depot dopbase/dopbase (ex: main, 0.1.10 : tags sans prefixe v) DOPBASE_REF: ${DOPBASE_REF:-main} image: dopbase:local container_name: dopbase