From c6567440c7f29905751ad1746461b0680cd4c641 Mon Sep 17 00:00:00 2001 From: ZTatman Date: Mon, 30 Mar 2026 16:29:10 -0400 Subject: [PATCH] Initialize Embargo repository --- .gitignore | 9 ++++++++ README.md | 25 +++++++++++++++++++++ docs/plans/2026-03-30-phase-1-design.md | 29 +++++++++++++++++++++++++ 3 files changed, 63 insertions(+) create mode 100644 .gitignore create mode 100644 README.md create mode 100644 docs/plans/2026-03-30-phase-1-design.md diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..df6be28 --- /dev/null +++ b/.gitignore @@ -0,0 +1,9 @@ +node_modules/ +.DS_Store +dist/ +coverage/ +.env +.env.* +!.env.example +pnpm-lock.yaml + diff --git a/README.md b/README.md new file mode 100644 index 0000000..a61cda1 --- /dev/null +++ b/README.md @@ -0,0 +1,25 @@ +# Embargo + +Your code, under embargo. + +Embargo is a companion service for Forgejo that lets repo owners create expiring, revocable, read-only share links for private code snapshots. + +## Phase 1 PR Breakdown + +Phase 1 is split into these reviewable branches: + +1. `codex/phase1-bootstrap-monorepo` +2. `codex/phase1-cli-init-skeleton` +3. `codex/phase1-service-foundation` +4. `codex/phase1-forgejo-integration` +5. `codex/phase1-grants-viewer` +6. `codex/phase1-dashboard-logs-settings` + +## Core Principles + +- Embargo runs beside Forgejo and talks to it only through the Forgejo API. +- Share links pin to an immutable `commit_sha`, not a moving branch. +- Embargo uses its own owner auth for MVP. +- Forgejo access is performed by a constrained service account with minimum PAT scopes. +- A repo is shareable only if the service account can see it and Embargo has sharing enabled for it. + diff --git a/docs/plans/2026-03-30-phase-1-design.md b/docs/plans/2026-03-30-phase-1-design.md new file mode 100644 index 0000000..acf5eeb --- /dev/null +++ b/docs/plans/2026-03-30-phase-1-design.md @@ -0,0 +1,29 @@ +# Embargo Phase 1 Design + +This document captures the approved Phase 1 plan for Embargo. + +## Scope + +Phase 1 delivers: + +- CLI bootstrap for Forgejo + Embargo deployment +- Embargo service foundation +- constrained Forgejo service-account integration +- immutable snapshot grants pinned to `commit_sha` +- owner dashboard and viewer flow + +## Reviewable Branches + +1. `codex/phase1-bootstrap-monorepo` +2. `codex/phase1-cli-init-skeleton` +3. `codex/phase1-service-foundation` +4. `codex/phase1-forgejo-integration` +5. `codex/phase1-grants-viewer` +6. `codex/phase1-dashboard-logs-settings` + +## Security Baseline + +- service account access is restricted to approved repos +- Embargo grant checks are enforced on every Forgejo read +- grants store `repo_id` and pinned `commit_sha` +- viewer requests never choose repo or ref directly