Update site from docs source repo

Author: Exploding Labs Bot

superstack/deploy/index.html

@@ -358,28 +358,28 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#prepare-your-application" class="md-nav__link">
+  <a href="#1-build-your-images" class="md-nav__link">
     <span class="md-ellipsis">
-      Prepare your Application
+      🧱 1. Build Your Images
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#deploy" class="md-nav__link">
+  <a href="#2-copy-to-server" class="md-nav__link">
     <span class="md-ellipsis">
-      📦 Deploy
+      📦 2. Copy to Server
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="📦 Deploy">
+    <nav class="md-nav" aria-label="📦 2. Copy to Server">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#secrets" class="md-nav__link">
+  <a href="#3-set-secrets" class="md-nav__link">
     <span class="md-ellipsis">
-      Secrets
+      3. Set Secrets
     </span>
   </a>
 
@@ -391,27 +391,18 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#launch-your-stack" class="md-nav__link">
+  <a href="#launch-the-app" class="md-nav__link">
     <span class="md-ellipsis">
-      🚀 Launch your Stack
+      🚀 Launch the App
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#github-actions-workflow" class="md-nav__link">
+  <a href="#next-steps" class="md-nav__link">
     <span class="md-ellipsis">
-      Github Actions Workflow
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#what-now" class="md-nav__link">
-    <span class="md-ellipsis">
-      ➕ What Now?
+      🧭 Next Steps
     </span>
   </a>
 
@@ -452,28 +443,28 @@
     <ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
 
         <li class="md-nav__item">
-  <a href="#prepare-your-application" class="md-nav__link">
+  <a href="#1-build-your-images" class="md-nav__link">
     <span class="md-ellipsis">
-      Prepare your Application
+      🧱 1. Build Your Images
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#deploy" class="md-nav__link">
+  <a href="#2-copy-to-server" class="md-nav__link">
     <span class="md-ellipsis">
-      📦 Deploy
+      📦 2. Copy to Server
     </span>
   </a>
 
-    <nav class="md-nav" aria-label="📦 Deploy">
+    <nav class="md-nav" aria-label="📦 2. Copy to Server">
       <ul class="md-nav__list">
 
           <li class="md-nav__item">
-  <a href="#secrets" class="md-nav__link">
+  <a href="#3-set-secrets" class="md-nav__link">
     <span class="md-ellipsis">
-      Secrets
+      3. Set Secrets
     </span>
   </a>
 
@@ -485,27 +476,18 @@
 </li>
 
         <li class="md-nav__item">
-  <a href="#launch-your-stack" class="md-nav__link">
+  <a href="#launch-the-app" class="md-nav__link">
     <span class="md-ellipsis">
-      🚀 Launch your Stack
+      🚀 Launch the App
     </span>
   </a>
 
 </li>
 
         <li class="md-nav__item">
-  <a href="#github-actions-workflow" class="md-nav__link">
+  <a href="#next-steps" class="md-nav__link">
     <span class="md-ellipsis">
-      Github Actions Workflow
-    </span>
-  </a>
-  
-</li>
-      
-        <li class="md-nav__item">
-  <a href="#what-now" class="md-nav__link">
-    <span class="md-ellipsis">
-      ➕ What Now?
+      🧭 Next Steps
     </span>
   </a>
 
@@ -534,49 +516,46 @@ <h1 id="deploying-to-remote-environments">☁️ Deploying to Remote Environment
 <p>SuperStack is <strong>Docker-native</strong>, so deployments are simple, consistent, and
 portable. The goal is that only <code>compose.yaml</code> and secrets need to exist on the
 remote server.</p>
-<h2 id="prepare-your-application">Prepare your Application</h2>
-<p>Services that are built (they have a <code>build:</code> section in <code>compose.yaml</code>), add
-your own container repository image URIs (e.g. your Docker Hub or GitHub
-Container Registry account), for example:</p>
+<h2 id="1-build-your-images">🧱 1. Build Your Images</h2>
+<p>If a service has a <code>build:</code> section, add your own image name and version tag:</p>
 <div class="highlight"><span class="filename">compose.yaml</span><pre><span></span><code><span class="nt">services</span><span class="p">:</span>
 <span class="w">  </span><span class="nt">caddy</span><span class="p">:</span>
 <span class="w">    </span><span class="nt">build</span><span class="p">:</span>
 <span class="w">      </span><span class="nt">context</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./caddy</span>
-<span class="w">    </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghcr.io/youruser/yourapp-caddy:0.1.0</span>
-</code></pre></div>
+<span class="hll"><span class="w">    </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghcr.io/youruser/yourapp-caddy:0.1.0</span>
+</span></code></pre></div>
 <p>Build and push your images:</p>
 <div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>build
 docker<span class="w"> </span>compose<span class="w"> </span>push
 </code></pre></div>
