Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Authentication guide sets ADMIN_API_KEY and AUTO_PROVISIONING_ENABLED, which the Cloud Agent does not read

Aperta Adatta ai principianti
  • Qualcosa non va?
#297 1 commento 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
84/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
typescript
Ambito
documentation

Direzione di ricerca

Leggi documentation/develop/cloud-agent/authentication.md, in particolare le righe 69–85, e confronta i nomi delle variabili d’ambiente con le voci corrispondenti di Cloud Agent application.conf e il riferimento environment-variables.md del portale. Aggiorna entrambe le tabelle di configurazione affinché usino le variabili lette dal server e spiega i relativi valori predefiniti. Il lavoro è completato quando le tabelle corrispondono a questa configurazione e un controllo isolato della configurazione conferma che vengono applicati il token amministratore selezionato e l’impostazione di provisioning automatico.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

bug documentation ready-for-agent

User impact

An operator following the authentication guide cannot enable API-key auto-provisioning and cannot install their own administrator secret. Setting AUTO_PROVISIONING_ENABLED=true leaves auto-provisioning off, so the first request for an unregistered tenant fails instead of provisioning it. Setting ADMIN_API_KEY=secret does not replace the admin token, so the built-in default admin token stays in effect. The same portal's environment-variable reference already lists the names the agent reads, so the guide also contradicts itself.

Affected documentation and ownership

  • Page: https://identus.io/documentation/develop/cloud-agent/authentication/ — GET 200 after trailing-slash resolution, Last-Modified: Tue, 27 Oct 2026 12:51:14 GMT, observed 2026-10-29T10:22Z. The deployed HTML contains both AUTO_PROVISIONING_ENABLED and ADMIN_API_KEY.
  • Documentation source: authentication.md lines 69–77 and 79–85, revision fa985dfa33caefa45bf1e9009e1f6f5a445344fb.
  • Editable owning source: the same file. Ordinary committed Markdown, not prepare.sh/OpenAPI/TypeDoc output.
  • Intended component version: Identus Cloud Agent 2.2.1-SNAPSHOT. The docs revision pins its cloud-agent submodule at eee1ff7, whose version.sbt and application.conf are identical to the comparison revision 24facc used below; the compare contains only CI-workflow and client-generator lockfile changes. The pages are unversioned, so this is the normative main configuration at the pinned docs revision.

Observed versus expected

The auto-provisioning table (source lines 73–77) sets:

| API_KEY_ENABLED                      | true  |
| API_KEY_AUTHENTICATE_AS_DEFAULT_USER | false |
| AUTO_PROVISIONING_ENABLED            | true  |

The admin table (source lines 83–85) sets ADMIN_API_KEY=secret.

The Cloud Agent configuration reads neither name:

The same portal's environment-variable reference lists ADMIN_TOKEN (line 14, default admin) and API_KEY_AUTO_PROVISIONING (line 29, default false).

Expected: the setup tables name environment variables that the matching Cloud Agent reads, so following them changes the running configuration.

Evidence and reproduction

Static comparison at the revisions above, observed 2026-10-29:

tar xzf cloud-agent-24faccaa.tar.gz
grep -rn "AUTO_PROVISIONING_ENABLED" .    # no matches
grep -rn "ADMIN_API_KEY" .                # integration-test client configs only, e.g.
#   tests/integration-tests/src/test/resources/configs/*.conf: apikey = "${ADMIN_API_KEY:-admin}"
grep -n "ADMIN_TOKEN\|API_KEY_AUTO_PROVISIONING" cloud-agent/service/server/src/main/resources/application.conf
#   120: token = ${?ADMIN_TOKEN}
#   143: autoProvisioning = ${?API_KEY_AUTO_PROVISIONING}

The integration-test hits are the value the test client sends in the x-admin-api-key header (default admin, matching the server default), not a server binding.

Limitations: static source comparison and saved HTTP responses only. No agent was started; the conclusion does not depend on runtime behaviour, because an unread environment variable cannot change HOCON substitution.

Existing work checked

GitHub issue/PR search across hyperledger-identus/docs and hyperledger-identus/cloud-agent, open and closed, by exact identifier in title and body (2026-10-29):

  • ADMIN_API_KEY → 0 results; AUTO_PROVISIONING_ENABLED → 0 results.
  • ADMIN_TOKEN → 4 closed agent-startup reports unrelated to these tables.
  • API_KEY_AUTO_PROVISIONING → includes cloud-agent#1628 (merged), which changed the default of API_KEY_AUTO_PROVISIONING to false; it does not touch the documentation tables, so it is related work, not a duplicate.

Acceptance criteria

  • Both tables name environment variables that the matching Cloud Agent server reads, or the sections explain the real keys and defaults.
  • A reader who follows the tables can observe auto-provisioning enabled and their chosen administrator token accepted. Verification: static comparison against the same revision's application.conf, plus an isolated configuration test showing the substituted values reach autoProvisioning and admin.token.
Lingua principale
TypeScript
Stelle
15
Fork
8
Merge medio
3g 14h
PR unite (30g)
2

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hyperledger-identus/docs

Tutte le issue di hyperledger-identus/docs

Issue simili

Altre issue su TypeScript

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.