Skip to content

Latest commit

 

History

History
70 lines (54 loc) · 1.81 KB

README.md

File metadata and controls

70 lines (54 loc) · 1.81 KB

Dockette / Kumatron

🐳 Uptime Kuma with extra juicy configuration and streaming SQLite.

🕹 f3l1x.io | 💻 f3l1x | 🐦 @xf3l1x

Usage

Basic

docker run \
	-it \
	--rm \
	-p 3001:3001 \
	-e DATA_DIR=./data \
	-v /your/path:/app/data \
	dockette/kumatron

SQLite + Litestream

Litestream is extra horse power for SQLite. Stream SQLite to cloud storage, e.q. S3.

docker run \
	-it \
	--rm \
	-p 3001:3001 \
	-e DATA_DIR=./data \
	-e LITESTREAM=1 \
	-e LITESTREAM_TEMPLATE=s3 \
	-e LITESTREAM_DB_FILE=/app/data/kuma.db \
	-e LITESTREAM_S3_ENDPOINT=yourbucket.minio.tld \
	-e LITESTREAM_S3_REGION=foobar \
	-e LITESTREAM_S3_PATH=foobar \
	-e LITESTREAM_S3_BUCKET=foobar \
	-e LITESTREAM_S3_ACCESS_KEY_ID=foobar \
	-e LITESTREAM_S3_SECRET_ACCESS_KEY=foobarbaz \
	-e LITESTREAM_RETENTION=24h \
	-e LITESTREAM_RETENTION_CHECK_INTERVAL=1h \
	-e LITESTREAM_SNAPSHOT_INTERVAL=10s \
	-e LITESTREAM_SYNC_INTERVAL=1s \
	-e LITESTREAM_VALIDATION_INTERVAL=12h \
	-v /your/path:/app/data \
	dockette/kumatron

Tip

For more detailed configuration options, please refer to the Litestream official documentation.

Development

See how to contribute to this package.

This package is currently maintaining by these authors.

Consider to support f3l1x. Also thank you for using this package.