No description
Find a file
ZTatman dcf60f4082 Add FastAPI lifespan pattern with async SQLAlchemy and Docker setup
- Move get_db to main.py for cleaner separation of concerns
- Remove engine/sessionmaker from database.py (keep only Base class)
- Fix config.py: add +asyncpg to database_url, remove @dataclass
- Add lifespan context manager for engine lifecycle
- Add docker-compose.yml for web + postgres services
- Add web/Dockerfile for containerized FastAPI app
- Add web/.env.example as environment template
2026-04-24 13:27:58 -04:00
docs refactor(cli): restructure CLI with new command router and merge verify/doctor (#7) 2026-04-13 14:29:29 -04:00
packages Remove unused @myst/shared dependency from CLI 2026-04-19 18:02:48 -04:00
web Add FastAPI lifespan pattern with async SQLAlchemy and Docker setup 2026-04-24 13:27:58 -04:00
.dockerignore refactor(cli): restructure CLI with new command router and merge verify/doctor (#7) 2026-04-13 14:29:29 -04:00
.gitignore Phase 1: CLI init skeleton and deployment plan (#5) 2026-04-07 13:27:19 -04:00
agents.md refactor(cli): restructure CLI with new command router and merge verify/doctor (#7) 2026-04-13 14:29:29 -04:00
docker-compose.yml Add FastAPI lifespan pattern with async SQLAlchemy and Docker setup 2026-04-24 13:27:58 -04:00
Dockerfile refactor(cli): restructure CLI with new command router and merge verify/doctor (#7) 2026-04-13 14:29:29 -04:00
package.json Phase 1: CLI init skeleton and deployment plan (#5) 2026-04-07 13:27:19 -04:00
pnpm-lock.yaml Phase 1: CLI init skeleton and deployment plan (#5) 2026-04-07 13:27:19 -04:00
pnpm-workspace.yaml Bootstrap pnpm monorepo workspace 2026-03-30 16:32:04 -04:00
README.md simplify: reduce CLI config to just Forgejo URL and PAT (#8) 2026-04-18 13:30:17 -04:00
tsconfig.base.json refactor(cli): restructure CLI with new command router and merge verify/doctor (#7) 2026-04-13 14:29:29 -04:00
tsconfig.json Bootstrap pnpm monorepo workspace 2026-03-30 16:32:04 -04:00

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.

Myst system routing diagram

Click the diagram to open the full-size SVG.

Features

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 config init

myst config init

Prompts for:

  • Forgejo API URL — Docker: http://forgejo:3000, bare metal: http://localhost:3000, cross-host: https://git.example.com
  • Forgejo PAT (with read:user and read:repository scopes)

2. Deploy with Docker Compose

cd packages/cli/examples
cp docker-compose.example.yml docker-compose.yml
# Edit .env with your FORGEJO_BASE_URL and FORGEJO_PAT
docker compose up -d

The DATABASE_URL is injected automatically by Docker Compose.

3. Alternative Deployments

For non-Docker deployments, you must supply DATABASE_URL yourself:

  • 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

Create a .env file with:

# Docker (same Compose network):
FORGEJO_BASE_URL=http://forgejo:3000
# Bare metal / non-container:
# FORGEJO_BASE_URL=http://localhost:3000
# Cross-host:
# FORGEJO_BASE_URL=https://git.example.com
FORGEJO_PAT=forgejo_pat_xxxxxxxxxxxx

When using the provided Docker Compose example, DATABASE_URL is injected automatically. For other deployment approaches (e.g., bare metal, Kubernetes), you must supply DATABASE_URL yourself.

Phase 1 Progress

  • Project renamed from Embargo to Myst
  • CLI scaffold (myst config init)
  • Config generation (.env)
  • Service foundation (FastAPI + PostgreSQL)
  • myst config verify — verify Forgejo connectivity
  • myst config verify --diagnostic — comprehensive diagnostics
  • myst config view — 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