Skip to content

Commit 9ed0427

Browse files
committed
feat: update documentation and notes for public internet sharing feature with Cloudflare Tunnel and zrok support, emphasizing non-production use
1 parent 1441eb2 commit 9ed0427

9 files changed

Lines changed: 183 additions & 75 deletions

File tree

README.MD

Lines changed: 9 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,10 @@ Maintaining an old PHP 7.4 project while building a new Laravel 11 app on PHP 8.
1313

1414
DevBox Pro is an Electron desktop app with a React renderer and a Node.js main process. It manages PHP, Node.js, MySQL, MariaDB, Redis, Nginx, Apache, PostgreSQL, MongoDB, MinIO, Memcached, Mailpit, phpMyAdmin, Composer, Git, and more from one local interface.
1515

16+
> **Version 1.0.6:** This release focuses on **web server hardening** and the new **Share on Internet** option powered by **Cloudflare Tunnel** and **zrok**.
17+
>
18+
> **Important:** DevBox Pro is built for local development, testing, demos, and temporary preview links. It is **not** intended for production hosting or production traffic.
19+
1620
---
1721

1822
## ✨ Features
@@ -74,6 +78,7 @@ DevBox Pro is an Electron desktop app with a React renderer and a Node.js main p
7478
- Tunnel proxy rewrites redirects, cookies, and absolute local `.test` URLs so public sessions stay on the tunnel hostname
7579
- Cloudflare Quick Tunnels use random `*.trycloudflare.com` URLs
7680
- zrok requires a one-time app-wide enable token in **Binary Manager → Tools**
81+
- Built for previews and reviews, not for production deployment
7782

7883
### 🎯 Framework Support
7984
- **Laravel** - Full support with Artisan, Queue Workers, Scheduler
@@ -122,8 +127,8 @@ DevBox Pro is an Electron desktop app with a React renderer and a Node.js main p
122127
### Installation
123128

124129
1. **Download** the latest release for your platform:
125-
- Windows: `DevBox-Pro-Setup-x.x.x.exe`
126-
- macOS: `DevBox-Pro-x.x.x.dmg`
130+
- Windows: `DevBox-Pro-Setup-1.0.6.exe`
131+
- macOS: `DevBox-Pro-1.0.6.dmg`
127132

128133
2. **Install** the application
129134

@@ -150,6 +155,8 @@ DevBox Pro is an Electron desktop app with a React renderer and a Node.js main p
150155

151156
> **Provider notes:** Cloudflare uses disposable random public URLs on `trycloudflare.com`. zrok requires a one-time app-wide enable step before any project can use it.
152157
158+
> **Production note:** Tunnel sharing is intended for temporary previews, QA, and stakeholder review. Do not use DevBox Pro as a production hosting platform.
159+
153160
### Using Terminal Commands
154161

155162
DevBox Pro lets you use `php`, `npm`, `node`, `composer`, `mysql`, and `mysqldump` directly from any terminal with automatic project version detection:

RELEASE.md

Lines changed: 11 additions & 62 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
# 🚀 DevBox Pro v1.0.5
1+
# 🚀 DevBox Pro v1.0.6
22

33
**Stable Release | Your all-in-one local development environment for PHP & Node.js**
44

55
---
66

7-
## 🆕 What's New in v1.0.5
7+
## 🆕 What's New in v1.0.6
88

99
### ✨ New Features
1010

@@ -16,71 +16,20 @@
1616
- Cloudflare public URLs are only surfaced once the `trycloudflare.com` hostname is resolvable, reducing broken fresh-tunnel links
1717
- zrok public URL detection has been updated for current CLI output formats
1818

19-
#### ⚡ Improved Project Lifecycle Management
20-
- Immediate service stopping when the last active project is closed
21-
- Pending service shutdowns are automatically cancelled when starting new project services
22-
- Track projects currently being started or stopped for accurate status reporting
19+
### 🛡️ Web Server Hardening
2320

