About

Docker image for Spliit, an open source alternative to Splitwise.

Tip

Want to be notified of new releases? Check out 🔔 Diun (Docker Image Update Notifier) project!

---

• Build locally
• Image
• Environment variables
• Ports
• Usage
  • Docker Compose
• Upgrade
• Contributing
• License

Build locally

git clone https://github.com/crazy-max/docker-spliit.git
cd docker-spliit

# Build image and output to docker (default)
docker buildx bake

# Build multi-platform image
docker buildx bake image-all

Image

Registry	Image
Docker Hub	crazymax/spliit
GitHub Container Registry	ghcr.io/crazy-max/spliit

The following platforms for this image are available:

$ docker buildx imagetools inspect crazymax/spliit --format "{{json .Manifest}}" | \
  jq -r '.manifests[] | select(.platform.os != null and .platform.os != "unknown") | .platform | "\(.os)/\(.architecture)\(if .variant then "/" + .variant else "" end)"'

linux/amd64
linux/arm64

Environment variables

• TZ: The timezone assigned to the container (default UTC)
• DB_NAME: Database name (default spliit)
• DB_USER: Username for database (default spliit)
• DB_PASSWORD: Password for database user
• DB_TIMEOUT: Time in seconds after which we stop trying to reach the database server (default 60)

Ports

• 3000/tcp: HTTP port

Usage

Docker Compose

Docker compose is the recommended way to run this image. You can use the following docker compose template, then run the container:

docker compose up -d
docker compose logs -f

Upgrade

To upgrade, pull the newer image and launch the container:

docker compose pull
docker compose up -d

Contributing

Want to contribute? Awesome! The most basic way to show your support is to star the project, or to raise issues. You can also support this project by becoming a sponsor on GitHub or by making a PayPal donation to ensure this journey continues indefinitely!

Thanks again for your support, it is much appreciated! 🙏

License

MIT. See LICENSE for more details.