Initialize Embargo repository
This commit is contained in:
commit
c6567440c7
3 changed files with 63 additions and 0 deletions
9
.gitignore
vendored
Normal file
9
.gitignore
vendored
Normal file
|
|
@ -0,0 +1,9 @@
|
|||
node_modules/
|
||||
.DS_Store
|
||||
dist/
|
||||
coverage/
|
||||
.env
|
||||
.env.*
|
||||
!.env.example
|
||||
pnpm-lock.yaml
|
||||
|
||||
25
README.md
Normal file
25
README.md
Normal file
|
|
@ -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.
|
||||
|
||||
29
docs/plans/2026-03-30-phase-1-design.md
Normal file
29
docs/plans/2026-03-30-phase-1-design.md
Normal file
|
|
@ -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
|
||||
Loading…
Add table
Reference in a new issue