24-
#### 🔄 Graceful Update Installation
25-
- Services are stopped before applying an app update via quit-and-install
21+
- Hardened mixed **Nginx** and **Apache** front-door handling when multiple projects and server versions are active
22+
- Improved proxy behavior so tunnel traffic keeps redirects, cookies, and absolute `.test` URLs on the public hostname
23+
- Reduced false-ready tunnel states by waiting for Cloudflare Quick Tunnel hostnames to become resolvable before surfacing them
24+
- Improved web server readiness and startup coordination to reduce port collisions and unstable starts
2625

27-
#### 🪟 Enhanced Window & Migration Handling
28-
- New utility functions for window management and data migration
29-
30-
#### 🗄️ Database Connection Improvements
31-
- Database connection info now displays the correct port for the selected engine version
32-
- Actual running port is used for active database connections instead of the default
33-
- Integrated service configuration for database port offsets across all components
34-
35-
#### 💾 Database Import/Export
36-
- Import and export support for SQL, MongoDB, and PostgreSQL workflows
37-
38-
#### 📦 Expanded Binary Downloads
39-
- One-click downloads for MySQL, MariaDB, Redis, Mailpit, phpMyAdmin, Nginx, Apache, and Node.js binaries
40-
- Download progress tracking and management
41-
- Dynamic loading of bundled binary configuration – new versions appear without an app update
42-
- Binary URL validation script added to the build pipeline
43-
44-
#### 🌐 Front-Door Proxy & Service Serialization
45-
- Front-door proxy handling for Nginx and Apache projects with version checks
46-
- Serialized service starts for Apache and Nginx to prevent port collisions
47-
48-
#### 🛑 Bulk Stop
49-
- Stop all running projects and services at once from the UI
50-
51-
#### 🔗 Git Integration
52-
- Git download support with availability checks before clone operations
53-
54-
#### 🔐 SSL & Import Enhancements
55-
- Enhanced SSL certificate management workflows
56-
- Improved project import functionality
57-
58-
### 🏗️ Architecture & Refactoring
59-
60-
- **Manager refactoring**`CompatibilityManager` split into config and rules modules; `GitManager` split into smaller focused modules for improved maintainability
61-
- **Spawn hardening** – Removed `shell: true` from process spawning across the codebase to avoid `DEP0190` deprecation warnings and improve process handling
62-
- **Data path refactoring** – Centralized data path handling across services and utilities
63-
- **Binary removal** – Better error handling for locked files during binary removal
64-
- **MongoDB** – Enhanced binary detection and repair process
65-
- **MySQL** – Removed redundant logging during startup
66-
- **Nginx lifecycle** – Nginx is reloaded on rapid PHP-CGI port changes
67-
68-
### 🧹 Bug Fixes & Improvements
26+
### 🧹 Fixes Included In This Release
6927

7028
- Fixed public tunnel routing when multiple projects are running across Nginx and Apache
7129
- Fixed Cloudflare tunnel sessions showing the wrong project when multiple projects are shared
7230
- Fixed public tunnel flows that redirected browsers back to local `.test` URLs
7331
- Fixed stale or not-yet-ready Cloudflare Quick Tunnel hostnames being shown as live too early
74-
- Fixed multi-server version bugs when running multiple web server versions simultaneously
75-
- Fixed port conflict issues across services
76-
- Fixed WordPress installation bugs and added PHP extension toggles
77-
- Fixed terminal consuming excessive memory
78-
- Improved Nginx and Apache readiness check timeouts
79-
- Added MySQL error log handling and phpMyAdmin loading state management
80-
- Fixed bugs in PHP binary downloading
81-
- Compatibility management service with remote rule updates integrated into project creation
82-
- Added binary URL checking script to validate download URLs before build
83-
- Comprehensive test coverage: new unit tests for vhost configs, CLI, database, project services, and lifecycle utilities
32+
- Fixed multi-server version issues when running multiple web server versions simultaneously
8433

8534
---
8635

@@ -160,8 +109,8 @@ mysqldump -u root mydb > backup.sql # Dump with the active DB version
160109

161110
| File | Description |
162111
|------|-------------|
163-
| **DevBox-Pro-Setup-1.0.5.exe** | Installer version (recommended) |
164-
| **DevBox-Pro-1.0.5.exe** | Portable version – no installation required |
112+
| **DevBox-Pro-Setup-1.0.6.exe** | Installer version (recommended) |
113+
| **DevBox-Pro-1.0.6.exe** | Portable version – no installation required |
165114

