Skip to content

Adds Key Management page to Run section. - #526

Open
johnnymatthews wants to merge 7 commits into
mainfrom
add/key-and-asset-management
Open

johnnymatthews wants to merge 7 commits into
mainfrom
add/key-and-asset-management

Conversation

@johnnymatthews

Copy link
Copy Markdown
Contributor

Closes #244

@johnnymatthews johnnymatthews changed the title Add/key and asset management Adds Key Management page to Run section. Oct 16, 2026
@johnnymatthews

Copy link
Copy Markdown
Contributor Author

Not actually sure the current page location is the best place for it...

@johnnymatthews
johnnymatthews requested a review from dvncan October 16, 2026 10:04
@dvncan

dvncan commented Oct 16, 2026

Copy link
Copy Markdown
Collaborator

This describes how the Generator client stores its key today: the keyring lives inside the DefraDB store, at .defra/keys. The Host client has since changed. Its keyring now sits beside the store, in a keys/ directory next to .defra, and that's where it reads the key from.

Until the Generator is migrated to the same layout, this page needs to cover both:

  • Generator: .defra/keys (Docker: inside the volume mounted to /app/.defra).
  • Host: keys/ next to .defra (Docker: its own mount, separate from /app/.defra).

The "Where the key lives", "Back up your keys" and "Recover a node" sections (including the cp -r ~/.defra/keys example) should give the path per client. Could we split those into Host and Generator subsections, with a note that the Generator path will change? I'll open a ticket on the Generator side to track the migration.

@cloudflare-workers-and-pages

cloudflare-workers-and-pages Bot commented Oct 19, 2026 •

Copy link
Copy Markdown

Deploying docs with  Cloudflare Pages  Cloudflare Pages

Latest commit: 72f8b24
Status: ✅  Deploy successful!
Preview URL: https://5317a206.docs-czv.pages.dev
Branch Preview URL: https://add-key-and-asset-management.docs-czv.pages.dev

View logs

@johnnymatthews

johnnymatthews commented Oct 19, 2026 •

Copy link
Copy Markdown
Contributor Author

DO NOT MERGE until the Host client changes land: the page now documents the Host keyring at keys/ beside the store, which matches the new CLI (shinzonetwork/shinzo-host-client#466) rather than the currently published image, which still reads from .defra/keys."

Switching to draft to stop any accidental merges.

@johnnymatthews johnnymatthews changed the title Adds Key Management page to Run section. [DO NOT MERGE] Adds Key Management page to Run section. Oct 19, 2026
@johnnymatthews

Copy link
Copy Markdown
Contributor Author

I got a tad confused, so here's a recap of the keyring thing. The docs currently assume both clients keep their node key in .defra/keys. @dvncan says the Host client's keyring moved to a keys/ folder next to .defra, so I split the storage, backup, and recovery sections per client and left the Generator at .defra/keys.

HOWEVER... the Host client code people run today still uses the old path. The new layout lives in the new CLI, and the PR that actually writes keys there (shinzo-host-client#466) is still open. So the page now describes what's coming, not what's shipped. So I'm holding back this PR until the Host side lands.

On top of that, shinzo-host-client#466 stores the keys as plain unencrypted files for now (there's a TODO in the code) and adds mnemonic recovery. Once its final form is merged, the keyring-secret and "no recovery path" sections in these here docs need another pass.

@johnnymatthews
johnnymatthews marked this pull request as draft October 19, 2026 12:49
@johnnymatthews

Copy link
Copy Markdown
Contributor Author

Currently blocked by shinzo-host-client#466

@johnnymatthews

johnnymatthews commented Nov 5, 2026 •

Copy link
Copy Markdown
Contributor Author

shinzonetwork/shinzo-host-client#466 merged, so we should be good to move forward with this. Once the conflicts are resolved....

@johnnymatthews

Copy link
Copy Markdown
Contributor Author

Oh good. Now the build is failing.

@johnnymatthews johnnymatthews changed the title [DO NOT MERGE] Adds Key Management page to Run section. Adds Key Management page to Run section. Nov 5, 2026
@johnnymatthews
johnnymatthews marked this pull request as ready for review November 5, 2026 16:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Key / asset management.

2 participants