Skip to content

docs(mintlify): scope live preview to port 3000 #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
arpan-mondal merged 1 commit into from
May 12, 2026
Merged

docs(mintlify): scope live preview to port 3000 #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/getting-started/core-concepts.mdx
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ Templates define reusable sandbox settings such as image, provider, memory, vCPU

## Live Previews

Live previews expose web applications running inside a sandbox through a preview URL. This is useful for coding agents that need to build and inspect web apps.
Live previews expose a web application running inside a sandbox through a preview URL. This is useful for coding agents that need to build and inspect web apps. Today the Docker provider routes port `3000` only via Traefik; configurable ports are on the roadmap. See [Live Preview Architecture](/docs/live-preview-architecture) for details.

## Quotas

Expand Down
4 changes: 2 additions & 2 deletions docs/live-preview-architecture.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
To implement a production-grade, highly scalable "Live Preview" system for 100+ concurrent users entirely powered by **Traefik**. This design supports seamless local development (`*.localhost`) and production environments (`*.stacyide.xyz`), using Traefik's native dynamic discovery.

## Status: Implemented (Phase 1 & 2)
StacyVM now supports automatic Traefik integration for the Docker provider. Preview URLs can be generated via the SDK using `sandbox.getPreviewUrl(port)`.
StacyVM now supports automatic Traefik integration for the Docker provider. Preview URLs can be generated via the SDK using `sandbox.getPreviewUrl(port)`. **Today only port 3000 is routed** (see Traefik labels below); the SDK signature accepts any int, but URLs for other ports will not resolve. Configurable ports are tracked on the roadmap.

## Background & Motivation
StacyVM sandboxes need a way to expose internal web servers (e.g., Vite on 5173, Next.js on 3000) to external users. Traefik is an industry-standard dynamic reverse proxy that integrates natively with Docker. By using Traefik, we eliminate custom proxy code and leverage robust features like automatic SSL (Let's Encrypt), WebSocket support, and zero-downtime configuration updates.
StacyVM sandboxes need a way to expose an internal web server (today: port 3000, e.g., a Next.js dev server) to external users. Traefik is an industry-standard dynamic reverse proxy that integrates natively with Docker. By using Traefik, we eliminate custom proxy code and leverage robust features like automatic SSL (Let's Encrypt), WebSocket support, and zero-downtime configuration updates.

## Architecture

Expand Down
Loading