166115
### System Requirements (Windows)
167116
- **OS**: Windows 10/11 (64-bit)

docs/faq.html

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -134,6 +134,19 @@ <h2>❓ General Questions</h2>
134134
</div>
135135
</div>
136136
</div>
137+
138+
<div class="accordion-item">
139+
<button class="accordion-header">
140+
<span>Can I use DevBox Pro in production?</span>
141+
<span class="accordion-chevron"></span>
142+
</button>
143+
<div class="accordion-body">
144+
<div class="accordion-body-inner">
145+
<p>No. DevBox Pro is designed for local development, testing, demos, and temporary preview environments.</p>
146+
<p>Even with internet sharing through Cloudflare Tunnel or zrok, it is <strong>not meant for production use</strong> or long-term public hosting.</p>
147+
</div>
148+
</div>
149+
</div>
137150
</div>
138151
</div>
139152
</section>
@@ -198,6 +211,20 @@ <h2>📁 Projects</h2>
198211
</div>
199212
</div>
200213
</div>
214+
215+
<div class="accordion-item">
216+
<button class="accordion-header">
217+
<span>Can I share a project on the internet?</span>
218+
<span class="accordion-chevron"></span>
219+
</button>
220+
<div class="accordion-body">
221+
<div class="accordion-body-inner">
222+
<p>Yes. DevBox Pro 1.0.6 can expose a running project with <strong>Cloudflare Tunnel</strong> or <strong>zrok</strong>.</p>
223+
<p>Enable <strong>"Share on Internet"</strong> in the project detail view, choose a provider, and start sharing. zrok also requires a one-time app-wide enable step in Binary Manager.</p>
224+
<p>This is intended for previews, demos, and QA, not production deployment.</p>
225+
</div>
226+
</div>
227+
</div>
201228
</div>
202229
</div>
203230
</section>

docs/features.html

Lines changed: 39 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<meta charset="UTF-8">
55
<meta name="viewport" content="width=device-width, initial-scale=1.0">
66
<title>Features — DevBox Pro</title>
7-
<meta name="description" content="Explore all DevBox Pro features: multi-PHP versions, Node.js support, database management, SSL certificates, terminal commands, and more.">
7+
<meta name="description" content="Explore all DevBox Pro features: multi-PHP versions, Node.js support, public tunnel sharing, database management, SSL certificates, terminal commands, and more.">
88
<link rel="icon" href="images/logo.png" type="image/png">
99
<link rel="stylesheet" href="css/style.css">
1010
</head>
@@ -48,6 +48,15 @@ <h1 class="animate-in">
4848
</div>
4949
</section>
5050

51+
<section class="section" style="padding-top:0; padding-bottom:var(--space-2xl);">
52+
<div class="container" style="max-width:900px;">
53+
<div class="callout callout-warning animate-in" style="margin:0 auto;">
54+
<span class="callout-icon">⚠️</span>
55+
<p><strong>Important:</strong> DevBox Pro includes internet tunneling for previews and testing, but the app is <strong>not meant for production use</strong>.</p>
56+
</div>
57+
</div>
58+
</section>
59+
5160
<!-- ============ Multi-PHP ============ -->
5261
<section class="section">
5362
<div class="container">
@@ -172,8 +181,34 @@ <h3>🔒 Automatic HTTPS &amp; Custom Domains</h3>
172181
</div>
173182
</section>
174183

