diff options
| author | DanConwayDev <DanConwayDev@protonmail.com> | 2026-01-12 21:06:39 +0000 |
|---|---|---|
| committer | DanConwayDev <DanConwayDev@protonmail.com> | 2026-01-12 21:21:52 +0000 |
| commit | 82b56c37b26a2fac1a294873e539b19b9325dca6 (patch) | |
| tree | 07800949230f13f91fec2eebbd94b8fbb00dd83f /.env.example | |
| parent | a12927181c571fc1641772ad44dd4c6a4ab209d9 (diff) | |
feat(config): add repository whitelist for curated GRASP-01 acceptance
Adds NGIT_REPOSITORY_WHITELIST option for curated relay operation that
accepts only whitelisted repositories while maintaining GRASP-01 compliance
(announcements must list the service). This differs from archive whitelist
which enables GRASP-05 mode and doesn't require service listing.
Key features:
- Supports three whitelist formats: npub, npub/identifier, identifier
- Enforces mutual exclusivity with archive read-only mode
- Updates NIP-11 curation field when whitelist is enabled
- Maintains GRASP-01 compliance (doesn't add GRASP-05 support)
Configuration synced across all four sources: src/config.rs, docs/reference/configuration.md,
nix/module.nix, and .env.example as required by AGENTS.md.
Diffstat (limited to '.env.example')
| -rw-r--r-- | .env.example | 27 |
1 files changed, 26 insertions, 1 deletions
diff --git a/.env.example b/.env.example index cb797a8..0789b28 100644 --- a/.env.example +++ b/.env.example | |||
| @@ -202,4 +202,29 @@ | |||
| 202 | # CLI: --archive-read-only | 202 | # CLI: --archive-read-only |
| 203 | # Default: true if NGIT_ARCHIVE_ALL or NGIT_ARCHIVE_WHITELIST is set, false otherwise | 203 | # Default: true if NGIT_ARCHIVE_ALL or NGIT_ARCHIVE_WHITELIST is set, false otherwise |
| 204 | # Note: Setting to true without archive config causes startup error | 204 | # Note: Setting to true without archive config causes startup error |
| 205 | # NGIT_ARCHIVE_READ_ONLY= \ No newline at end of file | 205 | # Note: Cannot be used with NGIT_REPOSITORY_WHITELIST (mutually exclusive) |
| 206 | # NGIT_ARCHIVE_READ_ONLY= | ||
| 207 | |||
| 208 | # ============================================================================ | ||
| 209 | # REPOSITORY WHITELIST | ||
| 210 | # ============================================================================ | ||
| 211 | |||
| 212 | # Whitelist specific repos/pubkeys/identifiers for GRASP-01 acceptance | ||
| 213 | # Comma-separated list supporting three formats (same as archive whitelist): | ||
| 214 | # <npub> - Accept all repos from this pubkey (if they list our service) | ||
| 215 | # <npub>/<identifier> - Accept specific repo (if it lists our service) | ||
| 216 | # <identifier> - Accept repos with this identifier (if they list our service) | ||
| 217 | # | ||
| 218 | # Difference from archive whitelist: | ||
| 219 | # - Repository whitelist: Announcements MUST list our service AND match whitelist | ||
| 220 | # - Archive whitelist: Announcements don't need to list our service, just match whitelist | ||
| 221 | # | ||
| 222 | # CLI: --repository-whitelist <list> | ||
| 223 | # Default: (empty - all repos listing our service are accepted) | ||
| 224 | # Examples: | ||
| 225 | # NGIT_REPOSITORY_WHITELIST=npub1alice... | ||
| 226 | # NGIT_REPOSITORY_WHITELIST=npub1alice...,npub1bob.../linux | ||
| 227 | # NGIT_REPOSITORY_WHITELIST=bitcoin-core,linux,rust | ||
| 228 | # Note: Cannot be used with NGIT_ARCHIVE_READ_ONLY=true (mutually exclusive) | ||
| 229 | # Note: When set, NIP-11 curation field will indicate curated repository acceptance | ||
| 230 | # NGIT_REPOSITORY_WHITELIST= \ No newline at end of file | ||