Document the site hosting credential contract in the integration doc #45

Merged
vnprc merged 2 commits from agent/site-credential-contract-doc into master 2026-09-10 16:45:02 +01:00
Member

Documentation only; nothing changes for a running machine. The integration doc gains a "Site hosting credential" section that tells a fork where allod site deploy's credential comes from: the file rclone reports as its configuration, which on the host is ~/.config/rclone/rclone.conf, placed there by the framework from nexusIdentity.siteHostingConfigFile (allod/secrets#17, allod/archetypes#74), with the human forge token placed the same way from nexusIdentity.userForgejoTokenFile. It gives the lifecycle in one place: create once with allod site config, move the stanza into the deployment's secrets repository, rotate through rotate-token once allod/nexus#42 lands and by re-encrypting until then, verify with allod site check. The wrapper comment in nix/home.nix gains two lines pointing at that contract; no code in that file changes. The flake still evaluates, and every command and path named was checked against the tools source. If anything here is wrong it is a doc edit, not a rollback. Merge after allod/archetypes#74 so the doc describes something that exists.

Closes allod/nexus#44. Refs allod/strategy#51.

Risk

R0. Prose and a comment.

Validation

  • nix flake show and nix eval .#homeModules.host --apply builtins.typeOf succeed after the comment edit.
  • Every allod site subcommand named (deploy, check, config, config show, config update, config replace) exists in cmd/allod/site.go usage text; the symlink refusal for all three writing actions and the config-path resolution through rclone config file with the RCLONE_CONFIG / XDG_CONFIG_HOME fallback were read in cmd/allod/site_config.go; neither variable is set by the nexus or archetypes host modules.
  • git diff master --stat: docs/integration.md and nix/home.nix only.
  • Reviewed by codex (gpt-5.6-sol) twice and pi (gpt-oss-120b) once on the final diff; two codex findings (config path resolution, config create also refusing a symlink) were verified against source and applied, the third (the rotate-token format not existing yet, which the doc states) was rejected; both reviewers report no findings on the final diff.

Labels are unavailable to this token; none is warranted.

Documentation only; nothing changes for a running machine. The integration doc gains a "Site hosting credential" section that tells a fork where `allod site deploy`'s credential comes from: the file rclone reports as its configuration, which on the host is `~/.config/rclone/rclone.conf`, placed there by the framework from `nexusIdentity.siteHostingConfigFile` (allod/secrets#17, allod/archetypes#74), with the human forge token placed the same way from `nexusIdentity.userForgejoTokenFile`. It gives the lifecycle in one place: create once with `allod site config`, move the stanza into the deployment's secrets repository, rotate through `rotate-token` once allod/nexus#42 lands and by re-encrypting until then, verify with `allod site check`. The wrapper comment in `nix/home.nix` gains two lines pointing at that contract; no code in that file changes. The flake still evaluates, and every command and path named was checked against the tools source. If anything here is wrong it is a doc edit, not a rollback. Merge after allod/archetypes#74 so the doc describes something that exists. Closes allod/nexus#44. Refs allod/strategy#51. ## Risk R0. Prose and a comment. ## Validation - `nix flake show` and `nix eval .#homeModules.host --apply builtins.typeOf` succeed after the comment edit. - Every `allod site` subcommand named (`deploy`, `check`, `config`, `config show`, `config update`, `config replace`) exists in `cmd/allod/site.go` usage text; the symlink refusal for all three writing actions and the config-path resolution through `rclone config file` with the `RCLONE_CONFIG` / `XDG_CONFIG_HOME` fallback were read in `cmd/allod/site_config.go`; neither variable is set by the nexus or archetypes host modules. - `git diff master --stat`: `docs/integration.md` and `nix/home.nix` only. - Reviewed by codex (gpt-5.6-sol) twice and pi (gpt-oss-120b) once on the final diff; two codex findings (config path resolution, `config` create also refusing a symlink) were verified against source and applied, the third (the rotate-token format not existing yet, which the doc states) was rejected; both reviewers report no findings on the final diff. Labels are unavailable to this token; none is warranted.
vnprc approved these changes 2026-09-10 16:44:57 +01:00
vnprc merged commit 7211407cb2 into master 2026-09-10 16:45:02 +01:00
vnprc deleted branch agent/site-credential-contract-doc 2026-09-10 16:45:03 +01:00
Sign in to join this conversation.
No description provided.