175-
<!-- ============ Terminal & CLI ============ -->
184+
<!-- ============ Public Internet Sharing ============ -->
176185
<section class="section section-alt">
186+
<div class="container">
187+
<div class="feature-row reverse animate-in">
188+
<div class="feature-content">
189+
<h3>🌍 Public Internet Sharing</h3>
190+
<p>
191+
Need to show a local project to a client, teammate, or QA device outside your Wi-Fi network? DevBox Pro 1.0.6 adds per-project public tunnels with <strong>Cloudflare Tunnel</strong> and <strong>zrok</strong>, so you can expose a running local site without a manual deployment.
192+
</p>
193+
<ul>
194+
<li>Per-project <strong>Share on Internet</strong> toggle in Project Details</li>
195+
<li>Choose <strong>Cloudflare Tunnel</strong> or <strong>zrok</strong> as the provider</li>
196+
<li>Optional <strong>Auto-start tunnel</strong> when the project starts</li>
197+
<li>Works with both Nginx and Apache projects, including proxied setups</li>
198+
<li>Cloudflare uses random <code>trycloudflare.com</code> URLs</li>
199+
<li>zrok requires a one-time app-wide enable step in Binary Manager</li>
200+
</ul>
201+
</div>
202+
<div class="screenshot-wrap">
203+
<img src="images/pic-2.png" alt="DevBox Pro project view with project controls and sharing options">
204+
<div class="screenshot-caption">Share a running project publicly without deploying it</div>
205+
</div>
206+
</div>
207+
</div>
208+
</section>
209+
210+
<!-- ============ Terminal & CLI ============ -->
211+
<section class="section">
177212
<div class="container">
178213
<div class="section-header animate-in">
179214
<h2>💻 Terminal Commands</h2>
@@ -244,8 +279,8 @@ <h3>Cloud Updates</h3>
244279
</div>
245280
<div class="card">
246281
<div class="card-icon">🌐</div>
247-
<h3>Network Sharing</h3>
248-
<p>Share projects across your local network with a simple toggle. Great for testing on mobile devices or showing work to teammates.</p>
282+
<h3>Local Network Sharing</h3>
283+
<p>Share projects across your local network with a simple toggle. Great for testing on mobile devices or showing work to teammates on the same Wi-Fi.</p>
249284
</div>
250285
<div class="card">
251286
<div class="card-icon">🔗</div>

docs/getting-started.html

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,15 @@ <h1 class="animate-in">
4848
</div>
4949
</section>
5050

51+
<section class="section" style="padding-top:0; padding-bottom:var(--space-2xl);">
52+
<div class="container" style="max-width:900px;">
53+
<div class="callout callout-warning animate-in" style="margin:0 auto;">
54+
<span class="callout-icon">⚠️</span>
55+
<p><strong>Usage note:</strong> DevBox Pro is intended for local development and preview sharing. It is <strong>not meant for production use</strong>, even when you expose a project with a public tunnel.</p>
56+
</div>
57+
</div>
58+
</section>
59+
5160
<!-- ============ System Requirements ============ -->
5261
<section class="section">
5362
<div class="container">
@@ -182,6 +191,23 @@ <h3>Open Your Project</h3>
182191
</p>
183192
</div>
184193
</li>
194+
195+
<li class="step-item animate-in">
196+
<div class="step-number">6</div>
197+
<div class="step-content">
198+
<h3>Optional: Share It on the Internet</h3>
199+
<p>
200+
If you need to show the project outside your local network, download <strong>Cloudflare Tunnel</strong> or <strong>zrok</strong> from <strong>Binary Manager → Tools</strong>, then open the project detail page and enable <strong>"Share on Internet"</strong>.
201+
</p>
202+
<p style="margin-top:var(--space-sm);">
203+
Choose a provider, optionally enable <strong>"Auto-start tunnel"</strong>, then click <strong>"Start Sharing"</strong> to get a public URL.
204+
</p>
205+
<div class="callout callout-warning" style="margin-top:var(--space-md);">
206+
<span class="callout-icon">🌍</span>
207+
<p>Use public tunnel sharing for previews, QA, and client review. It is not intended for production hosting.</p>
208+
</div>
209+
</div>
210+
</li>
185211
</ol>
186212
</div>
187213
</section>

docs/guides.html

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,6 +48,15 @@ <h1 class="animate-in">
4848
</div>
4949
</section>
5050

