diff --git a/plugins/sickbeard/sickbeard b/plugins/sickbeard/sickbeard index d3a764f9..5c3d968d 100755 --- a/plugins/sickbeard/sickbeard +++ b/plugins/sickbeard/sickbeard @@ -1,37 +1,66 @@ #!/usr/bin/perl -# -# Munin plugins for Sick-Beard -# -# Copyright (C) 2012 - Blauwbek -# Copyright (C) 2012 - Thiago -# Copyright (C) 2019 - Olivier Mehani , for the -# multigraph support and better error handling -# -# Sick-Beard : http://sickbeard.com/ -# -# SPDX-License-Identifier: GPL-3.0-or-later -# -# This program is free software: you can redistribute it and/or modify -# it under the terms of the GNU General Public License as published by -# the Free Software Foundation, either version 3 of the License, or -# (at your option) any later version. -# -# 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. -# -# You should have received a copy of the GNU General Public License -# along with this program. If not, see . -# -# Requires: JSON::Any -# LWP::UserAgent -# -# Configuration example -# [sickbeard*] -# env.host http://host:port/ -# env.api apikey -# +# -*- perl -*- + +=head1 NAME + +sickbeard - Munin multigraph plugin for Sick-Beard and forks (e.g., +SickChill) + +=head1 DESCRIPTION + +This plugin uses the Sick-Beard API (also implemented by forks such as +SickChill) to collect and report on the numbers of shows (total and +active), and episodes (downloaded, snatched, and all) currently tracked +by the app. + +It is a drop-in replacement for sickbeard_shows and sickbeard_episodes, +reusing the vast majority of the code, and providing the same graphs and +data series. + +Sick-Beard : http://sickbeard.com/ + +SickChill : https://sickchill.github.io/ + +=head1 REQUIREMENTS + +JSON::Any, LWP::UserAgent + +=head1 CONFIGURATION + +You need to specify the host/port of the Sick-Beard as well as API key +to use. + + [sickbeard*] + env.host http://host:port/ + env.api apikey + +=head1 AUTHORS + +Copyright (C) 2012 - Blauwbek + +Copyright (C) 2012 - Thiago + +Copyright (C) 2019 - Olivier Mehani , for the +multigraph support and better error handling + +=head1 LICENSE + +SPDX-License-Identifier: GPL-3.0-or-later + +This program is free software: you can redistribute it and/or modify +it under the terms of the GNU General Public License as published by +the Free Software Foundation, either version 3 of the License, or +(at your option) any later version. + +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. + +You should have received a copy of the GNU General Public License +along with this program. If not, see . + +=cut use strict; use JSON::Any;