-<h2 id="deploy">📦 Deploy</h2>
-<p>Copy <code>compose.yaml</code> to the server:</p>
+<h2 id="2-copy-to-server">📦 2. Copy to Server</h2>
+<p>Copy your <code>compose.yaml</code> to the remote host:</p>
 <div class="highlight"><pre><span></span><code>scp<span class="w"> </span>compose.yaml<span class="w"> </span>youruser@yourserver:
 </code></pre></div>
-<h3 id="secrets">Secrets</h3>
-<p>The app also needs your secrets (passwords, keys, etc.).</p>
-<p>There are a few options:</p>
+<h3 id="3-set-secrets">3. Set Secrets</h3>
+<p>Your app will need credentials such as database passwords or API keys.
+Choose one of these approaches:</p>
 <ol>
-<li>Put secrets in a <code>.env</code> file on the server, alongside your compose.yaml.
-   Convenient but Less secure. Be sure to <code>chmod 600 .env</code>.</li>
-<li>Set environment variables in the the <code>docker compose</code> command. Inconvenient.
-   Be sure to disable shell history.</li>
-<li>Use environment injection in CI/CD.</li>
+<li><strong><code>.env</code> file</strong> — simplest for manual deploys.</li>
 </ol>
-<h2 id="launch-your-stack">🚀 Launch your Stack</h2>
-<p>Bring up the stack:</p>
+<div class="highlight"><pre><span></span><code>chmod<span class="w"> </span><span class="m">600</span><span class="w"> </span>.env
+</code></pre></div>
+<ol>
+<li><strong>Environment variables</strong> — pass them directly to the command line.</li>
+<li><strong>CI/CD injection</strong> — good for automated pipelines.</li>
+</ol>
+<h2 id="launch-the-app">🚀 Launch the App</h2>
+<p>Start the application on the server:</p>
 <div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>pull
 docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
 </code></pre></div>
+<p>Your backend is now live. 🚀</p>
 <hr />
-<p>That’s it — your backend is live.</p>
-<p>This type of rolling deployment makes it hard to test before going live and to
-rollback, and can have some downtime while upgrading. Consider reading the Wiki
-page on <a href="">Advanced Deployments</a>.</p>
-<h2 id="github-actions-workflow">Github Actions Workflow</h2>
-<p>TODO</p>
-<hr />
-<h2 id="what-now">➕ What Now?</h2>
-<p>Add to your app by following guides in the <a href="https://github.com/explodinlabs/superstack/wiki">Wiki</a>.</p>
+<h2 id="next-steps">🧭 Next Steps</h2>
+<p>This setup replaces the stack in place.</p>
+<p>If you want zero-downtime deployments, rollback support, or blue-green testing,
+see the Wiki page: <a href="https://github.com/explodinlabs/superstack/wiki">Advanced
+Deployments</a>.</p>
 
 
 

superstack/search/search_index.json

