Skip to content

Commit

Permalink
deploy: 05c51c6
Browse files Browse the repository at this point in the history
  • Loading branch information
pomdtr committed Jun 16, 2024
1 parent 5a319d0 commit 826a263
Show file tree
Hide file tree
Showing 5 changed files with 59 additions and 17 deletions.
24 changes: 19 additions & 5 deletions getting-started.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,11 +188,25 @@ <h2 id="installing-smallweb"><a class="header" href="#installing-smallweb">Insta
</code></pre>
<p>or download the latest release from the <a href="https://github.com/pomdtr/smallweb/releases">releases page</a>.</p>
<h2 id="your-first-smallweb-apps"><a class="header" href="#your-first-smallweb-apps">Your first smallweb apps</a></h2>
<p>Smallweb maps each folder in <code>~/www</code> to a new app. Feel free to clone one of the following repositories to get started:</p>
<p>TODO: Add a list of smallweb apps</p>
<p>You can find new smallweb apps by searching for the <code>smallweb-app</code> topic on github.</p>
<p>Once you have cloned a few of them, you can publish them using the free tunneling service.</p>
<p>First, create an account with the <code>smallweb auth signup</code> command. Then, run <code>smallweb tunnel</code> to expose your websites to the internet. Each of your apps will be available at <code>https://&lt;app-name&gt;-&lt;user-name&gt;.smallweb.run</code>: Every request will be routed to your local device, and handled by the smallweb evaluation server.</p>
<p>Smallweb maps each folder in <code>~/www</code> to a new app. You can find new smallweb apps by searching for the <code>smallweb-app</code> topic on github. You can start by cloning one of these repositories in the <code>~/www</code> folder.</p>
<ul>
<li>
<p><a href="https://github.com/pomdtr/smallweb-landing-example">Simple Landing Page</a></p>
<pre><code class="language-sh">git clone https://github.com/pomdtr/smallweb-landing-example ~/www/landing
</code></pre>
</li>
<li>
<p><a href="https://github.com/pomdtr/smallweb-blog-example">Blog using hono</a></p>
<pre><code class="language-sh">git clone https://github.com/pomdtr/smallweb-blog-example ~/www/blog
</code></pre>
</li>
</ul>
<p>Once you have cloned a few of them, you can publish them using the free tunneling service:</p>
<ol>
<li>First, create an account with the <code>smallweb auth signup</code> command.</li>
<li>Then, run <code>smallweb tunnel</code> to expose your websites to the internet.</li>
<li>Open the an app in your browser by visiting <code>https://&lt;app&gt;.&lt;your-username&gt;.smallweb.run</code>.</li>
</ol>
<h2 id="hosting-your-own-smallweb-server"><a class="header" href="#hosting-your-own-smallweb-server">Hosting your own smallweb server</a></h2>
<p>The tunneling service is not meant for production use. As such, you are encouraged to host your own smallweb server.</p>
<p>If you want your apps to be available on the internet, you'll need to buy a domain name, and point it to your server. You can find more information on how to do this in the <a href="./cloudflare/tunnel.html">documentation</a>.</p>
Expand Down
24 changes: 19 additions & 5 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -188,11 +188,25 @@ <h2 id="installing-smallweb"><a class="header" href="#installing-smallweb">Insta
</code></pre>
<p>or download the latest release from the <a href="https://github.com/pomdtr/smallweb/releases">releases page</a>.</p>
<h2 id="your-first-smallweb-apps"><a class="header" href="#your-first-smallweb-apps">Your first smallweb apps</a></h2>
<p>Smallweb maps each folder in <code>~/www</code> to a new app. Feel free to clone one of the following repositories to get started:</p>
<p>TODO: Add a list of smallweb apps</p>
<p>You can find new smallweb apps by searching for the <code>smallweb-app</code> topic on github.</p>
<p>Once you have cloned a few of them, you can publish them using the free tunneling service.</p>
<p>First, create an account with the <code>smallweb auth signup</code> command. Then, run <code>smallweb tunnel</code> to expose your websites to the internet. Each of your apps will be available at <code>https://&lt;app-name&gt;-&lt;user-name&gt;.smallweb.run</code>: Every request will be routed to your local device, and handled by the smallweb evaluation server.</p>
<p>Smallweb maps each folder in <code>~/www</code> to a new app. You can find new smallweb apps by searching for the <code>smallweb-app</code> topic on github. You can start by cloning one of these repositories in the <code>~/www</code> folder.</p>
<ul>
<li>
<p><a href="https://github.com/pomdtr/smallweb-landing-example">Simple Landing Page</a></p>
<pre><code class="language-sh">git clone https://github.com/pomdtr/smallweb-landing-example ~/www/landing
</code></pre>
</li>
<li>
<p><a href="https://github.com/pomdtr/smallweb-blog-example">Blog using hono</a></p>
<pre><code class="language-sh">git clone https://github.com/pomdtr/smallweb-blog-example ~/www/blog
</code></pre>
</li>
</ul>
<p>Once you have cloned a few of them, you can publish them using the free tunneling service:</p>
<ol>
<li>First, create an account with the <code>smallweb auth signup</code> command.</li>
<li>Then, run <code>smallweb tunnel</code> to expose your websites to the internet.</li>
<li>Open the an app in your browser by visiting <code>https://&lt;app&gt;.&lt;your-username&gt;.smallweb.run</code>.</li>
</ol>
<h2 id="hosting-your-own-smallweb-server"><a class="header" href="#hosting-your-own-smallweb-server">Hosting your own smallweb server</a></h2>
<p>The tunneling service is not meant for production use. As such, you are encouraged to host your own smallweb server.</p>
<p>If you want your apps to be available on the internet, you'll need to buy a domain name, and point it to your server. You can find more information on how to do this in the <a href="./cloudflare/tunnel.html">documentation</a>.</p>
Expand Down
24 changes: 19 additions & 5 deletions print.html
Original file line number Diff line number Diff line change
Expand Up @@ -186,11 +186,25 @@ <h2 id="installing-smallweb"><a class="header" href="#installing-smallweb">Insta
</code></pre>
<p>or download the latest release from the <a href="https://github.com/pomdtr/smallweb/releases">releases page</a>.</p>
<h2 id="your-first-smallweb-apps"><a class="header" href="#your-first-smallweb-apps">Your first smallweb apps</a></h2>
<p>Smallweb maps each folder in <code>~/www</code> to a new app. Feel free to clone one of the following repositories to get started:</p>
<p>TODO: Add a list of smallweb apps</p>
<p>You can find new smallweb apps by searching for the <code>smallweb-app</code> topic on github.</p>
<p>Once you have cloned a few of them, you can publish them using the free tunneling service.</p>
<p>First, create an account with the <code>smallweb auth signup</code> command. Then, run <code>smallweb tunnel</code> to expose your websites to the internet. Each of your apps will be available at <code>https://&lt;app-name&gt;-&lt;user-name&gt;.smallweb.run</code>: Every request will be routed to your local device, and handled by the smallweb evaluation server.</p>
<p>Smallweb maps each folder in <code>~/www</code> to a new app. You can find new smallweb apps by searching for the <code>smallweb-app</code> topic on github. You can start by cloning one of these repositories in the <code>~/www</code> folder.</p>
<ul>
<li>
<p><a href="https://github.com/pomdtr/smallweb-landing-example">Simple Landing Page</a></p>
<pre><code class="language-sh">git clone https://github.com/pomdtr/smallweb-landing-example ~/www/landing
</code></pre>
</li>
<li>
<p><a href="https://github.com/pomdtr/smallweb-blog-example">Blog using hono</a></p>
<pre><code class="language-sh">git clone https://github.com/pomdtr/smallweb-blog-example ~/www/blog
</code></pre>
</li>
</ul>
<p>Once you have cloned a few of them, you can publish them using the free tunneling service:</p>
<ol>
<li>First, create an account with the <code>smallweb auth signup</code> command.</li>
<li>Then, run <code>smallweb tunnel</code> to expose your websites to the internet.</li>
<li>Open the an app in your browser by visiting <code>https://&lt;app&gt;.&lt;your-username&gt;.smallweb.run</code>.</li>
</ol>
<h2 id="hosting-your-own-smallweb-server"><a class="header" href="#hosting-your-own-smallweb-server">Hosting your own smallweb server</a></h2>
<p>The tunneling service is not meant for production use. As such, you are encouraged to host your own smallweb server.</p>
<p>If you want your apps to be available on the internet, you'll need to buy a domain name, and point it to your server. You can find more information on how to do this in the <a href="./cloudflare/tunnel.html">documentation</a>.</p>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion searchindex.json

Large diffs are not rendered by default.

0 comments on commit 826a263

Please sign in to comment.