Simplify docs and define configuration-first setup #51

Merged

eleith merged 1 commits from docs/household-first-guides into main 2026-10-26 17:51:46 +00:00

Conversation 0 Commits 1 Files Changed 22

+515 -1943

eleith-gitea-agent Bot commented 2026-10-26 17:20:29 +00:00

Copy link

Copy source

Summary

• Rewrite the README and guides for household/homelab users, with a real screenshot and download-first Docker setup.
• Make configuration a field reference; add the philosophy and commented Compose/YAML examples.
• Retire redundant instructions and templates, including .env.example. Preserve the demo folder pending the image work.

Docs first — implementation follows

This deliberately documents the agreed next behavior: YAML auth.origin, optional auth.secret, a random session secret at each startup by default, and no required .env. The current runtime/schema do not yet support that authenticated setup. Follow-up work must update schema/CLI validation, auth/bootstrap origin handling, generated session secrets, source Compose defaults, and related tests.

The deleted-starter test dependency is fixed: minimal-config assertions use a disposable fixture, and a separate test validates the actual downloadable example without auth or environment values. Stale CI path filters are removed; existing docs/** filters cover the replacement.

Checks

• All 402 config tests passed with coverage; config schema drift, build, and type checks passed.
• Repository Prettier check and ESLint passed.
• Local Markdown links/anchors, shell syntax, and whitespace checks passed.
• The unauthenticated downloadable starter passed CLI validation.
• Independent agent review completed.
• Full verification, Docker execution, published-image pulls, and real HTTPS/OIDC were not run for this handoff.

Manual follow-up: run the README on a clean Docker host; after implementation, test both auth methods, default restart sign-out, persistent-secret sessions, and config reloads.

## Summary - Rewrite the README and guides for household/homelab users, with a real screenshot and download-first Docker setup. - Make configuration a field reference; add the philosophy and commented Compose/YAML examples. - Retire redundant instructions and templates, including `.env.example`. Preserve the demo folder pending the image work. ## Docs first — implementation follows This deliberately documents the agreed next behavior: YAML `auth.origin`, optional `auth.secret`, a random session secret at each startup by default, and no required `.env`. The current runtime/schema do not yet support that authenticated setup. Follow-up work must update schema/CLI validation, auth/bootstrap origin handling, generated session secrets, source Compose defaults, and related tests. The deleted-starter test dependency is fixed: minimal-config assertions use a disposable fixture, and a separate test validates the actual downloadable example without auth or environment values. Stale CI path filters are removed; existing `docs/**` filters cover the replacement. ## Checks - All 402 config tests passed with coverage; config schema drift, build, and type checks passed. - Repository Prettier check and ESLint passed. - Local Markdown links/anchors, shell syntax, and whitespace checks passed. - The unauthenticated downloadable starter passed CLI validation. - Independent agent review completed. - Full verification, Docker execution, published-image pulls, and real HTTPS/OIDC were not run for this handoff. Manual follow-up: run the README on a clean Docker host; after implementation, test both auth methods, default restart sign-out, persistent-secret sessions, and config reloads.

eleith added 1 commit 2026-10-26 17:44:56 +00:00

docs: simplify household setup and configuration df2f042d18

eleith force-pushed docs/household-first-guides from 5f1fdaf59b to df2f042d18 2026-10-26 17:44:56 +00:00 Compare

eleith merged commit df2f042d18 into main 2026-10-26 17:51:46 +00:00

eleith deleted branch docs/household-first-guides 2026-10-26 17:51:46 +00:00

eleith-gitea-agent Bot referenced this pull request 2026-10-26 20:25:55 +00:00

feat: configure authentication in YAML #52

Sign in to join this conversation.

Reviewers

No Reviewers

Labels

No items

No labels

Milestone

No items

No Milestone

Assignees

Clear assignees

eleith-gitea-agent Bot eleith (eleith)

No Assignees

2 Participants

Notifications

Subscribe

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: eleith/directory#51