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 from the source 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.
  • The landing page, if you want it, and Caddy in front for HTTPS with certificates from Let’s Encrypt.

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 and Compose:

git clone https://github.com/KristofferK/routine
cd routine/docker
cp .env.example .env   # optional: your hosts and settings
docker compose up -d

The first start builds the images, which takes a few minutes. Then the app is athttp://localhost:8080, and the sync server is athttp://localhost:8787; docker compose ps shows both as healthy once they answer.

Configure it

Every setting is an environment variable in docker/.env.example. The main ones:

APP_URL
Where people open the app, for example https://app.example.org.
API_URL
Where the app finds the sync server. It goes into config.json.
ALLOWED_ORIGINS
The app origins the sync server answers, comma-separated; APP_URL when empty.
COMPOSE_PROFILES=https
Adds Caddy with HTTPS for your hosts. Set SERVICE_BIND=127.0.0.1 andTRUST_PROXY=true with it, so everything from outside goes through HTTPS.
CONTENT_KEY
Which signing key the app trusts for its companions, seasons and festivals:official (the default, with updates from us) or own (a key of your own, with the content from your checkout).

Limits per vault, rate limits and how long unused vaults are kept are there too. The full guide, with backups and upgrades, isdocker/README.md.

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