https://github.com/crazy-max/docker-rrdcached
RRDcached Docker image
https://github.com/crazy-max/docker-rrdcached
alpine-linux docker rrd rrdcached rrdtool
Last synced: about 1 month ago
JSON representation
RRDcached Docker image
- Host: GitHub
- URL: https://github.com/crazy-max/docker-rrdcached
- Owner: crazy-max
- License: mit
- Created: 2018-07-06T16:39:12.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2024-06-18T06:34:33.000Z (11 months ago)
- Last Synced: 2024-10-30T00:27:22.580Z (7 months ago)
- Topics: alpine-linux, docker, rrd, rrdcached, rrdtool
- Language: Dockerfile
- Homepage:
- Size: 204 KB
- Stars: 24
- Watchers: 4
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Codeowners: .github/CODEOWNERS
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
## About
[RRDcached](https://oss.oetiker.ch/rrdtool/doc/rrdcached.en.html) Docker image.
> [!TIP]
> Want to be notified of new releases? Check out 🔔 [Diun (Docker Image Update Notifier)](https://github.com/crazy-max/diun)
> project!
___
* [Features](#features)
* [Build locally](#build-locally)
* [Image](#image)
* [Environment variables](#environment-variables)
* [Volumes](#volumes)
* [Ports](#ports)
* [Usage](#usage)
* [Docker Compose](#docker-compose)
* [Command line](#command-line)
* [Upgrade](#upgrade)
* [Contributing](#contributing)
* [License](#license)
## Features
* Run as non-root user
* Multi-platform image
## Build locally
```shell
git clone https://github.com/crazy-max/docker-rrdcached.git
cd docker-rrdcached
# Build image and output to docker (default)
docker buildx bake
# Build multi-platform image
docker buildx bake image-all
```
## Image
| Registry | Image |
|--------------------------------------------------------------------------------------------------|---------------------------------|
| [Docker Hub](https://hub.docker.com/r/crazymax/rrdcached/) | `crazymax/rrdcached` |
| [GitHub Container Registry](https://github.com/users/crazy-max/packages/container/package/rrdcached) | `ghcr.io/crazy-max/rrdcached` |
Following platforms for this image are available:
```
$ docker buildx imagetools inspect crazymax/rrdcached --format "{{json .Manifest}}" | \
jq -r '.manifests[] | select(.platform.os != null and .platform.os != "unknown") | .platform | "\(.os)/\(.architecture)\(if .variant then "/" + .variant else "" end)"'
linux/386
linux/amd64
linux/arm/v6
linux/arm/v7
linux/arm64
linux/ppc64le
linux/riscv64
linux/s390x
```
## Environment variables
* `TZ` : Timezone assigned to the container (default `UTC`)
* `PUID` : Daemon user id (default `1000`)
* `PGID` : Daemon group id (default `1000`)
* `LOG_LEVEL` : Log level, called with `-V` (default `LOG_INFO`)
* `WRITE_TIMEOUT` : Data is written to disk every *X* seconds, called with `-w` (default `300`)
* `WRITE_JITTER` : Delay writing of each RRD for a random number of seconds in the range, called with `-z`
* `WRITE_THREADS` : Number of threads used for writing RRD files, called with `-t` (default `4`)
* `FLUSH_DEAD_DATA_INTERVAL` : Every *X* seconds the entire cache is searched for old values which are written to disk, called with `-f` (default `3600`)
> [!NOTE]
> More info : https://github.com/oetiker/rrdtool-1.x/blob/master/doc/rrdcached.pod
## Volumes
* `/data/db` : Contains rrd database
* `/data/journal` : Container rrd journal files
> [!WARNING]
> Note that the volumes should be owned by the user/group with the specified
> `PUID` and `PGID`. If you don't give the volume correct permissions, the
> container may not start.
## Ports
* `42217` : RRDcached port
## Usage
### Docker Compose
Docker compose is the recommended way to run this image. You can use the following
[compose template](examples/compose/compose.yml), then run the container:
```bash
docker compose up -d
docker compose logs -f
```
### Command line
You can also use the following minimal command:
```bash
$ docker run -d -p 42217:42217 --name rrdcached \
-e TZ="Europe/Paris" \
-v $(pwd)/data/db:/data/db \
-v $(pwd)/data/journal:/data/journal \
crazymax/rrdcached
```
## Upgrade
Recreate the container whenever I push an update:
```bash
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**](https://github.com/sponsors/crazy-max)
or by making a [PayPal donation](https://www.paypal.me/crazyws) to ensure this
journey continues indefinitely!
Thanks again for your support, it is much appreciated! :pray:
## License
MIT. See `LICENSE` for more details.