Skip to content

Commit 16195b6

Browse files
author
Exploding Labs Bot
committed
Update site from docs source repo
1 parent 28c3ce2 commit 16195b6

File tree

2 files changed

+22
-20
lines changed

2 files changed

+22
-20
lines changed

superstack/deploying/index.html

Lines changed: 21 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -426,9 +426,9 @@
426426
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
427427

428428
<li class="md-nav__item">
429-
<a href="#1-set-your-image-names" class="md-nav__link">
429+
<a href="#1-prepare-your-images" class="md-nav__link">
430430
<span class="md-ellipsis">
431-
✅ 1. Set Your Image Names
431+
✅ 1. Prepare your Images
432432
</span>
433433
</a>
434434

@@ -518,9 +518,9 @@
518518
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
519519

520520
<li class="md-nav__item">
521-
<a href="#1-set-your-image-names" class="md-nav__link">
521+
<a href="#1-prepare-your-images" class="md-nav__link">
522522
<span class="md-ellipsis">
523-
✅ 1. Set Your Image Names
523+
✅ 1. Prepare your Images
524524
</span>
525525
</a>
526526

@@ -573,40 +573,42 @@
573573

574574

575575
<h1 id="deploying-to-remote-environments">☁️ Deploying to Remote Environments</h1>
576-
<p>SuperStack is Docker-native, so deployment is simple and portable. Here's
577-
how to deploy it to a remote server.</p>
578-
<h2 id="1-set-your-image-names">✅ 1. Set Your Image Names</h2>
579-
<p>Change the image names to your own (e.g. using your Docker Hub or GitHub
580-
Container Registry account) in <code>compose.yaml</code>, for example:</p>
581-
<div class="highlight"><pre><span></span><code><span class="nt">postgres</span><span class="p">:</span>
582-
<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-postgres</span>
583-
<span class="nt">caddy</span><span class="p">:</span>
576+
<p>SuperStack is Docker-native, so deployment is simple and portable. Here's how
577+
to deploy it to a remote server.</p>
578+
<p>A clear goal of SuperStack is that <strong>only <code>compose.yaml</code> should be required on
579+
the remote server</strong>. No other file should need to be copied there.</p>
580+
<h2 id="1-prepare-your-images">✅ 1. Prepare your Images</h2>
581+
<p>For services that are built, add <code>image:</code> URIs to your own container repository
582+
(e.g. your Docker Hub or GitHub Container Registry account), for example:</p>
583+
<div class="highlight"><span class="filename">compose.yaml</span><pre><span></span><code><span class="nt">caddy</span><span class="p">:</span>
584584
<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</span>
585+
586+
<span class="nt">postgres</span><span class="p">:</span>
587+
<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-postgres</span>
585588
</code></pre></div>
586589
<h2 id="2-build-and-push-your-images">🛠️ 2. Build and Push your Images</h2>
587590
<p>Build your images locally and push to your registry:</p>
588591
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>build
589592
docker<span class="w"> </span>compose<span class="w"> </span>push
590593
</code></pre></div>
591594
<h2 id="3-deploy-the-compose-file">📦 3. Deploy the Compose File</h2>
592-
<p>The only file needed for SuperStack to work on the remote server is
593-
<code>compose.yaml</code>.</p>
595+
<p>Only <code>compose.yaml</code> is required on the remote server.</p>
594596
<p>Copy it to your server:</p>
595597
<div class="highlight"><pre><span></span><code>scp<span class="w"> </span>compose.yaml<span class="w"> </span>youruser@yourserver:
596598
</code></pre></div>
597599
<h2 id="4-launch-your-stack">🚀 4. Launch your Stack</h2>
598600
<p>SSH into your server and bring up the stack.</p>
599601
<p>For production, avoid using <code>.env</code> files. Instead, set secrets directly:</p>
600-
<div class="highlight"><pre><span></span><code><span class="nv">CADDY_PORT</span><span class="o">=</span><span class="m">80</span><span class="w"> </span><span class="se">\</span>
602+
<blockquote>
603+
<p>💡 Avoid leaking secrets by disabling shell history.</p>
604+
</blockquote>
605+
<div class="highlight"><span class="filename">.env</span><pre><span></span><code><span class="nv">JWT_SECRET</span><span class="o">=</span>your-secret<span class="w"> </span><span class="se">\</span>
606+
<span class="nv">CADDY_PORT</span><span class="o">=</span><span class="m">80</span><span class="w"> </span><span class="se">\</span>
601607
<span class="nv">PG_USER</span><span class="o">=</span>admin<span class="w"> </span><span class="se">\</span>
602608
<span class="nv">PG_PASS</span><span class="o">=</span>supersecret<span class="w"> </span><span class="se">\</span>
603609
<span class="nv">POSTGREST_AUTHENTICATOR_PASS</span><span class="o">=</span>supersecret<span class="w"> </span><span class="se">\</span>
604-
<span class="nv">JWT_SECRET</span><span class="o">=</span>your-secret<span class="w"> </span><span class="se">\</span>
605610
docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
606611
</code></pre></div>
607-
<blockquote>
608-
<p>💡 Avoid leaking secrets by disabling shell history.</p>
609-
</blockquote>
610612
<p>Alternatively, use environment injection in your CI/CD.</p>
611613
<hr />
612614
<p>That’s it — your backend is live.</p>

0 commit comments

Comments
 (0)