pr_01m47d15m3e54sn21z27rpy5n9/apps/sudo/README.md
| 1 | # sudo |
| 2 | |
| 3 | g1t's staff console, at <https://sudo.g1t.sh>: the back office g1t is |
| 4 | building for itself, for sales, support and finance. It is organised the |
| 5 | way customers know g1t: by **workspace**. |
| 6 | |
| 7 | The sidebar (`app/lib/nav.ts`) has Overview and Reach out at the top, then |
| 8 | sections that fold open to their pages: Customers, Revenue, Platform, |
| 9 | Support and Team. Each fold is a `<details>`, drawn open for the section |
| 10 | holding the current page; on a phone the same menu sits behind a "Menu" |
| 11 | button in the top bar. Pages not built yet are marked **Soon**: each is a |
| 12 | real page (`routes/soon.tsx`, made from its entry in `nav.ts`) saying what |
| 13 | it will do, why, and what it will have, so the sidebar doubles as the |
| 14 | roadmap. |
| 15 | |
| 16 | - **Overview** (`/`): this month charged, cost and margin; the last six |
| 17 | months as a chart; this month by kind of usage; paying workspaces; how |
| 18 | many are stopped, near their limit or declined (each a link into Reach |
| 19 | out); open invoices; follow-ups due; and the five most urgent signals. |
| 20 | From billing's `admin_overview` and `admin_signals`. |
| 21 | - **Reach out** (`/reach-out`): every workspace worth a word, most urgent |
| 22 | first (at limit, declined, near limit, high spend, growing, established, |
| 23 | first payment), with its owners, the reason in a sentence, the figure, |
| 24 | and its sales stage and owner at g1t. Filter by why and by whose |
| 25 | (everyone's, unassigned, mine), or show only **follow-ups due** (a next |
| 26 | step due today or earlier, on a deal not won or lost; one per |
| 27 | workspace). Rows show the next step and its day. Each row opens the |
| 28 | workspace's Sales. |
| 29 | - **Invoices** (`/invoices`): every invoice g1t has sent, workspaces' and |
| 30 | enterprises', newest first (`admin_invoices`, at most 200). Filter by |
| 31 | status and month; totals for what is listed (amount, paid, outstanding); |
| 32 | each links to its workspace or enterprise and to Stripe's page (https |
| 33 | only). |
| 34 | - **Audit log** (`/audit`): every change made in sudo, and what Stripe told |
| 35 | billing, newest first, 100 a page with "Older" (`admin_audit`). Filter by |
| 36 | staff email and kind of change; each line links to its workspace or |
| 37 | enterprise. |
| 38 | - **Workspaces** (`/workspaces`): every workspace, newest first, 50 to a |
| 39 | page, with its owners, members, who it is billed to, its terms, this |
| 40 | month's usage against its limit, what it was charged and what it cost |
| 41 | g1t. Search by workspace, owner, email or enterprise (across the whole |
| 42 | list); filter to stopped or warning, comped or custom, or on an |
| 43 | enterprise. Billing's figures are fetched for exactly the page shown, so |
| 44 | the filters, and the totals over the list, cover that page; the page |
| 45 | says so when there is more than one. A workspace's page shows its members; |
| 46 | **Sales** (its stage, the staff member who has it, the next step and its |
| 47 | date, and notes, newest first; `admin_sales`, `admin_set_sales`, |
| 48 | `admin_add_note`); and under **Billing** its limit in words (trust, the |
| 49 | owners' own spend limit or the default, the most they may set, how it |
| 50 | grows), its last six months as a chart, its invoices (`admin_workspace_invoices`, |
| 51 | with Stripe's page and PDF), its terms, who it is billed to (move it onto or off an |
| 52 | enterprise), a credit form, a Stripe billing link, its ledger and its |
| 53 | audit log. If billing does not answer for sales or invoices, the page |
| 54 | still opens and says so in those sections. |
| 55 | - **Enterprises**: customers that pay for several workspaces with one |
| 56 | bill, one limit and one set of terms. Each has its workspaces (add or |
| 57 | remove them), combined usage, terms, credits, ledger and audit log, and |
| 58 | **Invoices**: where they go (the billing email, which also makes its |
| 59 | Stripe customer), a "Send invoice now" button, and every invoice with |
| 60 | its status (open, paid, overdue, void), a line per workspace, and a link |
| 61 | to Stripe's hosted invoice page. An invoice also goes out on its own as |
| 62 | each month closes: one Stripe invoice, a line per workspace for what it |
| 63 | owes, net 30, emailed by Stripe. |
| 64 | - **Stripe**: whether billing's key is in test or live mode (or off), the |
| 65 | webhook Stripe calls (URL, endpoint id, events, who registered it and |
| 66 | when), and the events Stripe sent lately with what billing did with |
| 67 | each. "Register webhook" (or "Replace") has billing delete the endpoint |
| 68 | it made before, create a new one and keep its signing secret, which no |
| 69 | one sees. Do it once per mode, and again after switching to live keys. |
| 70 | |
| 71 | Sales changes are not money, so they have no confirmation step; they are |
| 72 | still POSTs from sudo's own pages, recorded with who made them. |
| 73 | |
| 74 | Billing's internal account ids (`ws_<slug>` for a workspace's own, |
| 75 | `ent_…` for an enterprise) are never shown as names; an enterprise's id |
| 76 | appears only as small "Billing account id" text. Old `/accounts/…` links |
| 77 | redirect to the workspace or enterprise they meant. |
| 78 | |
| 79 | **Cards stay on Stripe.** sudo never shows a card field. To help a customer |
| 80 | update their card or see invoices, staff make a Stripe billing link on the |
| 81 | workspace's page (it is recorded) and send it to the owner. |
| 82 | |
| 83 | It holds no data. Workspaces, owners and members come from identity's |
| 84 | staff methods (`admin_workspaces`, `admin_workspace`; `IdentityAdminApi` in |
| 85 | `packages/contracts/src/identity.ts`); everything about money goes to the |
| 86 | billing service's (`admin_*`, `BillingAdminApi` in |
| 87 | `packages/contracts/src/billing.ts`), where each change is recorded with |
| 88 | the staff member's email. Both are reached over service bindings only, and |
| 89 | nothing but sudo binds to them. |
| 90 | |
| 91 | ## How it is locked |
| 92 | |
| 93 | 1. **Cloudflare Access** sits in front of `sudo.g1t.sh` and signs people in. |
| 94 | 2. **The worker checks Access's work** on every request, the stylesheet |
| 95 | included (`run_worker_first`): it verifies the `Cf-Access-Jwt-Assertion` |
| 96 | JWT itself (RS256 against the team's published keys, audience, issuer, |
| 97 | expiry), then requires its email to be in `STAFF_EMAILS`. That email is |
| 98 | who every change is recorded as. See `app/lib/access.ts`. |
| 99 | 3. **It fails closed.** Until `ACCESS_TEAM_DOMAIN`, `ACCESS_AUD` and |
| 100 | `STAFF_EMAILS` are all set, every request gets a 403 saying sudo is not |
| 101 | configured. |
| 102 | 4. **Changes** are POSTs only, and only from sudo's own pages (`Origin`, or |
| 103 | `Referer`, must be `https://sudo.g1t.sh`). Terms, enterprise moves, new |
| 104 | enterprises, Stripe billing links, invoice emails, invoices and the |
| 105 | webhook show a confirmation step first; a credit needs the workspace's |
| 106 | slug typed out. |
| 107 | 5. **The pages ship no JavaScript.** The content security policy forbids |
| 108 | every script and inline style; responses are `no-store`, `noindex` and |
| 109 | cannot be framed. The worker has no `workers.dev` address or preview URLs. |
| 110 | |
| 111 | ## Setting up Access (once, in the Cloudflare dashboard) |
| 112 | |
| 113 | 1. **Zero Trust → Access → Applications → Add an application → Self-hosted.** |
| 114 | - Application name: `sudo`. |
| 115 | - Session duration: short, such as 8 hours. |
| 116 | - Public hostname: `sudo.g1t.sh` (path empty, so it covers everything). |
| 117 | 2. **Add a policy** (`g1t staff`): action *Allow*, include *Emails* → the |
| 118 | owner's address, and *Emails ending in* → `g1t.sh` for everyone with a |
| 119 | g1t address (the same entries as `STAFF_EMAILS`, where a domain is |
| 120 | written `@g1t.sh`). Add more staff here *and* in `STAFF_EMAILS`; either |
| 121 | one alone is not enough. |
| 122 | 3. Save, then open the application's **Overview** (or *Basic information*) |
| 123 | and copy the **Application Audience (AUD) tag**. |
| 124 | 4. Find the **team domain** under **Zero Trust → Settings → Custom pages** |
| 125 | (or *Team name and domain*): it looks like `<team>.cloudflareaccess.com`. |
| 126 | 5. Put both into `wrangler.jsonc`: |
| 127 | |
| 128 | ```jsonc |
| 129 | "vars": { |
| 130 | "ACCESS_TEAM_DOMAIN": "<team>.cloudflareaccess.com", |
| 131 | "ACCESS_AUD": "<the AUD tag>", |
| 132 | "STAFF_EMAILS": "syntaqx@gmail.com, @g1t.sh" |
| 133 | } |
| 134 | ``` |
| 135 | |
| 136 | 6. Deploy: `scripts/deploy.sh sudo` (after `billing` and `identity`, whose |
| 137 | `admin_*` methods it calls). |
| 138 | |
| 139 | Visit <https://sudo.g1t.sh>: Access asks you to sign in, then the workspaces |
| 140 | list opens. Anyone else gets Access's own refusal; anyone Access lets in who |
| 141 | is not in `STAFF_EMAILS` gets a 403 from the worker. |
| 142 | |
| 143 | ## Signing in through WARP |
| 144 | |
| 145 | Staff signed in to the Zero Trust org in the Cloudflare One agent (WARP) |
| 146 | reach sudo without the login page: the org allows WARP sessions as Access |
| 147 | sign-ins (8 hours), the sudo app accepts them, and the `g1t staff` policy |
| 148 | is also on the WARP enrollment app, so staff can enroll their devices. |
| 149 | The same two checks still apply: the Access policy, and `STAFF_EMAILS`. |
| 150 | |
| 151 | ## Working on it |
| 152 | |
| 153 | ```sh |
| 154 | npm run typecheck -w @g1t/sudo |
| 155 | npm test -w @g1t/sudo # JWT verification, forms, money, the workspace join, paging, nav, charts, signals |
| 156 | npm run build -w @g1t/sudo |
| 157 | ``` |
| 158 | |
| 159 | `npm run dev` serves the pages, but every request is refused without a real |
| 160 | Access token, by design. |