mirror of
https://github.com/ZTatman/myst.git
synced 2026-11-22 12:57:58 +00:00
Docs: add diagram slot and clarify deployment examples (#6)
This commit is contained in:
parent
e23531a0ac
commit
aa71b2b622
2 changed files with 132 additions and 30 deletions
43
README.md
43
README.md
|
|
@ -4,35 +4,13 @@
|
||||||
|
|
||||||
Myst is a companion service for Forgejo that lets repo owners create expiring, revocable, read-only share links for code snapshots.
|
Myst is a companion service for Forgejo that lets repo owners create expiring, revocable, read-only share links for code snapshots.
|
||||||
|
|
||||||
## Architecture
|
## System Diagram
|
||||||
|
|
||||||
```mermaid
|
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.
|
||||||
flowchart TB
|
|
||||||
subgraph VPS["VPS / Self-Hosted"]
|
|
||||||
subgraph Docker["Docker Network"]
|
|
||||||
Forgejo["Forgejo (Git Server)"]
|
|
||||||
Postgres["PostgreSQL (2 Databases)"]
|
|
||||||
Myst["Myst (This Service)"]
|
|
||||||
Traefik["Traefik (Reverse Proxy)"]
|
|
||||||
end
|
|
||||||
Tailscale["Tailscale (Admin Access)"]
|
|
||||||
end
|
|
||||||
|
|
||||||
subgraph External["External"]
|
[](docs/diagrams/system-routing.svg)
|
||||||
Owner["Repo Owner"]
|
|
||||||
Viewer["Link Recipient"]
|
|
||||||
end
|
|
||||||
|
|
||||||
Owner -->|"Login via Forgejo Session"| Myst
|
Click the diagram to open the full-size SVG.
|
||||||
Owner -->|"Create View Link (PAT)"| Forgejo
|
|
||||||
Myst -->|"Read-only API (PAT)"| Forgejo
|
|
||||||
Myst -->|"Store Grants"| Postgres
|
|
||||||
Forgejo -->|"Sessions"| Postgres
|
|
||||||
Myst -->|"Public Viewer"| Viewer
|
|
||||||
Myst -->|"Admin UI (Protected)"| Owner
|
|
||||||
Tailscale -->|"Private Admin Access"| Myst
|
|
||||||
Traefik -->|"Route HTTPS Traffic"| Myst
|
|
||||||
```
|
|
||||||
|
|
||||||
## Features
|
## Features
|
||||||
|
|
||||||
|
|
@ -56,7 +34,7 @@ flowchart TB
|
||||||
| Purpose | Method |
|
| Purpose | Method |
|
||||||
|---------|--------|
|
|---------|--------|
|
||||||
| User Identity | Forgejo Sessions |
|
| User Identity | Forgejo Sessions |
|
||||||
| Data Access | Service Account PAT |
|
| Data Access | Dedicated Forgejo User PAT |
|
||||||
|
|
||||||
### Tech Stack
|
### Tech Stack
|
||||||
|
|
||||||
|
|
@ -80,10 +58,10 @@ Prompts for:
|
||||||
- Private admin URL (`admin.example.com`)
|
- Private admin URL (`admin.example.com`)
|
||||||
- Forgejo base URL (`git.example.com`)
|
- Forgejo base URL (`git.example.com`)
|
||||||
- PostgreSQL connection string
|
- PostgreSQL connection string
|
||||||
- Forgejo service account username and PAT
|
- Dedicated Forgejo username and PAT
|
||||||
- Grant token secret
|
- Grant token secret
|
||||||
|
|
||||||
### 2. Configure Service Account
|
### 2. Configure Dedicated Forgejo User
|
||||||
|
|
||||||
Create a dedicated Forgejo user (e.g., `myst-bot`) with a PAT:
|
Create a dedicated Forgejo user (e.g., `myst-bot`) with a PAT:
|
||||||
|
|
||||||
|
|
@ -92,7 +70,12 @@ Create a dedicated Forgejo user (e.g., `myst-bot`) with a PAT:
|
||||||
|
|
||||||
### 3. Deploy
|
### 3. Deploy
|
||||||
|
|
||||||
Deploy via Dokploy, Coolify, or your preferred platform.
|
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
|
## Example Configuration
|
||||||
|
|
||||||
|
|
|
||||||
119
docs/diagrams/system-routing.svg
Normal file
119
docs/diagrams/system-routing.svg
Normal file
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 36 KiB |
Loading…
Add table
Reference in a new issue