{"id":15141746,"url":"https://github.com/lapicidae/nvchecker-email","last_synced_at":"2025-08-21T14:32:38.076Z","repository":{"id":257635588,"uuid":"858448489","full_name":"lapicidae/nvchecker-email","owner":"lapicidae","description":"new version checker (nvchecker) checks whether a new version of a software has been released and then notifies you by e-mail","archived":false,"fork":false,"pushed_at":"2024-10-31T23:53:27.000Z","size":52,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2024-11-08T10:48:12.381Z","etag":null,"topics":["docker-image"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/lapicidae.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-16T23:04:27.000Z","updated_at":"2024-10-31T23:53:30.000Z","dependencies_parsed_at":"2024-11-01T00:23:03.597Z","dependency_job_id":"232b0636-143b-40fd-a876-c74873f3fced","html_url":"https://github.com/lapicidae/nvchecker-email","commit_stats":null,"previous_names":["lapicidae/nvchecker-email"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lapicidae%2Fnvchecker-email","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lapicidae%2Fnvchecker-email/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lapicidae%2Fnvchecker-email/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/lapicidae%2Fnvchecker-email/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/lapicidae","download_url":"https://codeload.github.com/lapicidae/nvchecker-email/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":230520359,"owners_count":18238946,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["docker-image"],"created_at":"2024-09-26T09:01:40.768Z","updated_at":"2025-08-21T14:32:38.069Z","avatar_url":"https://github.com/lapicidae.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![nvchecker-email](nvchecker-email-logo.svg)](https://github.com/lapicidae/nvchecker-email)\n\nnew version checker (nvchecker) checks whether a new version of a software has been released and then notifies you by e-mail.\n\n\n# [lapicidae/nvchecker-email](https://github.com/lapicidae/nvchecker-email)\n\n[![GitHub Repo stars](https://img.shields.io/github/stars/lapicidae/nvchecker-email?color=3c0e7b\u0026logo=github\u0026logoColor=fff\u0026style=for-the-badge)](https://github.com/lapicidae/nvchecker-email)\n[![Docker Pulls](https://img.shields.io/docker/pulls/lapicidae/nvchecker-email?color=3c0e7b\u0026label=pulls\u0026logo=docker\u0026logoColor=fff\u0026style=for-the-badge)](https://hub.docker.com/r/lapicidae/nvchecker-email)\n[![Docker Stars](https://img.shields.io/docker/stars/lapicidae/nvchecker-email?color=3c0e7b\u0026label=stars\u0026logo=docker\u0026logoColor=fff\u0026style=for-the-badge)](https://hub.docker.com/r/lapicidae/nvchecker-email)\n[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/lapicidae/nvchecker-email/docker.yml?logo=github\u0026logoColor=ffffff\u0026style=for-the-badge)](https://github.com/lapicidae/nvchecker-email/actions/workflows/docker.yml)\n\n\nThe nvchecker e-mail Docker image is based on [Alpine Linux](https://alpinelinux.org/), [cron](https://en.wikipedia.org/wiki/Cron) and [nvchecker](https://github.com/lilydjwg/nvchecker).\n\n\n## Features\n\n* regular and timely application updates\n* [BusyBox](https://www.busybox.net/) provides a subset of over two hundred utilities\n* schedule via cronjob\n* simple configuration\n\n### *Note*\nThe image is automatically rebuilt when the [alpine (latest)](https://hub.docker.com/_/alpine) Official Docker Image receives an update.\n\n\n## Getting Started\n\n### Usage\nHere are some example snippets to help you get started creating a container.\n\n#### *docker-compose (recommended)*\n\nCompatible with docker-compose v2 schemas.\n```yaml\nversion: \"2.1\"\nservices:\n  nvchecker-email:\n    image: ghcr.io/lapicidae/nvchecker-email:latest\n    container_name: nvchecker-email\n    environment:\n      - TZ=Europe/London\n    volumes:\n      - /path/to/config:/nvchecker\n    restart: unless-stopped\n```\n\n#### *docker cli*\n\n```bash\ndocker run -d \\\n  --name=nvchecker-email \\\n  -e TZ=Europe/London \\\n  -v /path/to/config:/nvchecker \\\n  --restart unless-stopped \\\n  ghcr.io/lapicidae/nvchecker-email:latest\n```\n\n### Parameters\n\nContainer images are configured using parameters passed at runtime.\n\n| Parameter | Default | Function |\n|-----|-----|-----|\n| `-e PUID=1000` | 1000 | for UserID - see below for explanation |\n| `-e PGID=1000` | 1000 | for GroupID - see below for explanation |\n| `-e TZ=Europe/London` | UTC | Specify a [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List) to use (e.g. Europe/London) |\n| `-e NVCHECKER_UPDATE=false` | true | Mark all versions as updated after successfully sending the e-mail (nvtake --all) |\n| `-e CRON_SCHEDULE='0 6 * * *'` | '0 1 * * *' | crontab schedule ([examples](https://crontab.guru/)) |\n| `-e APK_ADD=’7zip,curl,httpie’` | --- | **Comma-separated** list of additional [packages](https://pkgs.alpinelinux.org/) to be installed  |\n| `-e CRON_HUMAN=false` | true | De/activate the human-readable output of the crontab schedule at the beginning of the log |\n| `-e DEBUG=true` | false | Verbose debug logging for troubleshooting |\n| `-v /nvchecker` | | Configuration files directory |\n\n### User / Group Identifiers\nWhen using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.\n\nEnsure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.\n\nIn this instance `PUID=1234` and `PGID=4321`, to find yours use `id user` as below:\n\n```bash\n  $ id username\n    uid=1234(dockeruser) gid=4321(dockergroup) groups=4321(dockergroup)\n```\n\n## Configuration\n\n### nvchecker\nThe software version source file ***/nvchecker/nvchecker.toml*** is in toml format. The key name is the name of the software. Following fields are used to tell nvchecker how to determine the current version of that software.  \nSee [sample_source.toml](https://github.com/lilydjwg/nvchecker/blob/master/sample_config.toml) for an example.  \nFor more information, please read the [documentation](https://nvchecker.readthedocs.io/en/latest/usage.html#configuration-files).\n\n### e-mail\nThe e-mail functionality is realised by the Python module [smtplib](https://docs.python.org/3/library/smtplib.html). The e-mail settings are configured centrally in the file ***/nvchecker/email.toml***.\n\n#### *Options*\n|Value     |Default|Description                              |\n|----------|-------|-----------------------------------------|\n|**[SMTP]**|       |                                         |\n|host      |       |Domain name of SMTP service              |\n|port      |25     |If port is zero, the default port is used|\n|ssl       |false  |Secured by SSL or TLS (default port 465) |\n|starttls  |false  |Opportunistic TLS (default port 25)      |\n|timeout   |15     |Timeout in seconds                       |\n|**[AUTH]**|       |                                         |\n|user      |       |User name                                |\n|password  |       |Password                                 |\n|**[ADDR]**|       |                                         |\n|from      |       |E-mail address of the sender             |\n|to        |       |E-mail address of the recipient          |\n\n\n#### *Gmail Example (STARTTLS)*\n```toml\n[SMTP]\nhost = 'smtp.gmail.com'\nport = 587\nstarttls = true\n\n[AUTH]\nuser = 'firstname.lastname@gmail.com'\npassword = 'pAsSwOrD'                           # use https://myaccount.google.com/lesssecureapps\n\n[ADDR]\nfrom = 'firstname.lastname@gmail.com'\nto = 'firstname.lastname+nvchecker@gmail.com'   # you can append a plus (\"+\") sign and any combination of words or numbers after your email address.\n```\n\n#### *Configuration test*\nSend an e-mail to test your configuration.\n```bash\n## already running container\n# docker exec -it [container-name] nvchecker-email --testmail\ndocker exec -it nvchecker-email nvchecker-email --testmail\n\n# start new container\ndocker run -it --rm -v \"/path/to/config:/nvchecker\" ghcr.io/lapicidae/nvchecker-email:latest /bin/bash -c 'nvchecker-email --testmail'\n```\n\n## Note\nTake a look at [crontab guru](https://crontab.guru/) for help with for cron schedule expression.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flapicidae%2Fnvchecker-email","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flapicidae%2Fnvchecker-email","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flapicidae%2Fnvchecker-email/lists"}