@@ -1 +1 @@
-{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#superstack","title":"SuperStack","text":"<p>Jump to: GitHub | Developer Wiki</p> <p>SuperStack is a minimal, modular backend powered by Docker \u2014 perfect for indie developers, SaaS builders, and teams who want full control without the bloat.</p> <p>Spin up a fully working backend in seconds. Just clone, run, and start building.</p>"},{"location":"#what-can-i-do-with-superstack","title":"\ud83d\ude80 What Can I Do with SuperStack?","text":"<p>It's perfect for:</p> <ul> <li>\ud83e\uddf1 Building SaaS apps</li> <li>\ud83d\udcbb Running multiple stacks</li> <li>\ud83d\udce6 Easy database migrations</li> <li>\ud83d\udd27 Customizing your toolchain</li> </ul> <p>Everything runs inside Docker and routes through a single exposed port (via Caddy), making it easy to develop locally or deploy remotely.</p>"},{"location":"#whats-next","title":"\ud83d\udcda What's next?","text":"<p>\ud83d\udc49 Getting Started \u2013 a guide to installing SuperStack and launching the stack.</p>"},{"location":"deploy/","title":"\u2601\ufe0f Deploying to Remote Environments","text":"<p>SuperStack is Docker-native, so deployments are simple, consistent, and portable. The goal is that only <code>compose.yaml</code> and secrets need to exist on the remote server.</p>"},{"location":"deploy/#prepare-your-application","title":"Prepare your Application","text":"<p>Services that are built (they have a <code>build:</code> section in <code>compose.yaml</code>), add your own container repository image URIs (e.g. your Docker Hub or GitHub Container Registry account), for example:</p> compose.yaml<pre><code>services:\n  caddy:\n    build:\n      context: ./caddy\n    image: ghcr.io/youruser/yourapp-caddy:0.1.0\n</code></pre> <p>Build and push your images:</p> <pre><code>docker compose build\ndocker compose push\n</code></pre>"},{"location":"deploy/#deploy","title":"\ud83d\udce6 Deploy","text":"<p>Copy <code>compose.yaml</code> to the server:</p> <pre><code>scp compose.yaml youruser@yourserver:\n</code></pre>"},{"location":"deploy/#secrets","title":"Secrets","text":"<p>The app also needs your secrets (passwords, keys, etc.).</p> <p>There are a few options:</p> <ol> <li>Put secrets in a <code>.env</code> file on the server, alongside your compose.yaml.    Convenient but Less secure. Be sure to <code>chmod 600 .env</code>.</li> <li>Set environment variables in the the <code>docker compose</code> command. Inconvenient.    Be sure to disable shell history.</li> <li>Use environment injection in CI/CD.</li> </ol>"},{"location":"deploy/#launch-your-stack","title":"\ud83d\ude80 Launch your Stack","text":"<p>Bring up the stack:</p> <pre><code>docker compose pull\ndocker compose up -d\n</code></pre> <p>That\u2019s it \u2014 your backend is live.</p> <p>This type of rolling deployment makes it hard to test before going live and to rollback, and can have some downtime while upgrading. Consider reading the Wiki page on Advanced Deployments.</p>"},{"location":"deploy/#github-actions-workflow","title":"Github Actions Workflow","text":"<p>TODO</p>"},{"location":"deploy/#what-now","title":"\u2795 What Now?","text":"<p>Add to your app by following guides in the Wiki.</p>"},{"location":"gettingstarted/","title":"\ud83d\ude80 Getting Started","text":"<p>SuperStack uses Docker, so make sure Docker is installed before you begin.</p>"},{"location":"gettingstarted/#1-get-superstack","title":"1. Get SuperStack","text":""},{"location":"gettingstarted/#option-1-use-the-template-easiest","title":"Option 1: Use the Template (Easiest)","text":"<p>Click Use this template and create a new repository (e.g. <code>myapp-backend</code>) on GitHub.</p> <p>Clone it to your machine:</p> <pre><code>git clone https://github.com/yourname/myapp-backend.git\ncd myapp-backend\n</code></pre>"},{"location":"gettingstarted/#option-2-clone-and-track-upstream-advanced","title":"Option 2: Clone and Track Upstream (Advanced)","text":"<p>If you want to keep SuperStack\u2019s Git history and pull upstream changes later, clone SuperStack:</p> <pre><code>git clone https://github.com/explodinglabs/superstack.git myapp-backend\ncd myapp-backend\n</code></pre> <p>Create your own repo, then:</p> <pre><code>git remote rename origin upstream\ngit remote add origin https://github.com/yourname/myapp-backend.git\ngit push -u origin main\n</code></pre> <p>You can now pull upstream changes with:</p> <pre><code>git pull upstream main\n</code></pre>"},{"location":"gettingstarted/#2-configure-environment-variables","title":"2. Configure Environment Variables","text":"<p>Copy the example environment file:</p> <pre><code>cd app\ncp example.env .env\n</code></pre> <p>The <code>.env</code> file is used to set secrets, passwords, keys, etc.</p> <p>\u26a0\ufe0f Never store secrets in version control.</p>"},{"location":"gettingstarted/#3-start-the-app","title":"3. Start the App","text":"<pre><code>docker compose up -d\n</code></pre> <p>That's it \u2013 your backend is live.</p> <p>Test it with:</p> <pre><code>$ curl http://localhost:8000/healthcheck\nOK\n</code></pre>"},{"location":"gettingstarted/#whats-next","title":"\u2795 What's Next?","text":"<p>\ud83d\udc49 Deploy to a remote environment</p>"}]}
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"Home","text":""},{"location":"#superstack","title":"SuperStack","text":"<p>Jump to: GitHub | Developer Wiki</p> <p>SuperStack is a minimal, modular backend powered by Docker \u2014 perfect for indie developers, SaaS builders, and teams who want full control without the bloat.</p> <p>Spin up a fully working backend in seconds. Just clone, run, and start building.</p>"},{"location":"#what-can-i-do-with-superstack","title":"\ud83d\ude80 What Can I Do with SuperStack?","text":"<p>It's perfect for:</p> <ul> <li>\ud83e\uddf1 Building SaaS apps</li> <li>\ud83d\udcbb Running multiple stacks</li> <li>\ud83d\udce6 Easy database migrations</li> <li>\ud83d\udd27 Customizing your toolchain</li> </ul> <p>Everything runs inside Docker and routes through a single exposed port (via Caddy), making it easy to develop locally or deploy remotely.</p>"},{"location":"#whats-next","title":"\ud83d\udcda What's next?","text":"<p>\ud83d\udc49 Getting Started \u2013 a guide to installing SuperStack and launching the stack.</p>"},{"location":"deploy/","title":"\u2601\ufe0f Deploying to Remote Environments","text":"<p>SuperStack is Docker-native, so deployments are simple, consistent, and portable. The goal is that only <code>compose.yaml</code> and secrets need to exist on the remote server.</p>"},{"location":"deploy/#1-build-your-images","title":"\ud83e\uddf1 1. Build Your Images","text":"<p>If a service has a <code>build:</code> section, add your own image name and version tag:</p> compose.yaml<pre><code>services:\n  caddy:\n    build:\n      context: ./caddy\n    image: ghcr.io/youruser/yourapp-caddy:0.1.0\n</code></pre> <p>Build and push your images:</p> <pre><code>docker compose build\ndocker compose push\n</code></pre>"},{"location":"deploy/#2-copy-to-server","title":"\ud83d\udce6 2. Copy to Server","text":"<p>Copy your <code>compose.yaml</code> to the remote host:</p> <pre><code>scp compose.yaml youruser@yourserver:\n</code></pre>"},{"location":"deploy/#3-set-secrets","title":"3. Set Secrets","text":"<p>Your app will need credentials such as database passwords or API keys. Choose one of these approaches:</p> <ol> <li><code>.env</code> file \u2014 simplest for manual deploys.</li> </ol> <pre><code>chmod 600 .env\n</code></pre> <ol> <li>Environment variables \u2014 pass them directly to the command line.</li> <li>CI/CD injection \u2014 good for automated pipelines.</li> </ol>"},{"location":"deploy/#launch-the-app","title":"\ud83d\ude80 Launch the App","text":"<p>Start the application on the server:</p> <pre><code>docker compose pull\ndocker compose up -d\n</code></pre> <p>Your backend is now live. \ud83d\ude80</p>"},{"location":"deploy/#next-steps","title":"\ud83e\udded Next Steps","text":"<p>This setup replaces the stack in place.</p> <p>If you want zero-downtime deployments, rollback support, or blue-green testing, see the Wiki page: Advanced Deployments.</p>"},{"location":"gettingstarted/","title":"\ud83d\ude80 Getting Started","text":"<p>SuperStack uses Docker, so make sure Docker is installed before you begin.</p>"},{"location":"gettingstarted/#1-get-superstack","title":"1. Get SuperStack","text":""},{"location":"gettingstarted/#option-1-use-the-template-easiest","title":"Option 1: Use the Template (Easiest)","text":"<p>Click Use this template and create a new repository (e.g. <code>myapp-backend</code>) on GitHub.</p> <p>Clone it to your machine:</p> <pre><code>git clone https://github.com/yourname/myapp-backend.git\ncd myapp-backend\n</code></pre>"},{"location":"gettingstarted/#option-2-clone-and-track-upstream-advanced","title":"Option 2: Clone and Track Upstream (Advanced)","text":"<p>If you want to keep SuperStack\u2019s Git history and pull upstream changes later, clone SuperStack:</p> <pre><code>git clone https://github.com/explodinglabs/superstack.git myapp-backend\ncd myapp-backend\n</code></pre> <p>Create your own repo, then:</p> <pre><code>git remote rename origin upstream\ngit remote add origin https://github.com/yourname/myapp-backend.git\ngit push -u origin main\n</code></pre> <p>You can now pull upstream changes with:</p> <pre><code>git pull upstream main\n</code></pre>"},{"location":"gettingstarted/#2-configure-environment-variables","title":"2. Configure Environment Variables","text":"<p>Copy the example environment file:</p> <pre><code>cd app\ncp example.env .env\n</code></pre> <p>The <code>.env</code> file is used to set secrets, passwords, keys, etc.</p> <p>\u26a0\ufe0f Never store secrets in version control.</p>"},{"location":"gettingstarted/#3-start-the-app","title":"3. Start the App","text":"<pre><code>docker compose up -d\n</code></pre> <p>That's it \u2013 your backend is live.</p> <p>Test it with:</p> <pre><code>$ curl http://localhost:8000/healthcheck\nOK\n</code></pre>"},{"location":"gettingstarted/#whats-next","title":"\u2795 What's Next?","text":"<p>\ud83d\udc49 Deploy to a remote environment</p>"}]}