Version 0.2.0

Install KinShip

One compose file, one settings file, one command. Plan on about ten minutes on a server you already have.

Docker with Compose
On Linux, Synology, Unraid or a Raspberry Pi.
amd64 or arm64
Images are built for both.
A reverse proxy
For HTTPS in front of port 8080.
A safe place for two secrets
Your file key and backup passphrase.
1

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 .env
2

Set 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.

3

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
4

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.

CaddyNginx Proxy ManagerTraefikCloudflare Tunnel
5

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
6

Turn on backups

Set BACKUP_PASSPHRASE and BACKUP_ENABLED=on in .env, restart, then run Test the latest backup once in Admin → Backups.

Keep two things away from the server: your file encryption key and your backup passphrase. A backup is only useful if you can still open it after the server is gone.

Which image tag should I use?

Web and api always share one version number. For anything you care about, pin the exact version.

0.2.0Exact version. Never moves. Recommended for real family data.Recommended
0.2Follows the newest patch of that minor release.
latestThe newest stable release. Fine for trying it out.
edgeEvery merge to main. For contributors and testers only.

Upgrading

KinShip never updates itself. Your SuperAdmin sees a notice in the app, and you decide when.

  1. Open What's changing in the update notice to read the release notes.
  2. If the release changes the database or has breaking changes, KinShip asks you to back up first.
  3. Change both image tags in compose.yml.
  4. 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
Rolling back means putting the old tag back and restoring the backup you took first. Migrations only move forward.
Continue in the docs