wastrachan/nvchecker repository overview

⁠docker-nvchecker

Run nvchecker in a Docker container, with configuration files in a volume and a configurable UID/GID for said files.

⁠Install

⁠Docker Hub

Pull the latest image from Docker Hub:

docker pull wastrachan/nvchecker

⁠Github Container Registry

Or, pull from the GitHub Container Registry:

docker pull ghcr.io/wastrachan/nvchecker

⁠Build From Source

Clone this repository, and run make build to build an image:

git clone https://github.com/wastrachan/docker-nvchecker.git
cd docker-nvchecker
make build

⁠Run

Run this image with the make run shortcut, or manually with docker run.

docker run -v "$(pwd)/config:/config" \
           --name nvchecker \
           --rm \
           -e PUID=$(id -u) \
           -e PGID=$(id -g) \
           wastrachan/nvchecker:latest

⁠Configuration

Configuration files are stored in the /config volume. You may wish to mount this volume as a local directory, as shown in the examples above.

⁠Configuration Files

This README won't touch on the configuration specifics of nvchecker (check out the documentation here⁠). In general, understand that running the container for the first time (make run) will create three files in your mounted config volume:

• /config/nvchecker.toml - The main nvchecker configuration file. Defines what sources should be checked when the container runs.
• /config/new_ver.json - The nvchecker "new version" file. When the container runs, current published software versions are recorded in a JSON object in this file.
• /config/old_ver.json - The nvchecker "old version" file. When the container runs, current published software versions are compared with versions in this file. Changes are reported in stdout. When you have noted and acted on an updated release, you should record the version in the old_ver.json file.

⁠User / Group Identifiers

If you'd like to override the UID and GID of the application, you can do so with the environment variables PUID and PGID. This is helpful if other containers must access your configuration volume.

⁠Timezone

The timezone the container uses defaults to UTC, and can be overridden with the TZ environment variable.

⁠Volumes

⁠License

The content of this project itself is licensed under the MIT License⁠.

View license information for the software contained in this image.⁠