Sign inSign up

dockette/kumatron

Sponsored OSS

By dockette

ā€¢Updated about 3 hours ago

šŸ³ Uptime Kuma ā€” tuned config + SQLite streaming

Image
0

10K+

dockette/kumatron repository overview

ā Dockette / Kumatron

šŸ³ Uptime Kumaā  with extra juicy configuration and streaming SQLite.

šŸ•¹ f3l1x.ioā  | šŸ’» f3l1xā  | šŸ¦ @xf3l1xā 

Uptime Kumaā  with Litestreamā  added. Litestream streams the SQLite database to cloud storage, e.g. S3.

ā Features

  • Uptime Kuma 1.23.17 on the upstream -debian image
  • Litestream v0.3.14 for streaming SQLite, off by default
  • Litestream config is rendered from a template with envsubst (v1.4.3)

ā Usage

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

# Stream SQLite to 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

ā Configuration

Litestream is on when LITESTREAM is set. The entrypoint renders /srv/litestream/<LITESTREAM_TEMPLATE>.yml.tpl to /srv/litestream/litestream.yml. The LITESTREAM_RETENTION*, LITESTREAM_SNAPSHOT_INTERVAL, LITESTREAM_SYNC_INTERVAL and LITESTREAM_VALIDATION_INTERVAL values above are the defaults.

For all options, see the Litestream documentationā .

ā Versions

VersionRelease
dockette/kumatron:1.23.17-YYYY.MM.DDrelease YYYY.MM.DD
dockette/kumatron:1.23.17latest release
dockette/kumatron:YYYY.MM.DDrelease YYYY.MM.DD
dockette/kumatron:latestlatest build of master

All versions run Uptime Kuma 1.23.17. Releases are listed on GitHubā .

ā Development

make build       # build the image
make test        # run the image on port 3001
make test-s3     # run the image with Litestream, settings from .env
make enter       # open a shell in the running container
make version     # print VERSION
make release     # set today's date in VERSION

ā Maintenance

See how to contributeā  to this package. Consider to supportā  f3l1x. Thank you for using this package.

Tag summary

Content type

Image

Digest

sha256:38ceea6ccā€¦

Size

159.7 MB

Last updated

about 3 hours ago

docker pull dockette/kumatron

This week's pulls

Pulls:

85

Oct 26 to Nov 1

Learn moreā