Skip to content

docs(cloud): document remote web UI preview#2434

Merged
senamakel merged 1 commit into
tinyhumansai:mainfrom
aqilaziz:codex/2433-remote-web-docs
May 23, 2026
Merged

docs(cloud): document remote web UI preview#2434
senamakel merged 1 commit into
tinyhumansai:mainfrom
aqilaziz:codex/2433-remote-web-docs

Conversation

@aqilaziz
Copy link
Copy Markdown
Contributor

@aqilaziz aqilaziz commented May 21, 2026

Summary

  • Added a Cloud Deploy section for the current remote UI path: remote Linux core, local UI/client.
  • Documented a private Vite browser-preview workflow via SSH tunnel for users who want a web-accessible UI today.
  • Documented OPENHUMAN_CORE_ALLOWED_ORIGINS in .env.example for non-loopback browser origins.
  • Added a Platform note clarifying which features still require the Tauri desktop shell.

Problem

Issue #2433 asks for a Linux setup that can be installed remotely and accessed through a web UI instead of relying only on desktop usage. The repo already supports a remote openhuman-core, but the docs did not clearly explain the current UI choices, the preview web path, or the CORS setting needed when serving the UI from a custom origin.

Solution

  • Treats openhuman-core as the supported remote deployment target.
  • Gives a concrete loopback + SSH tunnel flow for private browser UI preview.
  • Calls out the production limitation that the deployed core does not yet serve the full React/Tauri UI.
  • Points non-loopback UI hosts at the existing OPENHUMAN_CORE_ALLOWED_ORIGINS guard.

Submission Checklist

  • Tests added or updated: N/A, docs/env example only.
  • Diff coverage >= 80%: N/A, no executable code changed.
  • Coverage matrix updated: N/A, documentation-only change.
  • All affected feature IDs from the matrix are listed in the PR description: N/A.
  • No new external network dependencies introduced.
  • Manual smoke checklist updated: N/A, no release-cut behavior changed.
  • Linked issue closed via Closes #NNN: N/A, this is a documentation slice for Linux setup to use web ui if possible #2433, not the production webserver feature.

Impact

No runtime behavior changes. Users self-hosting the core get clearer setup guidance and can discover the existing CORS allowlist when using a private browser preview.

Related


AI Authored PR Metadata (required for Codex/Linear PRs)

Linear Issue

  • Key: N/A
  • URL: N/A

Commit & Branch

  • Branch: codex/2433-remote-web-docs
  • Commit SHA: 9dfd6f87808b937c01d69b6710524fcda11c5bf9

Validation Run

  • git diff --check
  • rg -n "Remote UI choices|Remote/headless usage|OPENHUMAN_CORE_ALLOWED_ORIGINS" gitbooks/features/cloud-deploy.md gitbooks/features/platform.md .env.example
  • pnpm --filter openhuman-app format:check: N/A, docs/env-only change; not run in this isolated worktree.
  • pnpm typecheck: N/A, docs/env-only change.
  • Focused tests: N/A, docs/env-only change.
  • Rust fmt/check (if changed): N/A, no Rust changed.
  • Tauri fmt/check (if changed): N/A, no Tauri changed.

Validation Blocked

  • command: N/A
  • error: N/A
  • impact: N/A

Behavior Changes

  • Intended behavior change: N/A, documentation only.
  • User-visible effect: Cloud/headless docs now explain how to access a remote core through a desktop client or private browser preview.

Parity Contract

  • Legacy behavior preserved: Yes, no runtime code changed.
  • Guard/fallback/dispatch parity checks: N/A.

Duplicate / Superseded PR Handling

  • Duplicate PR(s): None found.
  • Canonical PR: This PR.
  • Resolution (closed/superseded/updated): N/A.

@aqilaziz aqilaziz requested a review from a team May 21, 2026 09:51
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 21, 2026

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 9b3354b5-1568-42a1-92e7-f2094b056abd

📥 Commits

Reviewing files that changed from the base of the PR and between bf6f25e and 9dfd6f8.

📒 Files selected for processing (3)
  • .env.example
  • gitbooks/features/cloud-deploy.md
  • gitbooks/features/platform.md

📝 Walkthrough

Walkthrough

The pull request adds documentation and configuration guidance for running the OpenHuman core remotely with a browser-accessible UI. It documents remote/headless operation on Linux, provides practical deployment guidance using Vite with SSH tunneling, and introduces CORS allowlist configuration via a new optional environment variable.

Changes

Remote Core Operation and Browser UI Documentation

Layer / File(s) Summary
Remote/headless core operation overview
gitbooks/features/platform.md
Documents running the Rust core as a remote JSON-RPC service on Linux paired with a local desktop client, clarifies browser UI limitations for Tauri-dependent features, and references Cloud Deploy for current remote UI setup.
Remote UI deployment and CORS guidance
gitbooks/features/cloud-deploy.md
Introduces the core-remote/UI-local deployment model using Vite dev/preview with SSH tunnels, includes instructions for CORS allowlist configuration, and warns about bearer-token exposure with non-HTTPS HTTP origins.
CORS allowlist environment configuration
.env.example
Documents the new OPENHUMAN_CORE_ALLOWED_ORIGINS environment variable for configuring browser origins permitted to call the core /rpc endpoint, with guidance on defaults and non-loopback usage.

🎯 1 (Trivial) | ⏱️ ~3 minutes

🐰 Remote cores now dance free,

With CORS allowlists guiding the spree,

SSH tunnels and UI so bright,

Documentation shines in the light! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The PR title 'docs(cloud): document remote web UI preview' directly matches the main changes: adding documentation about remote web UI deployment options across three files (.env.example, cloud-deploy.md, and platform.md).
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
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.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.


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 and usage tips.

@senamakel senamakel merged commit d42835f into tinyhumansai:main May 23, 2026
32 of 36 checks passed
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