Install KinShip
One compose file, one settings file, one command. Plan on about ten minutes on a server you already have.
Download the release files
The compose file pulls published images, pinned to a version, so nothing is built on your machine.
# in an empty folder on your server
curl -LO https://github.com/officialJCReyes/kinship/releases/latest/download/compose.yml
curl -LO https://github.com/officialJCReyes/kinship/releases/latest/download/env.example
cp env.example .envSet your secrets
Open .env and set the database password and the file encryption key. Email, storage and map settings are optional and can wait. Prefer Docker secrets? Every secret also accepts a _FILE form.
Start it
Create the backups folder first, so the api (which does not run as root) can write to it. Then three containers come up: web, api and the database. Only web publishes a port, 8080.
mkdir -p data/backups && sudo chown 1000:1000 data/backups docker compose up -d
Put HTTPS in front
Point your reverse proxy at port 8080. Any proxy works, including a Cloudflare Tunnel, and the install guide has the notes.
Run the first-run setup
The first start prints a one-time setup token in the api log. Open your site, paste the token, and the wizard creates your SuperAdmin account and your tree in seven short steps, including your color scheme.
docker compose logs api
Turn on backups
Set BACKUP_PASSPHRASE and BACKUP_ENABLED=on in .env, restart, then run Test the latest backup once in Admin → Backups.
Which image tag should I use?
Web and api always share one version number. For anything you care about, pin the exact version.
Upgrading
KinShip never updates itself. Your SuperAdmin sees a notice in the app, and you decide when.
- Open What's changing in the update notice to read the release notes.
- If the release changes the database or has breaking changes, KinShip asks you to back up first.
- Change both image tags in
compose.yml. - Pull and restart. Each admin sees a What's new popup at their next sign-in.
# after changing the tags in compose.yml
docker compose pull
docker compose up -d