check_forgejo_upgrade/README.md

45 lines
2.1 KiB
Markdown
Raw Permalink Normal View History

2023-01-19 12:51:32 +01:00
# Monitoring plugin to check Forgejo instance upgrade status
This Icinga/Nagios check plugin permit to check Forgejo instance upgrade status by comparing the local forgejo binary version against the latest stable release.
## Installation
```
apt install git python3-requests
2023-01-19 12:51:32 +01:00
git clone https://gitea.zionetrix.net/bn8/check_forgejo_upgrade.git /usr/local/src/check_forgejo_upgrade
mkdir -p /usr/local/lib/nagios/plugins
ln -s /usr/local/src/check_forgejo_upgrade/check_forgejo_upgrade /usr/local/lib/nagios/plugins/
2023-01-19 15:26:26 +01:00
echo "nagios ALL=NOPASSWD: /usr/local/lib/nagios/plugins/check_forgejo_upgrade" > /etc/sudoers.d/nagios-gitea
chmod 0400 /etc/sudoers.d/nagios-gitea
echo "command[check_forgejo_upgrade]=sudo /usr/local/lib/nagios/plugins/check_forgejo_upgrade" > /etc/nagios/nrpe.d/forgejo.cfg
2023-01-19 12:51:32 +01:00
service nagios-nrpe-server reload
```
## Usage
```
usage: check_forgejo_upgrade [-h] [-d] [-p PATH] [-U URL] [--pre-release] [--draft] [-t TIMEOUT]
2023-01-19 12:51:32 +01:00
options:
2023-01-19 12:51:32 +01:00
-h, --help show this help message and exit
-d, --debug
-p PATH, --path PATH Forgejo bin path
-U URL, --url URL Forgejo releases URL
--pre-release Allow pre-release (default: only stable release are considered)
--draft Allow draft release (default: only stable release are considered)
-t TIMEOUT, --timeout TIMEOUT
Specify timeout for HTTP requests (default: 20)
2023-01-19 12:51:32 +01:00
```
## Copyright
Copyright (c) 2023-2024 Benjamin Renard <brenard@zionetrix.net>
2023-01-19 12:51:32 +01:00
## License
This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License version 3 as published by the Free Software Foundation.
This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
2023-01-19 12:51:32 +01:00
You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.