docs(self-hosting): correct what a server change clears, and the cert requirement - #7158
Merged
Merged
Conversation
… requirement The page said the built-in browser's profile survives a server change. It does not — the teardown clears the browser's saved sessions and the agent's folder grants along with the saved route, because those are capabilities granted to a specific deployment. The page now lists what is cleared and what is kept, says why, and notes that a change which cannot complete is refused rather than half-applied. Adds two things a self-hoster hits in practice. Certificate errors are rejected outright with no "continue anyway", so a private CA that is not in the system trust store will not load however correct the URL is — worth saying, since a private CA is a normal self-host setup. And packaging your own shell needs Xcode 26 or newer, which otherwise fails with an opaque actool error. Also notes that the CLI asks which deployment you mean when a machine has more than one configuration, and states signing/notarization for a self-built shell as a requirement rather than predicting what happens without credentials.
|
The latest updates on your projects. Learn more about Vercel for GitHub.
|
Contributor
Greptile SummaryCorrects the self-hosted desktop documentation to match current server-switch cleanup, TLS trust, packaging, signing, and notarization behavior.
Confidence Score: 5/5The documentation-only PR appears safe to merge. No blocking failure remains.
|
| Filename | Overview |
|---|---|
| apps/docs/content/docs/en/platform/self-hosting/desktop.mdx | The revised server-switch and distribution instructions align with the current desktop lifecycle, packaging configuration, and release workflow. |
Reviews (3): Last reviewed commit: "docs(self-hosting): spell out that APPLE..." | Re-trigger Greptile
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
![cubic-dev-ai[bot]](https://avatars.githubusercontent.com/in/1082092?s=60&v=4){kind=small}
…hare package:share is the "send someone a build to try" path. It passes -c.mac.timestamp=none to skip the per-file round trip to Apple's timestamp authority, and its own docstring notes distribution builds need those timestamps. Apple's notary service requires a secure timestamp, so a build made that way cannot be notarized however many credentials the operator supplies — which is exactly what the section was telling them to do. package:mac inherits notarize and hardenedRuntime from electron-builder.yml and leaves timestamps on, and bun run build honours SIM_DESKTOP_DEFAULT_ORIGIN the same way, so the baked-origin instruction is unchanged. Its artifact path and name differ from the share script's per-channel overrides, so those are corrected too, and the two stacked warnings are merged into one.
Collaborator
Author
The variable holds an absolute filesystem path to the App Store Connect key file, not the key material, and @electron/notarize reads it through Node fs so a leading ~ is not expanded — the release workflow carries a comment saying exactly that. Listed alongside the other credentials with no explanation, it reads like somewhere to paste the key, and notarization then fails while every variable looks set.
Collaborator
Author
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Follow-up to #7136. Re-checked the self-hosting desktop page against the merged code and found one flat contradiction plus two gaps a self-hoster hits in practice.
security-guards.ts→callback(false)), so a private CA that is not in the system trust store will not load however correct the URL is. A private CA is a normal self-host setup, so this belongs on the page.Failed to check actool versionon an older toolchain. I hit this myself.Verification
Every claim on the page was re-checked against merged
staging, and the behavioral ones were exercised against a real local deployment withAPPCONFIG_ENVIRONMENTunset (the self-hoster code path):.dmgnpx sim-setup desktopwith real discoveryServer…→ picker → relaunch → loads the self-hosted server, with its own storage partition/desktop/auth, never in-windowConnection isn't secureand recovers via Change server — which is what the new callout documentsType of Change
Testing
bun run docs-manifest:check,bun run check:audits(36/36), and docs lint all pass. Docs-only change — no runtime code touched.Checklist