diff --git a/CHANGELOG.md b/CHANGELOG.md index 6397f54..f918b46 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,4 +1,6 @@ **New features**: - Add gotify compatibility please Read the README.md +- Add arm64 support +- Add armv7 support **Full Changelog**: https://github.com/BreizhHardware/ntfy_alerts/compare/v1.4.3...v1.5 \ No newline at end of file diff --git a/README.md b/README.md index 1c97ccc..f820b79 100644 --- a/README.md +++ b/README.md @@ -1,24 +1,18 @@ -# ntfy_alerts -Personal ntfy alerts system +

Welcome to ntfy_alerts 👋

+

+ Version + + License: GPL--3 + + + Twitter: BreizhHardware + +

-Feel free to contribute and to fork ! +> This project allow you to have notification about new github or docker hub release on ntfy, gotify and (soon) discord. -# Python ntfy.py -## Description: -This script is used to watch the github repos and send a notification to the ntfy server when a new release is published. +## Usage -It can aloso watch Docker Hub repos and do the same as github. -## Utilisation: -auth and ntfy_url are required to be set as environment variables. - -auth: can be generataed by the folowing command: echo -n 'username:password' | base64 - -ntfy_url: the url of the ntfy server including the topic - -````python -python ntfy.py -```` -## Docker: If you want to use the docker image you can use the following docker-compose file for x86_64: ````yaml services: @@ -85,9 +79,21 @@ services: - 80:80 restart: unless-stopped ```` -GHNTFY_TOKEN, need to have repo, read:org and read:user +GHNTFY_TOKEN is a github token, it need to have repo, read:org and read:user + +## Author + +👤 **BreizhHardware** + +* Website: https://mrqt.fr?ref=github +* Twitter: [@BreizhHardware](https://twitter.com/BreizhHardware) +* Github: [@BreizhHardware](https://github.com/BreizhHardware) +* LinkedIn: [@félix-marquet-5071bb167](https://linkedin.com/in/félix-marquet-5071bb167) + +## Contribution + +If you want to contribut, feel free to open a pull request (CONTRIBUTION.md comming soon)! -Docker Hub repo: https://hub.docker.com/r/breizhhardware/github-ntfy ## TODO: - [x] Dockerize the ntfy.py - [x] Add the watched repos list as a parameter @@ -98,34 +104,7 @@ Docker Hub repo: https://hub.docker.com/r/breizhhardware/github-ntfy - [x] Compatibility with Gotify - [ ] Compatibility with Discord Webhook - [x] Compatibility and distribution for arm64 and armv7 -# Bash setup-notify.sh -## Description: -This script is used to setup the ntfy notification system on ssh login for a new server. -## Utilisation: -````bash -bash setup-notify.sh -```` -ntfy_url: the url of the ntfy server -username: the username of the user - -password: the password of the user - -topic: the topic of the notification - -This script will create a send-notify.sh in the root of your disk and add the login-notify.sh to the /etc/profile.d/ folder. -# Bash send-notify.sh -## Description: -This script is used to send a notification to the ntfy server. -## Utilisation: -````bash -bash send-notify.sh -```` -ntfy_url: the url of the ntfy server - -basic_auth: the basic auth of the user - -topic: the topic of the notification - -message: the message of the notification +## Show your support +Give a ⭐️ if this project helped you! \ No newline at end of file