Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/guihkx/nvchecker
Personal nvchecker config files
https://github.com/guihkx/nvchecker
Last synced: 8 days ago
JSON representation
Personal nvchecker config files
- Host: GitHub
- URL: https://github.com/guihkx/nvchecker
- Owner: guihkx
- License: mit
- Created: 2021-09-25T09:20:03.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2025-01-16T15:24:02.000Z (8 days ago)
- Last Synced: 2025-01-16T16:50:34.459Z (8 days ago)
- Language: Dockerfile
- Size: 258 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# HOWTO
## Dependencies
* [nvchecker](https://github.com/lilydjwg/nvchecker) (>= 2.14)
* Entry-specific: `coreutils`, `curl`, `jq` (and [Python bindings for jq](https://pypi.org/project/jq/)), `xmlstarlet`
## `sources.toml`
This is the "main" nvchecker-related file you'll need to modify. It has a lot of apps that are interesting to me, so you'll most likely remove most of them. But feel free to use them as source of "inspiration" to write your own configs! :)
## `new.json` & `old.json`
Check out the [nvchecker documentation](https://nvchecker.readthedocs.io/en/latest/usage.html#version-record-files).
## Creating your own `keys.toml`
1. Generate a [GitHub token](https://github.com/settings/tokens) (no additional API scopes needed) if you don't have one.
2. Create a new `keys.toml` file inside this repository:
```toml
[keys]
github = "YOUR GITHUB TOKEN HERE"
```
## Using the Docker image
```sh
docker run --rm -v $(pwd):/data -t ghcr.io/guihkx/nvchecker --file sources.toml
```
## Enabling the systemd timer
The systemd timer/service is useful to automatically check for new app updates. By default, I have set the timer to run every hour, but that's [configurable](https://www.freedesktop.org/software/systemd/man/systemd.time.html).
1. Edit the `nvchecker.service` file inside the `systemd/` directory on this repository.
2. Search for the following line:
```ini
WorkingDirectory=%h/Projects/github/nvchecker
```
3. `%h` is a [systemd specifier](https://www.freedesktop.org/software/systemd/man/systemd.unit.html#Specifiers) that points to your home folder, i.e. `/home/john`.
So, in short, you'll have to change that path to wherever folder on your computer you have cloned this git repository to.
4. Copy both `nvchecker.{service,timer}` files to systemd's [unit search path](https://www.freedesktop.org/software/systemd/man/systemd.unit.html#User%20Unit%20Search%20Path):
```bash
mkdir -p ~/.config/systemd/user
cp systemd/nvchecker.{service,timer} ~/.config/systemd/user
```
5. Reload systemd's user service daemon:
```bash
systemctl --user daemon-reload
```
6. Enable and start the timer:
```bash
systemctl --user enable nvchecker.timer --now
```
7. If there is an app update, you should get a nice desktop notification, like this:
