Skip to main content
← Back to list
01Issue
FeatureShippedSwamp CLI
Assigneesstack72

Relationships

#1368 docs: document auth gates for team features (datastores, vaults, serve)

Opened by stack72 · 7/23/2026· Shipped 7/23/2026

Context

PR #1934 added authentication gates to three team features:

  1. External datastoresswamp datastore setup extension now requires a swamp-club.com account or SWAMP_API_KEY with datastore:* scope
  2. Non-local vaultsswamp vault create <type> (anything except local_encryption) now requires a swamp-club.com account or SWAMP_API_KEY with vault:* scope
  3. swamp serve--auth-mode token or --auth-mode oauth now requires a swamp-club.com account or SWAMP_API_KEY with serve:* scope

Collective tokens (swamp_org_ prefix) must carry the appropriate scope. Personal tokens get full access.

Docs to update (swamp-club/swamp-club)

High priority — auth & scopes reference

  • content/manual/reference/api-key-authentication.md — add datastore:*, vault:*, serve:* to scope table; expand "CLI commands that require authentication" table
  • content/manual/how-to/authenticate-with-api-keys.md — add examples for new scopes in the collective token section
  • content/manual/explanation/api-key-scoping.md — document new scope categories

High priority — datastore docs

  • content/manual/reference/datastore-configuration.md — add auth prerequisite to S3/GCS setup commands
  • content/manual/how-to/collaborate.md — strengthen auth prerequisite in "Promote your datastore" and "Migrate your vaults" sections
  • content/manual/how-to/giga-swamp/set-up-giga-swamp.md — add auth prerequisite
  • content/manual/explanation/datastore-architecture.md — note that external backends require auth

High priority — vault docs

  • content/manual/reference/vaults.md — add auth prerequisite to extension vault types and vault create reference
  • content/manual/how-to/vaults/use-aws-sm.md, use-azure-kv.md, use-1password.md — add auth prerequisite
  • content/manual/how-to/vaults/migrate-vault.md — add auth prerequisite

High priority — serve docs

  • content/manual/reference/swamp-serve/serve-flags.md — add auth prerequisite for token/oauth modes
  • content/manual/how-to/swamp-serve/set-up-token-auth.md, set-up-oauth-auth.md — add auth prerequisite
  • content/manual/explanation/swamp-serve.md — note auth requirement for token/oauth modes

Medium priority

  • content/manual/how-to/swamp-serve/run-as-system-daemon.md
  • content/manual/how-to/worker-fleets/docker.md, docker-compose.md
  • content/manual/reference/extensions/datastore-provider.md, vault-provider.md
  • content/manual/how-to/troubleshoot-your-swamp-repo.md — add troubleshooting for auth_required and missing_scope errors

Automoved by swampadmin from https://github.com/swamp-club/swamp/issues/1935

02Bog Flow
OPENTRIAGEDIN PROGRESSSHIPPED+ 1 MOREASSIGNED+ 5 MOREREVIEW+ 3 MOREPR_MERGED+ 1 MORENOTIFICATION_SKIPPED

Shipped

7/23/2026, 11:10:05 PM

Click a lifecycle step above to view its details.

03Sludge Pulse
stack72 assigned stack727/23/2026, 8:35:47 PM

Sign in to post a ripple.