Allow self-hosted deploys locally without using tunnel #2064
Conversation
|
WalkthroughThe updates include documentation changes to clarify build instructions and wording, an adjustment to environment variable usage for API URLs in a loader function, and an enhancement to Docker build logic to normalize API URLs on macOS. A new helper function was introduced to support platform-specific URL normalization. Changes
Sequence Diagram(s)sequenceDiagram
participant Developer
participant BuildScript
participant Docker
participant LocalServer
Developer->>BuildScript: Run build (with API URL)
BuildScript->>normalizeApiUrlForBuild: Normalize API URL (check platform)
normalizeApiUrlForBuild-->>BuildScript: Return normalized URL
BuildScript->>Docker: Pass normalized API URL as build arg
Docker->>LocalServer: Connect using API URL (host.docker.internal or localhost)
Poem
✨ Finishing Touches
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
73-73: Add language specifier to fenced code block.The fenced code block is missing a language specifier, which is flagged by markdownlint.
- ``` + ```sh
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (4)
CONTRIBUTING.md(1 hunks)apps/supervisor/README.md(1 hunks)apps/webapp/app/routes/api.v1.projects.$projectRef.$env.ts(1 hunks)packages/cli-v3/src/deploy/buildImage.ts(2 hunks)
🧰 Additional context used
🪛 markdownlint-cli2 (0.17.2)
CONTRIBUTING.md
72-72: Fenced code blocks should have a language specified
null
(MD040, fenced-code-language)
⏰ Context from checks skipped due to timeout of 90000ms (7)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (windows-latest - npm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - pnpm)
- GitHub Check: e2e / 🧪 CLI v3 tests (ubuntu-latest - npm)
- GitHub Check: typecheck / typecheck
- GitHub Check: units / 🧪 Unit Tests
- GitHub Check: Analyze (javascript-typescript)
🔇 Additional comments (5)
apps/supervisor/README.md (1)
39-39: Wording improvement looks good.The change from "reference project" to "test project" is appropriate and makes the intent clearer.
apps/webapp/app/routes/api.v1.projects.$projectRef.$env.ts (1)
91-91: API URL environment variable change improves flexibility.This change adds a fallback mechanism for API URL determination, preferring
API_ORIGINif available, otherwise falling back toAPP_ORIGIN. This supports the goal of enabling local self-hosted deployments without tunnels.This change aligns with the normalizeApiUrlForBuild helper function added in buildImage.ts.
CONTRIBUTING.md (1)
71-74: Comprehensive build instructions now cover all necessary components.The build instructions have been updated to cover all required components instead of just the webapp, which is more thorough and will help prevent issues when testing changes that span multiple packages.
🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
72-72: Fenced code blocks should have a language specified
null(MD040, fenced-code-language)
packages/cli-v3/src/deploy/buildImage.ts (2)
330-330: Improved Docker network handling for local development.The API URL is now normalized before being passed as a build argument, which addresses connectivity issues between Docker containers and the host machine, particularly on macOS.
727-735: Well-implemented platform-specific URL normalization.The
normalizeApiUrlForBuildfunction intelligently handles the platform-specific networking requirements for Docker. On macOS, it replaces "localhost" with "host.docker.internal" to ensure Docker containers can properly communicate with services on the host.This change is crucial for enabling local self-hosted deployments without tunnels, which is the core goal of this PR.
Summary by CodeRabbit
Documentation
Bug Fixes
New Features