https://github.com/dockette/kumatron
🐳 Uptime Kuma with extra juicy configuration and streaming SQLite.
https://github.com/dockette/kumatron
Last synced: 11 months ago
JSON representation
🐳 Uptime Kuma with extra juicy configuration and streaming SQLite.
- Host: GitHub
- URL: https://github.com/dockette/kumatron
- Owner: dockette
- License: mit
- Created: 2023-03-09T08:08:53.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2024-03-31T14:48:46.000Z (about 2 years ago)
- Last Synced: 2024-03-31T15:30:46.911Z (about 2 years ago)
- Language: Shell
- Size: 17.6 KB
- Stars: 5
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
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](https://litestream.io/) 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](https://litestream.io/reference/config/).
## Development
See [how to contribute](https://contributte.org/contributing.html) to this package.
This package is currently maintaining by these authors.
-----
Consider to [support](https://github.com/sponsors/f3l1x) **f3l1x**. Also thank you for using this package.