jalan

Self-hosting

Run Jalan yourself

Jalan is open source, and everything that runs on our servers can run on yours: the app and the sync server, with SQLite for storage.

What it runs

  • The sync server on Node, storing encrypted records in SQLite. It's the same code that runs on our hosting, and it never sees what you track: records arrive already encrypted on your devices.
  • The app, built as static files and served beside it. The app reads the sync server's address from a config.json next to it, set by you when you deploy.
  • Reminders through Web Push, with VAPID keys you generate once. They carry no content; your phone writes the message.

You don't need this to use Jalan without sync: the app works fully offline on one device.

Start it

On any machine with Docker:

git clone https://github.com/KristofferK/routine
cd routine
cp .env.example .env   # then fill in your hosts and keys
docker compose up -d

Configure it

Hosts, VAPID keys and limits come from environment variables. The server takes a list of allowed origins, so you can serve the app and the sync server from one domain or from two. The exact variable names are documented with the release.

Each app syncs with the one server it was deployed with; people using your app can't switch it to another. That keeps a QR code or invite link from pointing a device somewhere unexpected.

← Back to Jalan