Command_List - saint-lascivious/munin-pihole-plugins GitHub Wiki
Command List
- List of
munin-pihole-plugins
commands
Basic Command List
- Usage:
munin-pihole-plugins {OPTION [PARAMETER]}
Option | GNU long option | Function |
---|---|---|
-c , checkout |
--checkout |
Change munin-pihole-plugins branch |
-C , configure |
--configure |
Display or set environment variables |
-d , debug |
--debug |
Install and run the debug plugin |
-h , help |
--help |
Display help dialogue |
-i , install |
--install |
Install munin-pihole-plugins |
-r , restart |
--restart |
Restart munin-pihole-plugins services |
-s , show |
--show |
Display GNU GPLv3 license information |
-u , uninstall |
--uninstall |
Uninstall munin-pihole-plugins |
-v , version |
--version |
Display current and latest versions |
Type munin-pihole-plugins --help [OPTION]
for more detailed explanations of each command
Example: munin-pihole-plugins --help --install
Expanded Command List
-c
, checkout
, --checkout
- Usage:
munin-pihole-plugins {--checkout [BRANCH]}
Option | GNU long option | Function |
---|---|---|
-c , checkout |
--checkout |
Change munin-pihole-plugins branch |
Shortcut command to (re)install munin-pihole-plugins
using the selected branch. Branches available for selection are development
and master
.
Example: ./munin-pihole-plugins --checkout development
-C
, configure
, --configure
- Usage:
munin-pihole-plugins {--configure [RESET_ALL]|[VARIABLE [VALUE]]}
Option | GNU long option | Function |
---|---|---|
-C , configure |
--configure |
Display or set environment variables |
Display a full list of environment variables used by the munin-pihole-plugins script, and their current values. These variables and this command can be used to customise various aspects of the munin-pihole-plugins script's operation.
Takes an optional parameter in the form of a munin-pihole-plugins environment variable to list the value of that variable alone.
Example: munin-pihole-plugins --configure INSTALL_PLUGINS
Takes an optional value for a munin-pihole-plugins environment variable to set the value of that variable. If the optional value passed is RESET
, the corresponding environment variable will be reset to its default value. This functionality is only available if the munin-pihole-plugins script is found to exist within SCRIPT_DIR.
Examples: munin-pihole-plugins --configure DNS_SERVER 127.0.0.1
`munin-pihole-plugins --configure DNS_SERVER RESET`
Takes an optional parameter in the form of RESET_ALL
to restore all munin-pihole-plugins environment variables to their default values. Again, this functionality is only available if the munin-pihole-plugins script is found to exist within SCRIPT_DIR, whereby it's considered "installed".
Example: munin-pihole-plugins --configure RESET_ALL
-d
, debug
, --debug
- Usage:
munin-pihole-plugins {--debug}
Option | GNU long option | Function |
---|---|---|
-d , debug |
--debug |
-d, debug |
Install and run the debug plugin to examine the current plugin environment. The plugin is executed once using munin-run
and then removed afterwards.
Note: This plugin does not configure or produce any graph.
Example: munin-pihole-plugins --debug
-h
, help
, --help
- Usage:
munin-pihole-plugins --help {OPTION[PARAMETER]}
Option | GNU long option | Function |
---|---|---|
-h , help |
--help |
Display help dialogue |
Display simple or detailed munin-pihole-plugins help information.
Type munin-pihole-plugins --help {OPTION [PARAMETER]}
for more detailed explanations of each command.
Example: munin-pihole-plugins --help --install --plugins
-i
, install
, --install
- Usage:
munin-pihole-plugins {--install [PARAMETER]}
Option | GNU long option | Function |
---|---|---|
-i , install |
--install |
Install munin-pihole-plugins |
Install and configure Munin monitoring server software (default: true), client software (default: true), selected munin-pihole-plugins plugins (default: all) and install a copy of the munin-pihole-plugins script (default: true) to a selected directory (default: /usr/local/bin).
The munin-pihole-plugins script will self update (default: true) before install if a newer version of the munin-pihole-plugins script is available.
You can run the installation again at any time afterwards to update the munin-pihole-plugins script and plugins, optionally selecting which plugins to install using the PLUGIN_LIST variable.
Example: munin-pihole-plugins --install
For more options, see: Advanced Install.
-r
, restart
, --restart
- Usage:
munin-pihole-plugins {--restart [PARAMETER]}
Option | GNU long option | Function |
---|---|---|
-r , restart |
--restart |
Restart munin-pihole-plugins services |
Restart any/all services relevant to munin-pihole-plugins.
The list of services to restart is governed by the states of the INSTALL_* environment/external configuration variables, all of which default "true".
Takes an optional parameter to restart only those services involved with that munin-pihole-plugins component.
Optional Parameter | GNU long parameter | Function |
---|---|---|
-p , plugins |
--plugins |
Restart the munin-node service |
-w , webserver |
--webserver |
Restart both the munin and lighttpd services |
Example: munin-pihole-plugins --restart
-s
, show
, --show
- Usage:
munin-pihole-plugins {--show OPTION}
Option | GNU long option | Function |
---|---|---|
-s , show |
--show |
Display GNU GPLv3 license information |
Option | GNU long option | Function |
---|---|---|
-c, conditions | --conditions |
Show GNU GPLv3 licensing conditions |
-g, gnu-gpl | --gnu-gpl |
Show full GNU GPL v3 license text (less/more terminal paginator required) |
-l, liability | --liability |
Show liability definition |
-w, warranty | --warranty |
Show warranty information |
Example: munin-pihole-plugins --show --warranty
-u
, uninstall
, --uninstall
- Usage: munin-pihole-plugins {--uninstall [PARAMETER]}
Option | GNU long option | Function |
---|---|---|
-u , uninstall |
--uninstall |
Uninstall munin-pihole-plugins |
Completely uninstall munin-pihole-plugins, you will be asked if you want to uninstall any dependencies that munin-pihole-plugins may have installed.
Example: munin-pihole-plugins --uninstall
For more options, see: Advanced Uninstall.
-v
, version
, --version
- Usage:
munin-pihole-plugins {--version}
Option | GNU long option | Function |
---|---|---|
-v , version |
--version |
Display current and latest versions |
Display the current munin-pihole-plugins script version, and compare it to the latest munin-pihole-plugins script version.
An additional notification will be displayed if an update is available.
Example: munin-pihole-plugins --version