Files
proof-of-work/README.md
T
Keysat d9c4e6c4a0 Multi-user: self-serve sign-up gated by admin-toggleable flag
Schema
- User.isAdmin: Boolean default false (Prisma)
- New InstanceSettings singleton (id=1) holding signupsOpen flag

Boot-time compat ALTERs (docker_entrypoint.sh)
- Adds User.isAdmin column to legacy snapshots; auto-promotes the oldest
  user to admin if no admin exists yet, so workout-log -> proof-of-work
  cutover preserves admin functionality with no manual SQL.
- Creates InstanceSettings table + singleton row (signupsOpen=0) for any
  snapshot that doesn't have it.

App: sign-up flow
- /auth/signup page: server component that reads InstanceSettings
  upfront. If sign-ups are closed it shows a closed-instance message and
  a back-to-sign-in link rather than a dead form. If open it renders
  SignupForm (client) which calls signupAction (server).
- signupAction: re-checks the flag (defense in depth), validates email
  format / 8-char password / matching confirm, blocks duplicate-email
  enumeration with a generic error, creates the user with isAdmin=false,
  seeds default UserPreferences, ensures the curated exercise library
  for the new user (lib/library.ts upserts every entry), then issues a
  session cookie.
- Login page now links to /auth/signup; old "Demo: admin@example.com /
  password" footer (which was wrong anyway) removed.

App: admin in-app toggle
- Settings page renders new AdminInstanceSettings component for admins
  only. Optimistic toggle posts to /api/admin/signups; error rollback
  on failure.
- /api/admin/signups: GET returns current flag (any authed user, so the
  UI knows whether to show the sign-up CTA later); POST flips it
  (admin only).

StartOS package action
- toggle-signups: same setter as the in-app toggle, accessible from the
  StartOS UI without an admin login. Single boolean input. Asserts the
  read-back value matches what was written before reporting success.
- changeAdminCredentials now keys the UPDATE on
  `WHERE isAdmin = 1 ORDER BY createdAt ASC LIMIT 1` (was: just
  ORDER BY createdAt) — correct under multi-user.

Release notes / docs
- v1.0.0:1 release notes expanded to call out multi-user as part of
  the cutover release (no separate version needed since this is the
  first proof-of-work release shipping to anyone).
- Root README: short Multi-user section explaining both toggle paths
  and that new users get the curated library automatically.
- README dev setup adds `npx prisma generate` step (required after
  schema changes for local dev).
2026-05-08 20:59:45 -05:00

82 lines
2.7 KiB
Markdown

# Proof of Work
Self-hosted multi-user workout planner and logger. Plan training cycles,
log daily workouts, search your history, and curate a shared exercise
library across everyone on the instance. Distributed as a StartOS 0.4
sideload package.
## Repo layout
```
proof-of-work/ Next.js app (TypeScript, Prisma + SQLite, Tailwind, PWA)
start9/0.4/ StartOS 0.4 package wrapper (manifest, Dockerfile,
entrypoint, version graph, change-credentials action)
```
Everything else is generated at build time.
## Local development
```sh
cd proof-of-work
npm install
npx prisma generate # important after schema changes
npx prisma db push # create the dev DB at prisma/data/app.db
npm run db:seed # admin@local / workout123 + curated library + admin flag
npm run dev # http://localhost:3000
```
## Multi-user
Every install starts with one admin user (`admin@local`) and **sign-ups
closed**. To open the instance to additional users:
- In-app: log in as admin -> **Settings -> Instance Settings ->
Allow new sign-ups**.
- StartOS: **Services -> Proof of Work -> Actions -> Set new signups**.
Both write to the same `InstanceSettings` row; either path works.
When sign-ups are open, anyone reaching the URL can create an account at
`/auth/signup`. New users start with no admin privileges and are
automatically seeded the full curated exercise library.
## Building the StartOS package
See **[start9/0.4/DEPLOY_040.md](start9/0.4/DEPLOY_040.md)** for the full
deployment / cutover guide. Short version:
```sh
cd start9/0.4
npm ci
make clean
make x86 # produces proof-of-work_x86_64.s9pk
make install # sideload to the host in ~/.startos/config.yaml
```
## Curated exercise library
`proof-of-work/prisma/exercises.seed.json` is the canonical library
shipped to every install. It seeds fresh installs (via `prisma/seed.ts`)
and is re-applied on every boot to existing installs (via
`docker_entrypoint.sh` + `ensureExerciseLibrary.cjs`) so updates flow to
all users on package upgrade.
Refresh the JSON from the maintainer's live host:
```sh
./start9/0.4/refresh_seed.sh <ssh-target> # pull a fresh /data snapshot
cd proof-of-work && npm run sync-library # extract Exercise table -> JSON
git diff prisma/exercises.seed.json
```
The system is additive only — removing an exercise from the JSON does
not delete it from existing installs (users may have logged sets against
it). Users' own custom exercises (`isCustom = true`) are never touched.
## Privacy
`start9/0.4/seed/data/app.db` is your live `/data` snapshot. It contains
real workout history and a bcrypt'd password hash. The top-level
`.gitignore` keeps it out of git; do NOT commit it to any public repo.