mirror of
https://github.com/ZTatman/myst.git
synced 2026-11-21 04:17:59 +00:00
* Add CLI scaffold and config generators * Add PR stacking note to README * refactor: write embargo init command myself for clarity * refactor: rename Myst and narrow CLI setup flow * Update Phase 1 plans with finalized design decisions Major updates: - Add authentication model (Forgejo sessions for identity, PAT for data access) - Add link types (private email-verified, public time-expired) - Add link creation rules (owner-only) - Add Docker/deployment guidance (Dockerfile only, Dokploy handles orchestration) - Add database model (separate DBs on same PostgreSQL instance) - Add viewer baseline and user dashboard sections - Add SMTP configuration via post-login setup page Key architectural decisions: - Users log in via Forgejo session, no separate Myst login - Service account PAT used for API calls, not user identity - Private links require email verification code - Public links are time-expired for job applications - Myst provides Dockerfile, operators use Dokploy for deployment * Complete CLI init skeleton with CodeRabbit review fixes CLI changes: - Narrow init to Myst-only config generation (no Forgejo provisioning) - Add yoctocolors styling to CLI output - Simplify URL validation logic (remove dead code) - Fix typo in env.ts comment - Remove docker-compose generator (out of scope) - Move example config from src/ to packages/cli/examples/ - Fix CommandName type to match implemented commands only Config changes: - Remove databaseUrl from myst.config.json (DB is .env-only) - Update example config with current fields - Reject non-HTTP schemes before auto-prepending https:// - Use localhost -> 127.0.0.1 in Caddy/Nginx examples - Add file existence checks and 0o600 permissions Build passes after all changes. * docs: rewrite README with Myst branding and architecture - Add Mermaid architecture diagram - Document two link types (private/public) - Explain authentication model - Provide setup steps - Add example configuration - Include Phase 1 completion checklist * fix: correct Mermaid diagram syntax * refactor: streamline README per create-readme skill guidelines - Use blockquote for tagline - Simplify architecture diagram labels - Remove redundant sections (Setup, Example Config, License) - Keep checklist as primary tracking mechanism - Use tables for features and auth - Reduce verbosity throughout * cli: add preflight check and version flag - Add preflightWriteTargets to check file existence before writing - Remove stub commands (start, stop, status) from help text - Add --version flag support - Sequential file writes with preflight check * cleanup: remove empty command stubs and test config - Remove start.ts, stop.ts, status.ts (not implemented yet) - Remove myst.config.json (generated during testing) * cleanup: remove app-ini generator (Forgejo provisioning out of scope) * cleanup: remove empty unused utility files (docker.ts, flags.ts, init.ts) * cleanup: remove examples.ts (examples belong in docs, not deployed code) * Docs: clarify Forgejo user PAT wording (#4) * Docs: add diagram slot and clarify deployment examples (#6) * docs: rename Forgejo bot configuration * refactor(cli): improve init command error handling; change "service account" verbaige to "dedicated forgejo user" to match Forgejo user model;
114 lines
3.7 KiB
Markdown
114 lines
3.7 KiB
Markdown
# Myst
|
|
|
|
> My stuff, kept private.
|
|
|
|
Myst is a companion service for Forgejo that lets repo owners create expiring, revocable, read-only share links for code snapshots.
|
|
|
|
## System Diagram
|
|
|
|
This diagram shows how traffic moves through the public internet, the VPS or self-hosted server, the host firewall, the platform router, Myst, Forgejo, and Postgres.
|
|
|
|
[](docs/diagrams/system-routing.svg)
|
|
|
|
Click the diagram to open the full-size SVG.
|
|
|
|
## Features
|
|
|
|
### Two Link Types
|
|
|
|
| Type | Verification | Use Case |
|
|
|------|--------------|----------|
|
|
| **Private** | Email verification code required | Share with specific individuals |
|
|
| **Public** | No verification, time-expired | Job applications, portfolios |
|
|
|
|
### Security
|
|
|
|
- Links pinned to immutable `commit_sha` — not moving branches
|
|
- Email verification prevents unauthorized access
|
|
- Time-expiration and revocation give owners control
|
|
- No public repo listing — anti-scraping by design
|
|
- Admin access protected upstream (Tailscale, VPN, Cloudflare Access)
|
|
|
|
### Authentication
|
|
|
|
| Purpose | Method |
|
|
|---------|--------|
|
|
| User Identity | Forgejo Sessions |
|
|
| Data Access | Dedicated Forgejo User PAT |
|
|
|
|
### Tech Stack
|
|
|
|
- **Backend**: Python + FastAPI
|
|
- **Frontend**: Jinja2 templates + HTMX (no build step)
|
|
- **Database**: PostgreSQL
|
|
|
|
HTMX provides interactivity (filtering, form submissions) with minimal JavaScript. Jinja2 handles server-side rendering for fast page loads.
|
|
|
|
## Quick Start
|
|
|
|
### 1. Run `myst init`
|
|
|
|
```bash
|
|
myst init
|
|
```
|
|
|
|
Prompts for:
|
|
|
|
- Public viewer URL (`share.example.com`)
|
|
- Private admin URL (`admin.example.com`)
|
|
- Forgejo base URL (`git.example.com`)
|
|
- PostgreSQL connection string
|
|
- Dedicated Forgejo username and PAT
|
|
- Grant token secret
|
|
|
|
### 2. Configure Dedicated Forgejo User
|
|
|
|
Create a dedicated Forgejo user (e.g., `myst-bot`) with a PAT:
|
|
|
|
- `read:user`
|
|
- `read:repository`
|
|
|
|
### 3. Deploy
|
|
|
|
Deploy Myst anywhere you can run a normal web app beside Forgejo. Phase 1 should explicitly support both of these examples:
|
|
|
|
- VPS deployment: Hostinger or another VPS with Dokploy, Traefik, UFW, Myst, Forgejo, and a shared Postgres instance that contains separate `forgejo` and `myst` databases.
|
|
- Self-hosted server deployment: a home server, mini PC, NAS, or other self-hosted Linux machine running Myst with Docker, Podman, Docker Compose, Coolify, Caddy, Nginx, or another reverse proxy.
|
|
|
|
Myst should not assume a VPS-only environment. The requirement is an existing Forgejo instance, Myst's own database, and a way to route the public and admin hostnames to the Myst app.
|
|
|
|
## Example Configuration
|
|
|
|
```env
|
|
MYST_PUBLIC_URL="https://share.example.com"
|
|
MYST_ADMIN_URL="https://admin.example.com"
|
|
DATABASE_URL="postgresql://myst:secret@localhost:5432/myst"
|
|
FORGEJO_BASE_URL="https://git.example.com"
|
|
FORGEJO_BOT_USERNAME="myst-bot"
|
|
FORGEJO_PAT="fgp_xxxxxxxxxxxxxxxxxxxx"
|
|
GRANT_TOKEN_SECRET="your-secret-here"
|
|
```
|
|
|
|
## Phase 1 Progress
|
|
|
|
- [x] Project renamed from Embargo to Myst
|
|
- [x] CLI scaffold (`myst init`)
|
|
- [x] Config generation (`.env`, `myst.config.json`)
|
|
- [ ] Service foundation (FastAPI + PostgreSQL)
|
|
- [ ] `myst forgejo bootstrap` — verify Forgejo connectivity
|
|
- [ ] `myst doctor` — validate configuration
|
|
- [ ] `myst config print` — show current config
|
|
- [ ] Forgejo session authentication
|
|
- [ ] Repo ownership verification
|
|
- [ ] Private link creation (email-verified)
|
|
- [ ] Public link creation (time-expired)
|
|
- [ ] Web-based code viewer
|
|
- [ ] User dashboard
|
|
- [ ] SMTP configuration UI
|
|
- [ ] Access logs
|
|
|
|
## Resources
|
|
|
|
- [Forgejo Docs](https://forgejo.org/docs/)
|
|
- [API Usage](https://forgejo.org/docs/latest/user/api-usage/)
|
|
- [Token Scopes](https://forgejo.org/docs/latest/user/token-scope/)
|