336 lines
18 KiB
HTML
336 lines
18 KiB
HTML
<!DOCTYPE html>
|
|
<html lang="en">
|
|
<head>
|
|
<meta charset="UTF-8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
|
|
<meta name="description" content="The official setup guide for Spaces on StartOS — installation, configuration, and your first workspace." />
|
|
<title>Spaces StartOS Guide — Setup & Configuration</title>
|
|
<link rel="preconnect" href="https://fonts.googleapis.com" />
|
|
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin />
|
|
<link href="https://fonts.googleapis.com/css2?family=Inter:wght@400;500;600;700;800&family=JetBrains+Mono:wght@400;500&display=swap" rel="stylesheet" />
|
|
<link rel="stylesheet" href="styles.css" />
|
|
</head>
|
|
<body>
|
|
<header class="site-header">
|
|
<div class="container header-inner">
|
|
<a href="#top" class="brand" aria-label="Spaces StartOS Guide home">
|
|
<span class="brand-mark" aria-hidden="true">
|
|
<svg viewBox="0 0 32 32" width="28" height="28" fill="none" xmlns="http://www.w3.org/2000/svg">
|
|
<rect x="2" y="2" width="28" height="28" rx="8" fill="url(#g)" />
|
|
<path d="M10 12.5C10 11.1193 11.1193 10 12.5 10H17C19.7614 10 22 12.2386 22 15V15C22 17.7614 19.7614 20 17 20H14V22.5C14 22.7761 13.7761 23 13.5 23H10.5C10.2239 23 10 22.7761 10 22.5V12.5Z" fill="white"/>
|
|
<defs>
|
|
<linearGradient id="g" x1="0" y1="0" x2="32" y2="32" gradientUnits="userSpaceOnUse">
|
|
<stop stop-color="#7C3AED"/>
|
|
<stop offset="1" stop-color="#4F46E5"/>
|
|
</linearGradient>
|
|
</defs>
|
|
</svg>
|
|
</span>
|
|
<span class="brand-text">
|
|
<span class="brand-name">Spaces</span>
|
|
<span class="brand-sub">StartOS Guide</span>
|
|
</span>
|
|
</a>
|
|
<nav class="top-nav" aria-label="Primary">
|
|
<a href="#introduction">Introduction</a>
|
|
<a href="#install">Install</a>
|
|
<a href="#configure">Configure</a>
|
|
<a href="#first-space">First Space</a>
|
|
<a href="#troubleshooting">Help</a>
|
|
</nav>
|
|
<a class="btn btn-outline btn-sm" href="#install">Get started →</a>
|
|
</div>
|
|
</header>
|
|
|
|
<main id="top">
|
|
<section class="hero">
|
|
<div class="container hero-inner">
|
|
<span class="eyebrow">Setup Guide · v2.4</span>
|
|
<h1>Get up and running with <span class="grad">Spaces</span> on StartOS</h1>
|
|
<p class="lead">
|
|
A step-by-step walkthrough to install StartOS, configure your environment, and
|
|
launch your first Space — typically in under ten minutes.
|
|
</p>
|
|
<div class="hero-actions">
|
|
<a class="btn btn-primary" href="#install">Start the setup</a>
|
|
<a class="btn btn-ghost" href="#introduction">Read the intro</a>
|
|
</div>
|
|
<ul class="hero-meta">
|
|
<li><span>⏱</span> ~10 minutes</li>
|
|
<li><span>💻</span> macOS · Linux · Windows</li>
|
|
<li><span>📦</span> No prior setup required</li>
|
|
</ul>
|
|
</div>
|
|
</section>
|
|
|
|
<div class="container layout">
|
|
<aside class="toc" aria-label="On this page">
|
|
<p class="toc-title">On this page</p>
|
|
<ol>
|
|
<li><a href="#introduction" class="active">Introduction</a></li>
|
|
<li><a href="#prerequisites">Prerequisites</a></li>
|
|
<li><a href="#install">1. Install StartOS</a></li>
|
|
<li><a href="#configure">2. Configure your instance</a></li>
|
|
<li><a href="#first-space">3. Create your first Space</a></li>
|
|
<li><a href="#verify">4. Verify the installation</a></li>
|
|
<li><a href="#troubleshooting">Troubleshooting</a></li>
|
|
<li><a href="#next-steps">Next steps</a></li>
|
|
</ol>
|
|
<div class="toc-card">
|
|
<p class="toc-card-title">Need a hand?</p>
|
|
<p class="toc-card-body">Reach the team in our community Slack or open a ticket — we usually respond within a business day.</p>
|
|
<a href="#" class="btn btn-outline btn-sm">Contact support</a>
|
|
</div>
|
|
</aside>
|
|
|
|
<article class="content">
|
|
<section id="introduction" class="doc-section">
|
|
<h2>Introduction</h2>
|
|
<p>
|
|
<strong>Spaces</strong> is the workspace layer of StartOS — a lightweight
|
|
runtime for organizing services, data, and collaborators into isolated
|
|
environments you can spin up, snapshot, and tear down on demand. Whether
|
|
you're prototyping a side project or operating a fleet of production
|
|
deployments, Spaces gives you a consistent, reproducible foundation.
|
|
</p>
|
|
<p>
|
|
This guide will walk you through installing StartOS, performing the initial
|
|
setup, and launching your first Space. By the end, you'll have a running
|
|
instance with one workspace ready for work.
|
|
</p>
|
|
|
|
<figure>
|
|
<img src="images/screenshot-dashboard.png" alt="StartOS Spaces dashboard showing the welcome screen with a Create Your First Space button" />
|
|
<figcaption>The StartOS dashboard after a fresh install.</figcaption>
|
|
</figure>
|
|
|
|
<div class="callout callout-info">
|
|
<strong>Heads up:</strong> StartOS is still moving fast. If something looks
|
|
different from a screenshot, check the version badge in the bottom-left
|
|
corner of the dashboard.
|
|
</div>
|
|
</section>
|
|
|
|
<section id="prerequisites" class="doc-section">
|
|
<h2>Prerequisites</h2>
|
|
<p>Before you begin, make sure you have:</p>
|
|
<ul class="check-list">
|
|
<li>A machine running macOS 12+, Ubuntu 20.04+, or Windows 10+ (with WSL2).</li>
|
|
<li>At least <strong>4 GB of RAM</strong> and <strong>10 GB of free disk space</strong>.</li>
|
|
<li>Administrator (sudo) access on the target machine.</li>
|
|
<li>Network access to <code>downloads.startos.example</code>.</li>
|
|
<li>A StartOS account — <a href="#">create one for free</a> if you don't have one.</li>
|
|
</ul>
|
|
</section>
|
|
|
|
<section id="install" class="doc-section">
|
|
<h2>1. Install StartOS</h2>
|
|
<p>
|
|
The fastest way to install StartOS is via the official installer. It
|
|
bundles the runtime, CLI, and a local control plane into a single setup
|
|
flow.
|
|
</p>
|
|
|
|
<h3>Download the installer</h3>
|
|
<p>Open a terminal and run the install script:</p>
|
|
<pre><code><span class="prompt">$</span> curl -fsSL https://get.startos.example | sh</code></pre>
|
|
|
|
<p>
|
|
The installer will detect your platform, fetch the appropriate package, and
|
|
guide you through a four-step wizard. When prompted, select
|
|
<strong>Standard Installation</strong> unless you have specific
|
|
infrastructure requirements.
|
|
</p>
|
|
|
|
<figure>
|
|
<img src="images/screenshot-install.png" alt="The StartOS installation wizard showing step 2 of 4, with Standard Installation selected" />
|
|
<figcaption>The installation wizard — step 2 of 4.</figcaption>
|
|
</figure>
|
|
|
|
<div class="callout callout-warn">
|
|
<strong>Tip:</strong> On Linux servers without a desktop environment, pass
|
|
<code>--headless</code> to skip the GUI wizard:
|
|
<code>sh -c "$(curl -fsSL https://get.startos.example) --headless"</code>.
|
|
</div>
|
|
</section>
|
|
|
|
<section id="configure" class="doc-section">
|
|
<h2>2. Configure your instance</h2>
|
|
<p>
|
|
Once StartOS is installed, open the dashboard at
|
|
<code>http://localhost:8080</code>. You'll be guided through a short
|
|
first-run configuration. Most users only need to set a hostname, choose a
|
|
port, and enable HTTPS.
|
|
</p>
|
|
|
|
<figure>
|
|
<img src="images/screenshot-config.png" alt="StartOS configuration page on the Networking tab, with hostname, port, HTTPS toggle, and domain fields" />
|
|
<figcaption>Configuring networking from the Settings panel.</figcaption>
|
|
</figure>
|
|
|
|
<h3>Recommended defaults</h3>
|
|
<div class="table-wrap">
|
|
<table>
|
|
<thead>
|
|
<tr>
|
|
<th>Setting</th>
|
|
<th>Recommended value</th>
|
|
<th>Notes</th>
|
|
</tr>
|
|
</thead>
|
|
<tbody>
|
|
<tr>
|
|
<td>Hostname</td>
|
|
<td><code>startos-spaces</code></td>
|
|
<td>Used for service discovery.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Port</td>
|
|
<td><code>8080</code></td>
|
|
<td>Change if another service is bound.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Enable HTTPS</td>
|
|
<td>On</td>
|
|
<td>StartOS will provision a self-signed cert.</td>
|
|
</tr>
|
|
<tr>
|
|
<td>Domain</td>
|
|
<td><code>spaces.example.com</code></td>
|
|
<td>Optional — leave blank for local-only access.</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
</section>
|
|
|
|
<section id="first-space" class="doc-section">
|
|
<h2>3. Create your first Space</h2>
|
|
<p>
|
|
From the dashboard, click <strong>Create Your First Space</strong>. Give
|
|
your Space a name, pick the region closest to you, and choose a resource
|
|
tier. The <em>Medium</em> tier is a good starting point for most projects.
|
|
</p>
|
|
|
|
<figure>
|
|
<img src="images/screenshot-create-space.png" alt="The Create New Space form with fields for name, region, resource tier, and tags" />
|
|
<figcaption>Creating a new Space takes about 30 seconds.</figcaption>
|
|
</figure>
|
|
|
|
<ol class="numbered">
|
|
<li><strong>Name your Space.</strong> Use something descriptive like <code>my-workspace</code> or <code>acme-prod</code>.</li>
|
|
<li><strong>Pick a region.</strong> Latency-sensitive workloads should run closest to their users.</li>
|
|
<li><strong>Choose a tier.</strong> You can resize the Space later without downtime.</li>
|
|
<li><strong>(Optional) Add tags.</strong> Tags make it easier to filter Spaces in larger teams.</li>
|
|
<li>Click <strong>Create Space</strong>. You'll be redirected to the Space's overview page.</li>
|
|
</ol>
|
|
|
|
<p>After a few moments, your Space will appear in the Spaces list with a green <strong>Running</strong> badge.</p>
|
|
|
|
<figure>
|
|
<img src="images/screenshot-spaces-list.png" alt="The Spaces list showing Production, Staging, and Development workspaces, all with Running status" />
|
|
<figcaption>Multiple Spaces, each with live CPU and memory metrics.</figcaption>
|
|
</figure>
|
|
</section>
|
|
|
|
<section id="verify" class="doc-section">
|
|
<h2>4. Verify the installation</h2>
|
|
<p>
|
|
From any terminal, you can confirm that StartOS is healthy and that all
|
|
services are reporting in:
|
|
</p>
|
|
<figure>
|
|
<img src="images/screenshot-terminal.png" alt="A terminal showing startos --version and startos status commands with healthy OK output for every service" />
|
|
<figcaption><code>startos status</code> should report every service as OK.</figcaption>
|
|
</figure>
|
|
<p>
|
|
If any service is in a <code>DEGRADED</code> or <code>DOWN</code> state, jump
|
|
to the <a href="#troubleshooting">Troubleshooting</a> section below.
|
|
</p>
|
|
</section>
|
|
|
|
<section id="troubleshooting" class="doc-section">
|
|
<h2>Troubleshooting</h2>
|
|
|
|
<details>
|
|
<summary>The installer fails with "port 8080 is in use"</summary>
|
|
<p>
|
|
Another service is already bound to port 8080. Either stop the
|
|
conflicting service or re-run the installer with
|
|
<code>--port 9090</code> to use a different port.
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>The dashboard won't load at <code>http://localhost:8080</code></summary>
|
|
<p>
|
|
Run <code>startos status</code> in a terminal. If the
|
|
<code>web</code> service is not reporting OK, restart it with
|
|
<code>startos restart web</code>.
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>I see "Permission denied" during install on Linux</summary>
|
|
<p>
|
|
The installer needs to write to <code>/usr/local/bin</code>. Re-run the
|
|
script with <code>sudo</code>, or specify a writable prefix with
|
|
<code>--prefix=$HOME/.local</code>.
|
|
</p>
|
|
</details>
|
|
|
|
<details>
|
|
<summary>My Space is stuck on "Provisioning"</summary>
|
|
<p>
|
|
Provisioning typically completes in under a minute. If it takes longer,
|
|
check the activity log on the Space's overview page. Most often this
|
|
indicates a temporary region capacity issue — try a different region.
|
|
</p>
|
|
</details>
|
|
</section>
|
|
|
|
<section id="next-steps" class="doc-section">
|
|
<h2>Next steps</h2>
|
|
<p>You're up and running. Here are some good places to go from here:</p>
|
|
<div class="cards">
|
|
<a href="#" class="card">
|
|
<h4>Deploy a service</h4>
|
|
<p>Drop a service into your Space from the template gallery.</p>
|
|
<span class="card-link">Browse templates →</span>
|
|
</a>
|
|
<a href="#" class="card">
|
|
<h4>Invite your team</h4>
|
|
<p>Add collaborators and set role-based permissions.</p>
|
|
<span class="card-link">Manage members →</span>
|
|
</a>
|
|
<a href="#" class="card">
|
|
<h4>Automate with the CLI</h4>
|
|
<p>Use the <code>startos</code> CLI to script common tasks.</p>
|
|
<span class="card-link">Read the CLI docs →</span>
|
|
</a>
|
|
</div>
|
|
</section>
|
|
</article>
|
|
</div>
|
|
</main>
|
|
|
|
<footer class="site-footer">
|
|
<div class="container footer-inner">
|
|
<div class="footer-brand">
|
|
<span class="brand-name">Spaces · StartOS Guide</span>
|
|
<p>A fictional setup guide built as a static-site demo.</p>
|
|
</div>
|
|
<div class="footer-links">
|
|
<a href="#introduction">Docs</a>
|
|
<a href="#troubleshooting">Help</a>
|
|
<a href="#">Changelog</a>
|
|
<a href="#">Status</a>
|
|
</div>
|
|
<p class="footer-meta">© 2026 StartOS Spaces · Made with care</p>
|
|
</div>
|
|
</footer>
|
|
|
|
<script src="script.js" defer></script>
|
|
</body>
|
|
</html>
|