01
How do I set up Splex?
Splex runs as a container and can be started in a few minutes if you already have a server, NAS, or Raspberry Pi that can run containers.
Start with the .env.example template.
- Create a directory for Splex on your server.
- Save the template as .env and fill in at least SECRET_KEY, FRONTEND_PUBLIC_URL, BACKEND_PUBLIC_URL, and the email settings.
- Create a docker-compose.yml file. SQLite is the shortest setup; PostgreSQL is also supported if you want a separate database service.
- Start it with docker compose pull and docker compose up -d.
A small SQLite setup looks like this:
services:
app:
image: ghcr.io/steve192/splex:latest
env_file:
- .env
ports:
- "8000:8000"
volumes:
- ./data:/app/data
restart: unless-stoppedThe ./data directory stores the SQLite database, uploaded media files, and generated legal document files. Back it up regularly. If you prefer PostgreSQL, keep the ./data mount anyway, because uploaded files still live there.
The full setup guide, including the PostgreSQL compose example, is in the GitHub README.
Read next
Splitwise alternative
Open-source Splitwise alternative
Splex as an open-source Splitwise alternative: what works well, what is missing, and what to check before you switch.
Use case
Group travel expense tracking
How Splex helps groups track travel expenses with multiple currencies, offline entry, receipts, balances, and settlements.
Use case
Shared household expense tracking
How Splex helps shared households track groceries, rent, utilities, exact splits, balances, receipts, and settlements.