portal/README.md

52 lines
1.5 KiB
Markdown
Raw Normal View History

# centralcloud/portal
Elixir/Phoenix umbrella — two web surfaces from one codebase.
## Apps
| App | URL | Audience |
|-----|-----|----------|
| `centralcloud_staff` | `ops.centralcloud.com` | Staff — ops cockpit, AI chat, on-call |
| `centralcloud_my` | `my.centralcloud.com` | Customers — dashboard, DR, billing, support |
| `centralcloud_core` | (library) | Shared: HostBill client, DR API client, OIDC |
> **Note:** `centralcloud_staff` is the thin UI layer. All business logic (incidents, pager,
> oncall engine, AI triage) lives in `../infra/apps/centralcloud_ops` (the backend engine).
`my.centralcloud.com` will also serve `www.centralcloud.com` (marketing pages) when DNS is repointed.
## Quick start
```bash
# Enter dev shell (Elixir 1.20-rc.4 + OTP 28 via Nix)
nix develop
# Install deps (from umbrella root)
mix deps.get
# Run customer portal (port 4001)
cd apps/centralcloud_my && mix phx.server
# Run staff portal (port 4000)
cd apps/centralcloud_staff && mix phx.server
```
## Required env vars
```bash
MY_SECRET_KEY_BASE=... # mix phx.gen.secret
OPS_SECRET_KEY_BASE=...
HOSTBILL_API_ID=... # from HostBill admin API keys
HOSTBILL_API_KEY=...
DR_PORTAL_URL=https://dr.centralcloud.com
DR_PORTAL_API_KEY=...
OIDC_CLIENT_ID=... # Authentik application client ID
OIDC_CLIENT_SECRET=...
ROUTER_AGENT_URL=http://router-agent.router-agent.svc:8642
ROUTER_AGENT_API_KEY=... # from OpenBao / k8s secret
```
## Architecture
See `../AGENTS.md` for the full codebase map and how portal, engine, and agents relate.