Skip to content

Commit 6d6e2d6

Browse files
committed
updated docs
1 parent 059b880 commit 6d6e2d6

File tree

1 file changed

+39
-11
lines changed

1 file changed

+39
-11
lines changed

docs/guides.html

Lines changed: 39 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -379,24 +379,52 @@ <h3>Configure Services</h3>
379379
<div class="container" style="max-width:900px;">
380380
<div class="section-header animate-in">
381381
<h2>⚙️ Configuring Settings</h2>
382-
<p>Customize DevBox Pro's appearance and advanced behavior.</p>
382+
<p>Complete guide to DevBox Pro's preferences and configuration.</p>
383383
</div>
384384

385385
<div class="animate-in">
386-
<h3 style="margin-bottom:var(--space-md);">Appearance</h3>
387386
<p style="color:var(--text-secondary); line-height:1.8; margin-bottom:var(--space-lg);">
388-
Head over to the <strong style="color:var(--text-primary);">Settings</strong> page and click the <strong style="color:var(--text-primary);">Appearance</strong> tab to change the look of DevBox Pro. You can switch between Light and Dark modes, or set it to match your system preferences. You can also customize the primary accent color to match your style.
387+
DevBox Pro is highly customizable. The <strong style="color:var(--text-primary);">Settings</strong> page is divided into 5 major tabs:
389388
</p>
390389

391-
<h3 style="margin-bottom:var(--space-md);">Advanced Settings</h3>
392-
<p style="color:var(--text-secondary); line-height:1.8; margin-bottom:var(--space-md);">
393-
The <strong style="color:var(--text-primary);">Advanced</strong> tab in Settings allows you to configure deep application behaviors:
394-
</p>
390+
<!-- General Tab -->
391+
<h3 style="margin-bottom:var(--space-sm);">1. General</h3>
392+
<ul style="list-style:none; padding:0; margin-bottom:var(--space-lg); color:var(--text-secondary);">
393+
<li style="padding:4px 0;"><strong>Projects:</strong> Set the default folder where new projects are created and choose your preferred local Top-Level Domain (TLD) like <code>.test</code> or <code>.local</code>.</li>
394+
<li style="padding:4px 0;"><strong>Startup:</strong> Choose whether DevBox Pro opens automatically when you log into your computer.</li>
395+
<li style="padding:4px 0;"><strong>Default Editor:</strong> Select your preferred code editor (VS Code, Cursor, PhpStorm, etc.) to quickly open project directories directly from the app.</li>
396+
</ul>
397+
398+
<!-- CLI Tool Tab -->
399+
<h3 style="margin-bottom:var(--space-sm);">2. CLI Tool</h3>
400+
<ul style="list-style:none; padding:0; margin-bottom:var(--space-lg); color:var(--text-secondary);">
401+
<li style="padding:4px 0;"><strong>Terminal Commands:</strong> Enable global shims so you can use commands like <code>php</code>, <code>npm</code>, <code>node</code>, <code>composer</code>, and <code>mysql</code> directly from any external terminal. DevBox Pro natively intercepts these and routes them to the correct local version based on what folder you are in.</li>
402+
<li style="padding:4px 0;"><strong>Default Versions:</strong> Set the fallback PHP and Node.js versions to use when you type terminal commands outside of a known project directory.</li>
403+
</ul>
404+
405+
<!-- Network Tab -->
406+
<h3 style="margin-bottom:var(--space-sm);">3. Network</h3>
407+
<ul style="list-style:none; padding:0; margin-bottom:var(--space-lg); color:var(--text-secondary);">
408+
<li style="padding:4px 0;"><strong>Database Credentials:</strong> Configure the universal username/password for MySQL, MariaDB, and PostgreSQL. Changing these restarts the databases automatically to apply the new credentials.</li>
409+
<li style="padding:4px 0;"><strong>Server Timezone:</strong> Synchronize the timezone configuration for PHP and database engines.</li>
410+
<li style="padding:4px 0;"><strong>Port Configuration:</strong> Easily re-map the default ports for databases, object, and caching services if they conflict with software you already have installed.</li>
411+
<li style="padding:4px 0;"><strong>SSL:</strong> Choose if new projects should be generated with valid HTTPS certificates by default.</li>
412+
</ul>
413+
414+
<!-- Appearance Tab -->
415+
<h3 style="margin-bottom:var(--space-sm);">4. Appearance</h3>
416+
<ul style="list-style:none; padding:0; margin-bottom:var(--space-lg); color:var(--text-secondary);">
417+
<li style="padding:4px 0;"><strong>Theme:</strong> Force Light mode, Dark mode, or follow your System settings.</li>
418+
<li style="padding:4px 0;"><strong>Accent Color & Textures:</strong> Tailor the primary UI color and background pattern of the app to your liking.</li>
419+
<li style="padding:4px 0;"><strong>Dark Mode Surface:</strong> Fine-tune the tint and contrast levels of dark mode components.</li>
420+
</ul>
421+
422+
<!-- Advanced Tab -->
423+
<h3 style="margin-bottom:var(--space-sm);">5. Advanced</h3>
395424
<ul style="list-style:none; padding:0; margin-bottom:var(--space-lg); color:var(--text-secondary);">
396-
<li style="padding:4px 0;"><strong>Auto-Start Projects:</strong> Choose whether projects should automatically start when DevBox Pro opens.</li>
397-
<li class="padding:4px 0;"><strong>Default TLD:</strong> Change the default local domain suffix (e.g., from <code>.test</code> to <code>.local</code>).</li>
398-
<li class="padding:4px 0;"><strong>Port Ranges:</strong> Specify the starting ports for web servers to avoid conflicts with other apps.</li>
399-
<li class="padding:4px 0;"><strong>Hardware Acceleration:</strong> Toggle GPU acceleration for the desktop app.</li>
425+
<li style="padding:4px 0;"><strong>App Updates & Rollbacks:</strong> Check for DevBox Pro client updates, or safely roll back to a previous version if an update causes issues.</li>
426+
<li style="padding:4px 0;"><strong>Cloud Updates:</strong> Pull the latest compatibility rules and binary definitions catalog straight from the cloud without updating the core app.</li>
427+
<li style="padding:4px 0;"><strong>Data Management:</strong> Review the raw App Data path, or perform a total factory reset (Clear All Data), which can wipe databases and projects if requested.</li>
400428
</ul>
401429
</div>
402430
</div>

0 commit comments

Comments
 (0)