docs: update self-hosted setup for runtime config UI and code-server auth - #767
Open
tembo[bot] wants to merge 2 commits into
Open
tembo[bot] wants to merge 2 commits into
tembo[bot] wants to merge 2 commits into
Conversation
The auto-restart-on-file-change watcher for config.json was removed; restart is now explicit (via the API service command or the new Settings > Self-hosted > Environment settings page).
tembo
Bot
requested review from
Coleary005,
DarrenBaldwin07 and
benja
as code owners
September 16, 2026 13:13
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Automations to automatically generate PRs for you. |
Contributor
Author
|
Requesting review from @Coleary005 who has experience with the following files modified in this PR:
|
code-server auth changed from none to password (the Tembo license key) in the same self-hosted release.
tembo
Bot
changed the title
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
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.
What changed
Self-hosted setup docs described the VS Code config-editing server as passwordless and said config.json edits get restarted automatically. They also only described manual file editing for GitHub, Sentry, Slack, and Linear credentials. Updated:
features/self-hosted/deploy/aws.mdx,deploy/azure.mdx,deploy/gcp.mdx— added a note that the VS Code server at:8888now requires signing in with the Tembo license key as the password; removed the now-false claim that a background service auto-restarts the API after a config.json edit (aws/azure only, gcp never made this claim).features/self-hosted/integrations/overview.mdx— noted that many config keys can now also be viewed/edited from Settings → Self-hosted → Environment settings (new in-app runtime config editor), alongside the existing manualconfig.json+ restart instructions.features/self-hosted/integrations/github.mdx,sentry.mdx,slack.mdx,linear.mdx— removed the now-false "Updating the config.json will also cause the instance API to restart automatically" line.Why
Two monorepo PRs, both merged and released in v0.2.842, changed the self-hosted setup flow this doc section describes:
tembo-ts-api/tembo-ts-agent/tembo-ts-managerwhen/var/lib/tembo/config.jsonchanged on disk, and replaced it with an in-app Settings → Self-hosted → Environment settings editor that requires an explicit restart.authsetting from"none"to"password", with the password derived from the instance's license key. Previously anyone who could reach port 8888 could edit the config with no login at all.The docs' claims about automatic restart and an open VS Code server are now incorrect, and the new, easier configuration path wasn't mentioned anywhere.
Evidence
docs/adr/003-self-hosted-infrastructure-architecture.md(in the monorepo) was updated in the same commit: step 3 of the three-layer config system changed from "Config reload — systemd path watcher auto-restarts services when config changes" to "Runtime settings — organization admins edit structured Convict settings on the self-hosted settings page, then explicitly restart services to apply them." The old watcher,nix/modules/tembo-config-reload.nix, was deleted in the same commit. New UI:apps/web/components/settings/runtime-config-editor.tsxandself-hosted-services.tsx, mounted at/settings/self-hostedwith an "Environment settings" section (copy: "Changes save when you leave a field, then take effect after services restart.") and a page-level "Restart services" action. Shared field list inpackages/shared/src/runtime-config.ts.github.*/gitlab.*keys,selfHosted.objectStorage.*, and core/auth keys are all present inSELF_HOSTED_RUNTIME_CONFIG_DEFINITIONS. Theslack.*,linear.*, andsentry.clientId/sentry.clientSecret/sentry.appNamekeys used by the Slack/Linear/Sentry product integrations are not in that list (the editor's "advanced"api.sentry.*keys configure Tembo's own error reporting, a different feature) — so those integration guides keep their file-based instructions, and this PR only removes the false restart claim from them rather than pointing them at the new UI.nix/hosts/self-hosted/stage2/code-server.nixsetsauth = "password"with ahashedPasswordderived (viaargon2) from/var/lib/flake-installer/.installer/license-key.txt, replacing the priornix/hosts/self-hosted/stage2/debug-tools.nixconfig that setauth = "none". The password a user types is therefore the plaintext license key, which the docs already tell customers to obtain before starting (deploy/aws.mdx: "you will need a license key").Confidence
High confidence: both are definitively-shipped, unflagged changes confirmed directly in the self-hosted NixOS modules and (for #10897) the project's own architecture decision record — not inferred from behavior. Each edit is a small, surgical correction or one-line addition — no restructuring, no speculative wording, and no claim about UI/key coverage that isn't directly backed by
runtime-config.ts's field list.cc @benja