51+
<section class="section" style="padding-top:0; padding-bottom:var(--space-2xl);">
52+
<div class="container" style="max-width:900px;">
53+
<div class="callout callout-warning animate-in" style="margin:0 auto;">
54+
<span class="callout-icon">⚠️</span>
55+
<p><strong>Important:</strong> DevBox Pro is built for local development workflows. Internet sharing is available for temporary previews and testing, but the app is <strong>not meant for production use</strong>.</p>
56+
</div>
57+
</div>
58+
</section>
59+
5160
<!-- ============ Guide: Laravel ============ -->
5261
<section class="section" id="guide-laravel">
5362
<div class="container" style="max-width:900px;">
@@ -293,6 +302,52 @@ <h3>Navigate to a project &amp; run commands</h3>
293302
</div>
294303
</section>
295304

305+
<!-- ============ Guide: Internet Sharing ============ -->
306+
<section class="section" id="guide-internet-sharing">
307+
<div class="container" style="max-width:900px;">
308+
<div class="section-header animate-in">
309+
<h2>🌍 Sharing a Project on the Internet</h2>
310+
<p>Expose a local project publicly with Cloudflare Tunnel or zrok.</p>
311+
</div>
312+
313+
<ol class="steps animate-in">
314+
<li class="step-item">
315+
<div class="step-number">1</div>
316+
<div class="step-content">
317+
<h3>Install a tunnel provider</h3>
318+
<p>Open <strong>Binary Manager</strong>, go to <strong>Tools</strong>, and download <strong>Cloudflare Tunnel</strong> or <strong>zrok</strong>. If you choose zrok, complete the one-time app-wide enable step after installation.</p>
319+
</div>
320+
</li>
321+
<li class="step-item">
322+
<div class="step-number">2</div>
323+
<div class="step-content">
324+
<h3>Enable Share on Internet for the project</h3>
325+
<p>Open the project detail page and toggle on <strong>"Share on Internet"</strong>. In the <strong>Public Tunnel</strong> panel, choose <strong>Cloudflare Tunnel</strong> or <strong>zrok</strong>.</p>
326+
</div>
327+
</li>
328+
<li class="step-item">
329+
<div class="step-number">3</div>
330+
<div class="step-content">
331+
<h3>Start the project and publish it</h3>
332+
<p>Start the project if it is not already running, then click <strong>"Start Sharing"</strong>. DevBox Pro will create a public URL that you can open or send to others.</p>
333+
</div>
334+
</li>
335+
<li class="step-item">
336+
<div class="step-number">4</div>
337+
<div class="step-content">
338+
<h3>Use auto-start if needed</h3>
339+
<p>Enable <strong>"Auto-start tunnel"</strong> if the project should automatically publish whenever it starts.</p>
340+
</div>
341+
</li>
342+
</ol>
343+
344+
<div class="callout callout-warning animate-in">
345+
<span class="callout-icon">⚠️</span>
346+
<p><strong>Production note:</strong> Public tunnels are intended for demos, QA, stakeholder review, and short-lived previews. DevBox Pro is not a production hosting platform.</p>
347+
</div>
348+
</div>
349+
</section>
350+
296351
<!-- ============ Guide: Network Sharing ============ -->
297352
<section class="section" id="guide-sharing">
298353
<div class="container" style="max-width:900px;">
@@ -399,7 +454,7 @@ <h3 style="margin-bottom:var(--space-sm);">1. Overview</h3>
399454
<ul style="list-style:none; padding:0; margin-bottom:var(--space-lg); color:var(--text-secondary);">
400455
<li style="padding:4px 0;"><strong>Web Server & PHP/Node Version:</strong> Change the assigned framework versions or switch between Nginx/Apache on the fly.</li>
401456
<li style="padding:4px 0;"><strong>Services:</strong> Toggle specific databases (MySQL, PostgreSQL, MongoDB, etc.) or caching layers (Redis, Memcached) exclusively for this project.</li>
402-
<li style="padding:4px 0;"><strong>Domains & Network:</strong> Add custom domain aliases, change the document root folder, or enable <code>Share on Local Network</code> to test your app from your phone.</li>
457+
<li style="padding:4px 0;"><strong>Domains & Network:</strong> Add custom domain aliases, change the document root folder, enable <code>Share on Local Network</code>, or turn on <code>Share on Internet</code> to publish a temporary tunnel URL.</li>
403458
</ul>
404459

405460
<!-- Terminal Tab -->

0 commit comments

Comments
 (0)