Self-host Kutt on a VPS

A modern URL shortener with custom domains, link analytics and an API, backed by Postgres and Redis.

levelrail-cli templates install kutt --name my-kutt

Specification

Status
Listed
Category
Applications
Services
db, kutt, redis
Ports
3000
Volumes
3
Memory
about 384 MiB
arm64
image published
amd64
image published
Settings to fill in
none

About Kutt

A modern URL shortener with custom domains, link analytics and an API, backed by Postgres and Redis.

What it deploys

Kutt runs as 3 services in a single Compose app, listening on port 3000, with 3 named volume mounts.

ServiceImageTagPortsVolumes
db postgres 16-alpine none pgdata -> /var/lib/postgresql/data
kutt kutt/kutt v3.2.6 3000 uploads -> /kutt/custom
redis redis 7-alpine none redis -> /data

Before you install

  • CPU architecture. arm64 listed. Every image lists linux/arm64 in its registry manifest. That is a manifest fact, not proof the app runs on Arm.
  • Listed. It is in the catalog. Back up the data volume before changing an image tag.

Settings and environment

You do not have to fill in anything. 3 secrets are generated at deploy and stored encrypted. Values are never shown here.

ServiceVariableValue
dbPOSTGRES_DBPreset by the template
dbPOSTGRES_PASSWORDGenerated at deploy
dbPOSTGRES_USERPreset by the template
kuttDB_CLIENTPreset by the template
kuttDB_HOSTPreset by the template
kuttDB_NAMEPreset by the template
kuttDB_PASSWORDGenerated at deploy
kuttDB_PORTPreset by the template
kuttDB_USERPreset by the template
kuttDEFAULT_DOMAINPreset by the template
kuttDISALLOW_ANONYMOUS_LINKSPreset by the template
kuttDISALLOW_REGISTRATIONPreset by the template
kuttJWT_SECRETGenerated at deploy
kuttREDIS_ENABLEDPreset by the template
kuttREDIS_HOSTPreset by the template
kuttREDIS_PORTPreset by the template
kuttTRUST_PROXYPreset by the template

Install Kutt on a VPS

  1. Install Levelrail on a fresh VPS

    Run this as root on a Linux server (amd64 or arm64) with ports 80 and 443 reachable. The installer prints a setup link.

    curl -fsSL https://levelrail.com/install.sh | sudo sh
  2. Sign in

    Open the setup link, choose a password, then log the CLI in. The CLI install command is curl -fsSL https://levelrail.com/install-cli.sh | sh if the machine does not have it. See Getting started.

    levelrail-cli login --device
  3. Read the template

    Shows the entry, including its full compose.yaml.

    levelrail-cli templates get kutt
  4. Install it

    This template has an install form, so the CLI fills each setting from --env, a generated secret or its default.

    levelrail-cli templates install kutt --name my-kutt

    To put a service behind a domain at install, add --domain SERVICE=HOST:

    levelrail-cli templates install kutt --name my-kutt --domain db=kutt.example.com

Without a domain the app gets an sslip.io address. You can also deploy it from the dashboard: Apps, New app, Browse templates, then Kutt.

More in Applications

All Applications templates