jljl1337/xpense

By jljl1337

•Updated 10 months ago

A self-hosting friendly expense tracker

Image

9.2K

Overview Tags

jljl1337/xpense repository overview

⁠xpense

GitHub License

⁠Features

Self-contained: Everything in one image, no separate database instance required
Disaster-ready: Built-in automated database backups
Efficient: Lightweight and fast, built with Go and SQLite
Configurable: Easily customizable via environment variables

⁠Demo

Live demo available at: https://xpense.jljl1337.com⁠

Important
This is a public demo instance. Do not store any sensitive and/or critical data here. Data persistence and availability are not guaranteed.

⁠Install

Sample compose.yml:

services:

  xpense:
    image: jljl1337/xpense:latest # Use specific tag for production
    container_name: xpense
    restart: unless-stopped
    ports:
      - "8080:8080"
    volumes:
      - ./live:/xpense/data/live
      - ./backup:/xpense/data/backup
    environment:
      - SQLITE_BACKUP_CRON_SCHEDULE=0 * * * * # Backup every hour

⁠Configuration

All paths are relative to the binary location (/xpense in the Docker image).

All environment variables have the _FILE alternative, which allows reading the value from a file.

Environment Variable	Type	Default Value	Description
`SQLITE_DB_PATH`	string	`data/live/db/live.db`	Path to the SQLite database file
`SQLITE_BUSY_TIMEOUT`	string	`30000`	SQLite database busy timeout in milliseconds
`SQLITE_BACKUP_DB_PATH`	string	`data/backup/db/backup.db`	Path to the backup SQLite database file
`SQLITE_BACKUP_CRON_SCHEDULE`	string	`0 0 * * *`	Cron schedule for SQLite database backups
`SESSION_CLEANUP_CRON_SCHEDULE`	string	`0 0 * * 0`	Cron schedule for session cleanup
`LOG_LEVEL`	int	`0`	Logging level for the application
`LOG_HEALTH_CHECK`	bool	`false`	Whether to log health check requests
`PORT`	string	`8080`	Port number for the HTTP server
`CORS_ORIGINS`	string	`*`	Allowed CORS origins (comma-separated)
`PASSWORD_BCRYPT_COST`	int	`12`	Bcrypt cost factor for password hashing
`SESSION_COOKIE_NAME`	string	`xpense_session_token`	Name of the session cookie
`SESSION_COOKIE_HTTP_ONLY`	bool	`true`	Whether the session cookie is HTTP-only
`SESSION_COOKIE_SECURE`	bool	`false`	Whether the session cookie requires HTTPS
`SESSION_TOKEN_LENGTH`	int	`32`	Length of generated session tokens
`SESSION_TOKEN_CHARSET`	string	alphanumeric characters (case-sensitive)	Character set for session token generation
`SESSION_LIFETIME_MIN`	int	`10080` (7 days)	Session lifetime in minutes
`SESSION_REFRESH_THRESHOLD_MIN`	int	`1440` (1 day)	Session will only be refreshed if remaining lifetime is below this threshold in minutes
`PRE_SESSION_LIFETIME_MIN`	int	`15`	Pre-session lifetime in minutes
`CSRF_TOKEN_LENGTH`	int	`32`	Length of generated CSRF tokens
`CSRF_TOKEN_CHARSET`	string	alphanumeric characters (case-sensitive)	Character set for CSRF token generation
`PAGE_SIZE_MAX`	int64	`100`	Maximum page size for paginated results
`PAGE_SIZE_DEFAULT`	int64	`10`	Default page size for paginated results
`SESSION_COOKIE_SAME_SITE_MODE`	string	`lax`	SameSite mode for session cookie (`lax`, `strict`, or `none`), other values are treated as `none`

⁠Development

Install Go⁠, pnpm⁠, and air⁠
Run pnpm install in the web directory to install frontend dependencies
Run go mod download in the project root to install backend dependencies
Start the development server with air

Tag summary

Recent tags

Content type

Image

Digest

sha256:0d97f3ca9…

Size

18 MB

Last updated

10 months ago

docker pull jljl1337/xpense