Skip to content

[Docs] Correct self-hosting operator guidance - #1890

Draft
roomote-community[bot] wants to merge 1 commit into
developfrom
fix/accurate-operator-docs-1flcsvj1itkj3
Draft

[Docs] Correct self-hosting operator guidance#1890
roomote-community[bot] wants to merge 1 commit into
developfrom
fix/accurate-operator-docs-1flcsvj1itkj3

Conversation

@roomote-community

Copy link
Copy Markdown
Contributor

​Created by Roomote. View the task or mention @roomote for follow-up asks.

What changed

  • correct self-hosted and homelab RAM guidance, require elevated installer and host CLI examples, and document the current service heap caps
  • document the local Caddy tunnel port and automatic Brain startup
  • align supported deployment environment variables, parser values, defaults, restart behavior, and process-owned sandbox configuration with the implementation

Why this change was made

The operator documentation had drifted from the installer, runtime schemas, process entrypoints, and local development startup behavior. These corrections prevent invalid commands and misleading deployment configuration.

Impact

Operators and contributors now receive accurate setup, resource, privilege, and environment-variable guidance. This is a documentation-only change with no runtime behavior change.

@roomote-community

roomote-community Bot commented Aug 30, 2026

Copy link
Copy Markdown
Contributor Author

1 issue outstanding. See task

  • apps/docs/environment-variables.mdx:231 incorrectly says R_BRAIN_MODEL needs an API restart; the gateway reads the override for each inference request.

Reviewed 736c975

| `R_BRAIN_OPENROUTER_API_KEY` | Memory provider | OpenRouter key that enables Memory embeddings and synthesis. |
| `R_BRAIN_OPENAI_API_KEY` | Memory provider | OpenAI key that enables Memory embeddings and synthesis. |
| `R_BRAIN_MODEL` | Optional | Memory synthesis model in the configured provider's naming. Changes apply immediately. |
| `R_BRAIN_MODEL` | Optional | Memory synthesis model in the configured provider's naming. Changes apply after restarting the API service. |

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

R_BRAIN_MODEL is read by mapBrainModelName for each Brain inference request, so its override takes effect without restarting the API service. The new restart instruction is incorrect and causes needless downtime; document that it applies immediately instead.

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.

1 participant