feat: prepare isolated ZITADEL v4 local backend (Docker verification pending)

This commit is contained in:
Vib Tools committed 2026-11-22 04:02:48 -08:00
1 parent 8f54ccb304
commit 433a0a32f8
9 files changed
+500 -68

No files matched your search

+29 -27
View File
@@ -1,39 +1,41 @@
# ZitPlane
A compact, developer-friendly monorepo for central identity, branded sign-in, and account self-service.
Compact, developer-friendly monorepo for a central identity service, a branded login frontend and an independent user self-service account portal.
**Status:** Phase 01 — repository foundation only. No backend, login app, account portal, or Docker stack has been installed yet.
## Current phase status
- **P01 Foundation:** complete, initial commit `8f54ccb`.
- **P02 ZITADEL local backend:** pinned official images, development Compose, secure local bootstrap helper and focused static tests implemented. **Docker startup and Admin Console integration remain unverified** because the connected Windows PC has no Docker CLI.
- **P03 Login V2 source / P04 Account Portal:** not started.
- **Production / Coolify:** not configured or deployed.
## Planned components
## Responsibility map
| Path | Responsibility |
| Path | Purpose |
| --- | --- |
| `core/backend/zitadel/` | Version-pinned official ZITADEL backend configuration; **not** a copy of its Go source |
| `auth/ui/v2/` | Customizable official Login V2 frontend, with required upstream build dependencies |
| `users/ui/` | Separate account management portal |
| `packages/` | Shared UI and generated/API clients, only when actually needed |
| `deployment/` | Compose, reverse proxy, deployment configuration |
| `scripts/` | Simple documented local developer entrypoints |
| `tests/` | Focused integration and UI regression tests |
| `docs/` | Architecture, development guide, phase scopes |
| `core/backend/zitadel/` | Official ZITADEL backend integration and local helper |
| `deployment/docker/compose.backend.dev.yaml` | Loopback-only developer stack |
| `auth/ui/v2/` | Future customized official Login V2 source (P03) |
| `users/ui/` | Future account self-service portal (P04) |
| `packages/` | Shared packages only when needed |
| `tests/` | Focused contracts and future integration/UI tests |
| `docs/` | Architecture, scopes and developer instructions |
## Planned domains
## Local development (requires Docker Desktop Linux containers)
- `auth.vib.tools` — ZITADEL OIDC/API, sign-in UI, built-in management console.
- `account.vib.tools` — customer self-service account portal.
```powershell
py core/backend/zitadel/dev.py init
py core/backend/zitadel/dev.py config
py core/backend/zitadel/dev.py up
```
These domains are design targets; they are **not deployed or configured yet**.
When the backend stack is actually running, the local Admin Console is expected at `http://localhost:8080/ui/console`. This is **not** a currently verified working URL. See [backend setup](core/backend/zitadel/README.md) and [developer guide](docs/DEVELOPMENT.md).
## Ground rules
## Intended public architecture (not deployed)
- One Git repository, multiple isolated Docker services at runtime.
- ZITADEL stays upstream and version-pinned; no fork of its Go backend is planned.
- Dev/prod data and credentials stay separate. No secrets in Git.
- ZITADEL handles identity; individual SaaS products handle plans, billing and product data.
- One approved, scope-locked phase at a time. See [phases](docs/PHASES.md) and [agent rules](AGENTS.md).
- `auth.vib.tools`: eventual ZITADEL API, official Console, customized login.
- `account.vib.tools`: future custom account portal.
- Individual SaaS applications own their own billing, subscriptions and business databases.
- One Git repo, isolated containers; ZITADEL Go source remains upstream.
## Start here
1. Read [architecture](docs/ARCHITECTURE.md) and [development](docs/DEVELOPMENT.md).
2. Approve Phase 02 before adding ZITADEL or any Docker startup configuration.
3. Do not run an application from this foundation-only scaffold; none has been installed.
## Working agreements
Read [AGENTS.md](AGENTS.md), [architecture](docs/ARCHITECTURE.md) and [phase scopes](docs/PHASES.md). Use separate, expressly approved phases; no production secrets or user data in Git.