1
0
Fork 0
mirror of https://github.com/munin-monitoring/contrib.git synced 2025-07-21 18:41:03 +00:00

Plugin bitcoind_: reformat documentation header

This commit is contained in:
Lars Kruse 2018-08-24 20:29:48 +02:00
parent ab3d97fca9
commit 3b4383696f

View file

@ -1,39 +1,52 @@
#!/usr/bin/env python
# bitcoind_ Munin plugin for Bitcoin Server Variables
#
# by Mike Koss
# Feb 14, 2012, MIT License
#
# You need to be able to authenticate to the bitcoind server to issue rpc's.
# This plugin supporst 2 ways to do that:
#
# 1) In /etc/munin/plugin-conf.d/bitcoin.conf place:
#
# [bitcoind_*]
# user your-username
#
# Then be sure your $HOME/.bitcoin/bitcoin.conf has the correct authentication info:
# rpcconnect, rpcport, rpcuser, rpcpassword
#
# 2) Place your bitcoind authentication directly in /etc/munin/plugin-conf.d/bitcoin.conf
#
# [bitcoind_*]
# env.rpcport 8332
# env.rpcconnect 127.0.0.1
# env.rpcuser your-username-here
# env.rpcpassword your-password-here
#
# To install all available graphs:
#
# sudo munin-node-configure --libdir=. --suggest --shell | sudo bash
#
# Leave out the "| bash" to get a list of commands you can select from to install
# individual graphs.
#
# Munin plugin tags:
#
#%# family=auto
#%# capabilities=autoconf suggest
"""=cut
=head1 NAME
bitcoind_ - Track Bitcoin Server Variables
=head1 CONFIGURATION
You need to be able to authenticate to the bitcoind server to issue rpc's.
This plugin supports two ways to do that:
1) In /etc/munin/plugin-conf.d/bitcoin.conf place:
[bitcoind_*]
user your-username
Then be sure your $HOME/.bitcoin/bitcoin.conf has the correct authentication info:
rpcconnect, rpcport, rpcuser, rpcpassword
2) Place your bitcoind authentication directly in /etc/munin/plugin-conf.d/bitcoin.conf
[bitcoind_*]
env.rpcport 8332
env.rpcconnect 127.0.0.1
env.rpcuser your-username-here
env.rpcpassword your-password-here
To install all available graphs:
sudo munin-node-configure --libdir=. --suggest --shell | sudo bash
Leave out the "| bash" to get a list of commands you can select from to install
individual graphs.
=head1 MAGIC MARKERS
#%# family=auto
#%# capabilities=autoconf suggest
=head1 LICENSE
MIT License
=head1 AUTHOR
Copyright (C) 2012 Mike Koss
=cut"""
import os
import sys