Skip to content

Commit 7b6b6cd

Browse files
author
Exploding Labs Bot
committed
Update site from docs source repo
1 parent 8b1f96b commit 7b6b6cd

File tree

4 files changed

+88
-14
lines changed

4 files changed

+88
-14
lines changed

superstack/authentication/index.html

Lines changed: 79 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -536,6 +536,30 @@
536536
</span>
537537
</a>
538538

539+
</li>
540+
541+
<li class="md-nav__item">
542+
<a href="#usage" class="md-nav__link">
543+
<span class="md-ellipsis">
544+
✅ Usage
545+
</span>
546+
</a>
547+
548+
<nav class="md-nav" aria-label="✅ Usage">
549+
<ul class="md-nav__list">
550+
551+
<li class="md-nav__item">
552+
<a href="#examples" class="md-nav__link">
553+
<span class="md-ellipsis">
554+
Examples
555+
</span>
556+
</a>
557+
558+
</li>
559+
560+
</ul>
561+
</nav>
562+
539563
</li>
540564

541565
</ul>
@@ -760,6 +784,30 @@
760784
</span>
761785
</a>
762786

787+
</li>
788+
789+
<li class="md-nav__item">
790+
<a href="#usage" class="md-nav__link">
791+
<span class="md-ellipsis">
792+
✅ Usage
793+
</span>
794+
</a>
795+
796+
<nav class="md-nav" aria-label="✅ Usage">
797+
<ul class="md-nav__list">
798+
799+
<li class="md-nav__item">
800+
<a href="#examples" class="md-nav__link">
801+
<span class="md-ellipsis">
802+
Examples
803+
</span>
804+
</a>
805+
806+
</li>
807+
808+
</ul>
809+
</nav>
810+
763811
</li>
764812

765813
</ul>
@@ -803,11 +851,9 @@ <h3 id="update-your-dockerfile">Update Your Dockerfile</h3>
803851

