Ronni Baslund
22b2583f0b
O.0 prep from OPERATOR-PLAN.md. Mechanical refactor before adding partner management and operator-specific endpoints. The service now owns more than just provisioning orchestration (it'll soon own partners, tenant lifecycle actions, multi-audience JWT validation), so the name 'platform-api' reflects its scope better. What changed: - Directory: services/provisioning/ -> services/platform-api/ - Package: @dezky/provisioning -> @dezky/platform-api - Docker: container_name dezky-provisioning -> dezky-platform-api; compose service key 'provisioning' -> 'platform-api'; volume provisioning_node_modules -> platform_api_node_modules - Portal: PROVISIONING_INTERNAL_URL env var -> PLATFORM_API_INTERNAL_URL, default URL http://provisioning:3001 -> http://platform-api:3001 in all three proxy routes (me.get.ts, tenants/index.post.ts, tenants/[slug]/ reconcile.post.ts), plus NUXT_API_BASE updated - Health endpoint service identifier and main.ts log lines updated to 'dezky-platform-api' - Docs swept: README, CLAUDE.md, SERVICES.md, AUTHENTIK-SETUP.md, NEXT-STEPS.md, TROUBLESHOOTING.md, OPERATOR-PLAN.md, traefik/dynamic.yml What deliberately stays: - Internal module names ProvisioningService / ProvisioningModule (those describe an orchestration sub-concern, not the service's purpose) - Tenant.provisioningStatus / provisioningErrors field names (state per integration, not service name) - File services/platform-api/src/tenants/provisioning.service.ts - 'Hetzner provisioning' references in production-prep docs (infrastructure provisioning, unrelated) Verified end-to-end after rename: /api/me returns 200 with profile + 2 tenants + subscription, /api/tenants/dezky/reconcile returns 200 with Authentik integration still ok. OPERATOR-PLAN.md O.0 checkboxes ticked.
116 lines
3.6 KiB
Markdown
116 lines
3.6 KiB
Markdown
# Dezky
|
|
|
|
> Sovereign workspace platform for European businesses.
|
|
> Mail, files, calendar, video meetings — all EU-hosted, all open source.
|
|
|
|
## Quick start (local development)
|
|
|
|
```bash
|
|
# 1. Clone and enter
|
|
git clone <repo-url> dezky
|
|
cd dezky
|
|
|
|
# 2. Run bootstrap (handles everything)
|
|
./scripts/bootstrap.sh
|
|
|
|
# 3. Open the portal
|
|
open https://app.dezky.local
|
|
```
|
|
|
|
The bootstrap script:
|
|
- Checks prerequisites (Docker, mkcert, openssl)
|
|
- Generates wildcard TLS certificate via mkcert
|
|
- Adds /etc/hosts entries (with your permission)
|
|
- Generates secure random secrets in `.env`
|
|
- Pulls Docker images
|
|
- Starts all services in correct order
|
|
- Prints next-step instructions
|
|
|
|
## Service URLs (local development)
|
|
|
|
| Service | URL | Purpose |
|
|
|---------|-----|---------|
|
|
| Portal | https://app.dezky.local | Customer-facing landing & launcher |
|
|
| Authentik | https://auth.dezky.local | Identity provider (OIDC/SAML) |
|
|
| Files (OCIS) | https://files.dezky.local | File storage & sharing |
|
|
| Mail (Stalwart) | https://mail.dezky.local | Mail server admin UI |
|
|
| Office | https://office.dezky.local | Collabora Online editor |
|
|
| Traefik | https://traefik.dezky.local | Reverse proxy dashboard |
|
|
|
|
## What's in this repo
|
|
|
|
```
|
|
dezky/
|
|
├── apps/portal/ Nuxt 3 customer portal
|
|
├── services/platform-api/ NestJS service · tenants, partners, users, provisioning orchestration
|
|
├── packages/ Shared TypeScript libraries
|
|
├── infrastructure/
|
|
│ └── docker-compose/ Local development stack
|
|
├── scripts/ Setup, reset, helpers
|
|
└── docs/ Service references & guides
|
|
```
|
|
|
|
## Prerequisites
|
|
|
|
- macOS or Linux (Windows users: use WSL2)
|
|
- Docker Desktop 24+ or OrbStack
|
|
- mkcert (`brew install mkcert`)
|
|
- pnpm 9+ (`brew install pnpm`)
|
|
- Node.js 20+
|
|
- 16 GB RAM recommended
|
|
|
|
## Common commands
|
|
|
|
```bash
|
|
# Start everything
|
|
docker compose -f infrastructure/docker-compose/docker-compose.yml up -d
|
|
|
|
# View logs
|
|
docker compose -f infrastructure/docker-compose/docker-compose.yml logs -f [service]
|
|
|
|
# Stop everything (keeps data)
|
|
docker compose -f infrastructure/docker-compose/docker-compose.yml down
|
|
|
|
# Nuke and restart (DESTROYS DATA)
|
|
./scripts/reset.sh
|
|
```
|
|
|
|
## Architecture
|
|
|
|
This is a multi-tenant SaaS platform. Each tenant gets:
|
|
- Isolated Authentik OIDC tenant
|
|
- Custom subdomain (e.g. `customer-name.dezky.local`)
|
|
- Mail domain in Stalwart with auto-generated DKIM
|
|
- Dedicated OCIS space hierarchy
|
|
- Branded launcher in the portal
|
|
|
|
All components are Apache 2.0 / MIT licensed — no per-seat fees, full whitelabel rights.
|
|
|
|
## Production
|
|
|
|
The production target is a single Hetzner AX41-NVMe server (€39/mo) with:
|
|
- Stalwart on bare-metal
|
|
- k3s for all other services
|
|
- Hetzner Object Storage (€5/mo) as OCIS S3 backend
|
|
- Storage Box BX11 (€3.20/mo) for Restic backups
|
|
- Storage Box BX11 in Helsinki (€3.20/mo) for DR
|
|
|
|
See `docs/PRODUCTION-DEPLOYMENT.md` (TBD) for migration plan.
|
|
|
|
## Stack rationale
|
|
|
|
These choices are deliberate after extensive license/architecture research. See `CLAUDE.md` for the full reasoning.
|
|
|
|
| Component | License | Why this one |
|
|
|-----------|---------|--------------|
|
|
| Stalwart Mail | Apache 2.0 | Modern Rust, ActiveSync built-in, JMAP support |
|
|
| OCIS | Apache 2.0 | Cleaner license than Nextcloud (AGPL+trademark) |
|
|
| Zulip | Apache 2.0 | Only truly open-core-free chat option |
|
|
| Authentik | MIT | Better multi-tenancy than Keycloak |
|
|
| Hetzner | N/A | 100% EU sovereignty — core to business |
|
|
|
|
## License
|
|
|
|
Application code: MIT (own code)
|
|
Third-party services: see individual service licenses in stack.
|