Skip to content
KylthDOCS

Install

Download the installer, read it, run it, then create the owner account in your browser.

Before you start

1. Download and read the installer

curl -fsSLO https://kylth.com/install.sh
less install.sh

Read it before you run it. It’s a short, commented shell script, and the steps below are everything it does.

2. Run it

sudo bash install.sh

The installer:

  1. Checks the server: root, x86_64, Docker and Compose, and ports 80 and 443 free.
  2. Asks for the dashboard’s domain and the projects’ domain.
  3. Creates Kylth’s folders.
  4. Writes /etc/kylth/docker-compose.yml and /etc/kylth/.env.
  5. Pulls Kylth’s image, starts it, and waits until it reports healthy.

It installs nothing else and changes nothing else on the server. If Kylth is already installed, it stops and points you to Upgrade instead.

Without prompts

Set the answers in the environment and the installer doesn’t ask:

sudo KYLTH_DOMAIN=app.example.com KYLTH_BASE_DOMAIN=projects.example.com bash install.sh

Add KYLTH_TAG=<version> to install a specific release rather than the latest.

What the installer creates

Path What it is
/etc/kylth/docker-compose.yml How Kylth’s container runs. Don’t change the folder paths in it; Security & permissions explains why.
/etc/kylth/.env Your settings. Readable by root only.
/opt/kylth Kylth’s database, keys and licence. Readable by root only.
/opt/supabase-projects Your projects
/opt/kylth-backups Project backups kept on the server
/etc/wireguard Used only by multi-host setups. Readable by root only.

On its first start, Kylth also creates its Caddy in /opt/supabase-projects/caddy and starts it as the container kylth-caddy.

3. Check that it worked

The installer ends with Kylth is running. To confirm at any time:

docker ps --filter name=kylth

Both kylth and kylth-caddy should be listed, with kylth marked (healthy). If the installer stopped with an error instead, see Troubleshooting.

After installation

  1. Create the owner account. Open https://<dashboard domain>/setup. The page is called Create the owner account: enter an email and a password, confirm the password, and submit. The first visit can take a few seconds while Caddy gets the dashboard’s certificate.
  2. Choose a licence. Kylth runs as the Free tier until you install one. See Licence.
  3. Optionally, set up email. Under Settings → Notifications → Configure SMTP, give Kylth an SMTP server, so it can email invitations and password resets.
  4. Create your first project. Your first project walks through it.

Install by hand

To set Kylth up without the installer:

  1. Create /opt/kylth, /opt/supabase-projects, /opt/kylth-backups and /etc/wireguard.
  2. Put docker-compose.yml from the release in /etc/kylth, with a filled-in .env beside it. The settings page lists what goes in it.
  3. Run docker compose up -d in /etc/kylth.