804852
WORKDIR<span class="w"> </span>/var/lib/postgresql
805853
</code></pre></div>
806-
<p>Then rebuild:</p>
854+
<p>Then rebuild the Postgres imageand recreate the container:</p>
807855
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>build<span class="w"> </span>postgres
808-
</code></pre></div>
809-
<p>And recreate the running container:</p>
810-
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>postgres
856+
docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>postgres
811857
</code></pre></div>
812858
<h2 id="2-add-migrations">➡️ 2. Add Migrations</h2>
813859
<h3 id="load-required-extensions">📚 Load Required Extensions</h3>
@@ -996,11 +1042,36 @@ <h2 id="3-run-the-migrations">▶️ 3. Run the Migrations</h2>
9961042
applied.</p>
9971043
<h2 id="4-add-the-auth-schema-to-postgrest">4. Add the Auth Schema to PostgREST</h2>
9981044
<p>Add the auth schema to Postgres in <code>compose.yaml</code>:</p>
999-
<div class="highlight"><pre><span></span><code><span class="nt">PGRST_DB_SCHEMAS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">api,auth</span>
1045+
<div class="highlight"><pre><span></span><code><span class="nt">postgrest</span><span class="p">:</span>
1046+
<span class="w"> </span><span class="nt">environment</span><span class="p">:</span>
1047+
<span class="w"> </span><span class="nt">PGRST_DB_SCHEMAS</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">api,auth</span>
1048+
</code></pre></div>
1049+
<p>And recreate the PostgREST container:</p>
1050+
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>postgrest
1051+
</code></pre></div>
1052+
<h2 id="usage">✅ Usage</h2>
1053+
<p>To use the <code>auth</code> schema, requests <a href="https://docs.postgrest.org/en/stable/references/api/schemas.html#multiple-schemas">must include a
1054+
header</a>.</p>
1055+
<p>GET and HEAD requests should include the header:</p>
1056+
<div class="highlight"><pre><span></span><code>Accept-Profile: auth
1057+
</code></pre></div>
1058+
<p>Other methods (POST, PATCH, PUT and DELETE) should include:</p>
1059+
<div class="highlight"><pre><span></span><code>Content-Profile: auth
1060+
</code></pre></div>
1061+
<h3 id="examples">Examples</h3>
1062+
<p>Login:</p>
1063+
<div class="highlight"><pre><span></span><code>curl<span class="w"> </span><span class="se">\</span>
1064+
<span class="w"> </span>-H<span class="w"> </span><span class="s2">&quot;Content-Profile: auth&quot;</span><span class="w"> </span><span class="se">\</span>
1065+
<span class="w"> </span>-H<span class="w"> </span><span class="s2">&quot;Content-Type: application/json&quot;</span><span class="w"> </span><span class="se">\</span>
1066+
<span class="w"> </span>--data<span class="w"> </span><span class="s1">&#39;{&quot;user_&quot;: &quot;demo&quot;, &quot;pass&quot;: &quot;demo&quot;}&#39;</span><span class="w"> </span><span class="se">\</span>
1067+
<span class="w"> </span>http://localhost/rpc/login
1068+
</code></pre></div>
1069+
<p>Get the refresh token inserted when logged in:</p>
1070+
<div class="highlight"><pre><span></span><code>bin/postgres<span class="w"> </span>psql<span class="w"> </span>-c<span class="w"> </span><span class="s1">&#39;select token from auth.refresh_token order by created_at desc limit 1&#39;</span>
1071+
</code></pre></div>
1072+
<p>Refresh the access token and extract the new token from the Set-Cookie header:</p>
1073+
<div class="highlight"><pre><span></span><code><span class="nb">export</span><span class="w"> </span><span class="nv">ACCESS_TOKEN</span><span class="o">=</span><span class="k">$(</span>curl<span class="w"> </span>--silent<span class="w"> </span>-i<span class="w"> </span>-X<span class="w"> </span>POST<span class="w"> </span>-H<span class="w"> </span><span class="s1">&#39;Cookie: refresh_token=&#39;</span><span class="nv">$REFRESH_TOKEN</span><span class="s1">&#39;; HttpOnly&#39;</span><span class="w"> </span>http://localhost/rpc/refresh_token<span class="w"> </span><span class="p">|</span>sed<span class="w"> </span>-nE<span class="w"> </span><span class="s1">&#39;s/^Set-Cookie: access_token=([^;]*).*/\1/p&#39;</span><span class="k">)</span>
10001074
</code></pre></div>
1001-
<p>✅ Usage</p>
1002-
<p>Explain that all auth endpoints must have a certain header.</p>
1003-
<p>Show example of using each endpoint.</p>
10041075
<ul>
10051076
<li>POST-ing a user.</li>
10061077
<li><code>/rpc/login</code></li>

superstack/index.html

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -629,9 +629,9 @@
629629

630630
<p><img alt="SuperStack" src="assets/logo.png" /></p>
631631
<h1 id="superstack">SuperStack</h1>
632-
<p><em>SuperStack</em> is a lightweight, modular backend powered by PostgreSQL —
633-
perfect for indie developers, SaaS builders, and teams who want full
634-
rontrol without the bloat.</p>
632+
<p><em>SuperStack</em> is a lightweight, modular backend powered by PostgreSQL — perfect
633+
for indie developers, SaaS builders, and teams who want full control without
634+
the bloat.</p>
635635
<p>Spin up a fully working backend in seconds, with zero setup. Just clone and
636636
run.</p>
637637
<hr />

superstack/rabbitmq/index.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -759,11 +759,14 @@ <h3 id="update-your-dockerfile">Update Your Dockerfile</h3>
759759
<span class="c1"># pg_amqp - Used by api schema</span>
760760
COPY<span class="w"> </span>./pg_amqp<span class="w"> </span>/pg_amqp
761761
WORKDIR<span class="w"> </span>/pg_amqp
762-
RUN<span class="w"> </span>make
763-
RUN<span class="w"> </span>make<span class="w"> </span>install
762+
RUN<span class="w"> </span>make<span class="w"> </span><span class="o">&amp;&amp;</span><span class="w"> </span>make<span class="w"> </span>install
764763

765764
WORKDIR<span class="w"> </span>/var/lib/postgresql
766765
</code></pre></div>
766+
<p>Then rebuild the Postgres imageand recreate the container:</p>
767+
<div class="highlight"><pre><span></span><code>docker<span class="w"> </span>compose<span class="w"> </span>build<span class="w"> </span>postgres
768+
docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d<span class="w"> </span>postgres
769+
</code></pre></div>
767770
<blockquote>
768771
<p>You may need to fix "implicit int" errors in pg_amqp, which were reported
769772
<a href="https://github.com/omniti-labs/pg_amqp/issues/41">here</a>, and <a href="https://github.com/omniti-labs/pg_amqp/pull/43">fixed but not

0 commit comments

Comments
 (0)