Skip to content

docs(self-host): installer-generated secrets and non-reuse rules - #521

Open
fetw882 wants to merge 2 commits into
elie222:mainfrom
fetw882:docs/self-host-secrets
Open

docs(self-host): installer-generated secrets and non-reuse rules#521
fetw882 wants to merge 2 commits into
elie222:mainfrom
fetw882:docs/self-host-secrets

Conversation

@fetw882

@fetw882 fetw882 commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Summary

  • New docs/self-host-secrets.md covering installer-filled secrets, openssl shape, non-reuse rules, optional secrets, and never-overwrite existing .env.
  • New file only — avoids hot docs/self-host.md.

Test plan

  • Skim against installer / .env.images.example secret names
  • Confirm single-file docs-only

Summary by CodeRabbit

  • Documentation
    • Added a self-hosted secrets checklist covering required and optional values, secret generation, non-reuse guidance, deployment preparation, and recovery steps.
    • Updated self-hosting documentation with clearer configuration guidance and links to the new secrets checklist.
    • Added the checklist to the README documentation index.

@vercel

vercel Bot commented Sep 3, 2026

Copy link
Copy Markdown

@fetw882 is attempting to deploy a commit to the Inbox Zero Team on Vercel.

A member of the Team first needs to authorize it.

@coderabbitai

coderabbitai Bot commented Sep 3, 2026

Copy link
Copy Markdown

Review Change Stack

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Repository UI

Review profile: CHILL

Plan: Team

Run ID: 68117343-8750-4e10-85e2-2ed692f9ac46

📥 Commits

Reviewing files that changed from the base of the PR and between d1dd5ac and a80c3f5.

📒 Files selected for processing (3)
  • README.md
  • docs/self-host-secrets.md
  • docs/self-host.md

Included review availability: Your plan provides up to 4 included reviews per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

Changes

Self-hosting documentation

Layer / File(s) Summary
Secrets guide and deployment cross-reference
docs/self-host-secrets.md, docs/self-host.md, README.md
Adds the self-hosting secrets checklist, generation rules, optional keys, setup workflow, and recovery guidance. Links to the guide from the self-hosting documentation and README.

Estimated code review effort: 1 (Trivial) | ~5 minutes

Merge Risk: ⚪ Minimal · up to a80c3

This adds and links a self-hosting secrets checklist without changing deployment behavior. The documented setup and recovery guidance is consistent with the existing installer and Compose configuration, so the change is ready to merge.

Suggested reviewers: elie222

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly identifies the self-hosting documentation change and its two main topics: installer-generated secrets and secret non-reuse rules.

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@greptile-apps

greptile-apps Bot commented Sep 3, 2026

Copy link
Copy Markdown
Contributor

Greptile Summary

The PR adds a self-hosting secrets checklist and makes it discoverable from the repository’s existing documentation entry points.

  • Documents installer-generated secrets, non-reuse requirements, optional credentials, and recovery guidance.
  • Adds links from the README and self-hosting guide.
  • Clarifies that installer reruns preserve an existing .env.

Confidence Score: 5/5

The PR appears safe to merge.

No blocking failure remains.

Important Files Changed

Filename Overview
README.md Adds a valid documentation-index link to the new self-host secrets checklist.
docs/self-host-secrets.md Adds the installer secrets, distinctness, optional-key, operator-workflow, and recovery documentation.
docs/self-host.md Adds a valid contextual link to the secrets checklist from the published-images installer instructions.

Reviews (3): Last reviewed commit: "docs: link self-host secrets guide and t..." | Re-trigger Greptile

Comment thread docs/self-host-secrets.md Outdated
@github-actions

github-actions Bot commented Sep 3, 2026

Copy link
Copy Markdown

Playwright screenshots

No new feature frames; gallery is suite-vs-main drift.

Open screenshot gallery · Dashboard · CI run

Updated for commit 27a7153.

fetw882 and others added 2 commits September 4, 2026 13:04
New docs/self-host-secrets.md covering installer-filled keys, distinctness
rules, optional credentials, and safe .env preservation. Does not edit
docs/self-host.md.
Address Greptile discoverability feedback by linking the secrets
checklist from docs/self-host.md and the README docs list. Drop the
process meta line and phantom Related links, replace em dashes, and
clarify Pipedream is source/Compose-only (not in .env.images.example).

Co-authored-by: Elie Steinbock <elie222@users.noreply.github.com>
@fetw882
fetw882 force-pushed the docs/self-host-secrets branch from 27a7153 to a80c3f5 Compare September 4, 2026 05:16
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.

2 participants