AGPL LICENSE, readme

This commit is contained in:
texm
2023-04-26 07:59:40 +08:00
parent ee8fc37867
commit e0488a7d88
6 changed files with 699 additions and 60 deletions

View File

@@ -8,7 +8,7 @@
<div class="hero h-full">
<div class="hero-content text-center flex-col py-10 px-0">
<div class="max-w-md mb-4">
<h1 class="text-5xl font-bold mb-2">A web interface for Dokku</h1>
<h1 class="text-5xl font-bold mb-2">A friendly interface for Dokku</h1>
<p class="text-xl">
an open-source self-hostable web UI to help
<strong>configure</strong> and <strong>deploy</strong>

View File

@@ -3,15 +3,12 @@
import {page} from "$app/stores";
import Navbar from "$components/Navbar.svelte";
import ProgressButtons from "./ProgressButtons.svelte";
import {browser} from "$app/environment";
import {onMount} from "svelte";
const sidebarPages = [
{section: "Getting Started", ref: "/docs/intro", label: "Introduction"},
{ref: "/docs/installation", label: "Install"},
{ref: "/docs/setup", label: "Setup"},
{section: "Usage", ref: "/docs/apps", label: "Apps"},
// {ref: "/docs/apps/create", label: "Create App", level: 1},
{ref: "/docs/services", label: "Services"},
{ref: "/docs/settings", label: "Settings"},
{section: "Maintenance", ref: "/docs/upgrading", label: "Upgrading"},

View File

@@ -1,31 +1,24 @@
<script>
const bootstrapLink = "https://shokku.app/install.sh";
const scriptInstallCommands = [
`wget "https://shokku.app/install.sh"`,
`wget "${bootstrapLink}"`,
`export SHOKKU_LETSENCRYPT_EMAIL="foo@example.com"`,
`sudo bash install.sh`,
]
const manualInstallCommands = [
`todo`,
]
];
</script>
<h2>Prequisites</h2>
<h2>Requirements</h2>
<h3>Dokku</h3>
<p>
Shokku requires an underlying Dokku installation.
You are recommended to manually install & configure it following
<a href="https://dokku.com/docs/getting-started/installation/">the official documentation</a>.
<br />
If an existing installation is not detected during the setup process, it
will be automatically installed and configured.
</p>
<h3>SSL</h3>
<p>
Shokku will only work over HTTPS, so SSL must be configured. This can be via:
</p>
<ul>
<li>
<strong>Automatic (LetsEncrypt)</strong> <br />
@@ -42,15 +35,23 @@
</li>
</ul>
<!--div class="collapse collapse-arrow border border-base-300 bg-base-100 rounded-box">
<input type="checkbox" />
<div class="collapse-title text-lg font-medium">
Default installation configuration
</div>
<div class="collapse-content">
<p>nginx, letsencrypt, etc</p>
</div>
</div-->
<h3>System Requirements</h3>
<p>
Please refer to
<a href="https://dokku.com/docs/getting-started/installation/#system-requirements">
the operating systems supported by Dokku</a>.
<br />
Shokku is lightweight and will consume very little resources.
</p>
<h4>DigitalOcean</h4>
<p>
For a cheap hosted server to try Shokku out, consider using DigitalOcean via this referral
link. You get $200 in credit for 60 days, and I get a $25 kick back :)
</p>
<a target="_blank" href="https://www.digitalocean.com/?refcode=2fb615299eca&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge">
<img src="https://web-platforms.sfo2.digitaloceanspaces.com/WWW/Badge%202.svg" alt="DigitalOcean Referral Badge" />
</a>
<h2>Install Using Script</h2>
@@ -60,15 +61,6 @@
{/each}
</div>
<h2 class="flex items-center gap-2">
<img alt="digitalocean icon" class="w-8 h-8"
src="https://cdn.jsdelivr.net/gh/devicons/devicon/icons/digitalocean/digitalocean-original.svg" />
DigitalOcean 1-Click Install
</h2>
<p>
TODO: link to digitalocean marketplace
</p>
<h2>Manual Installation</h2>
<div class="collapse collapse-arrow border border-base-300 bg-base-100 rounded-box">
<input type="checkbox" />
@@ -78,12 +70,10 @@
<div class="collapse-content">
<p>
If you don't feel comfortable using some random script from the internet,
the installation can be manually performed fairly easily:
the installation can be manually performed fairly easily.
<br />
Take a look at the <a href="{bootstrapLink}">bootstrap script</a>, it is
commented and easy to follow.
</p>
<div class="mockup-code">
{#each manualInstallCommands as cmd, i}
<pre data-prefix="{i}" class="m-0 my-1 p-0"><code>{cmd}</code></pre>
{/each}
</div>
</div>
</div>