Skip to content

docs: add nginx subpath deployment template#820

Open
blackmammoth wants to merge 1 commit into
mainfrom
docs/add-readme-for-subpath-deployment-host
Open

docs: add nginx subpath deployment template#820
blackmammoth wants to merge 1 commit into
mainfrom
docs/add-readme-for-subpath-deployment-host

Conversation

@blackmammoth
Copy link
Copy Markdown
Collaborator

@blackmammoth blackmammoth commented Jun 2, 2026

Users deploying behind a reverse proxy need a config they can adapt.

The template documents each proxy block and centralizes upstream/subpath values.

It also notes that Nginx location matchers still require literal subpath edits.

Summary by CodeRabbit

Release Notes

  • Documentation
    • Added Nginx configuration template for deploying CloudCLI UI under a configurable subpath. Includes upstream routing, path redirection, and automatic URL rewriting to ensure proper application functionality when deployed under a custom path.

Users deploying behind a reverse proxy need a config they can adapt.

The template documents each proxy block and centralizes upstream/subpath values.

It also notes that Nginx location matchers still require literal subpath edits.
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Jun 2, 2026

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: Pro

Run ID: 5eb0e822-89e7-4a97-815f-3e383a34f52d

📥 Commits

Reviewing files that changed from the base of the PR and between d9e9df1 and c02ead5.

📒 Files selected for processing (1)
  • docs/nginx-subpath-template.conf

📝 Walkthrough

Walkthrough

Added a complete Nginx configuration template for deploying CloudCLI UI under a subpath (default /ai). The template configures upstream routing, handles path redirection, rewrites request URIs for the upstream server, and adjusts response bodies so the frontend's root-relative URLs function correctly at the subpath location.

Changes

Nginx Subpath Template

Layer / File(s) Summary
Nginx subpath template
docs/nginx-subpath-template.conf
Comprehensive Nginx configuration defining worker/HTTP defaults, configurable $cloudcli_subpath and $cloudcli_upstream variables, a /ai/ai/ redirect, URI rewriting and proxying in the main location block, response body sub_filter rules to rewrite root-relative URLs (PWA service worker, manifest, and app URLs), and additional proxy locations for /api/, /ws, /shell, and /health endpoints.

🐰 A template sits in the docs with grace,
Nginx now knows the subpath place,
Requests rewritten, responses flow,
The CloudCLI UI steals the show! 🚀

🚥 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 title 'docs: add nginx subpath deployment template' directly and clearly describes the main change: adding a new documentation file containing an Nginx configuration template for subpath deployment.
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.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch docs/add-readme-for-subpath-deployment-host

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.

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