Add documentation
This commit is contained in:
parent
38a07950d4
commit
c909c07561
|
@ -1,24 +1,58 @@
|
|||
#!/usr/bin/perl -w
|
||||
# teamspeak_user.pl
|
||||
# Munin Plugin for Teamspeak3 Servers
|
||||
# displays the number of connected users on TS3 servers
|
||||
|
||||
#######################################################
|
||||
#
|
||||
# by Tim Wulkau - www.wulkau.de
|
||||
#
|
||||
# 18.11.10 - v0.4
|
||||
# -added queryuser login
|
||||
# -subtract queryclients from usercount (tanks to Jakob Lenfers for the idea)
|
||||
# 02.10.10 - v0.3
|
||||
# -fixed welcomemessage error
|
||||
# 31.01.10 - v0.2
|
||||
# -fixed multiserver support
|
||||
# -corrected usercount
|
||||
# 17.01.10 - v0.1
|
||||
# -initial release
|
||||
#
|
||||
######################################################
|
||||
=head1 NAME
|
||||
|
||||
Munin Plugin for Teamspeak3 Servers
|
||||
|
||||
Displays the number of connected users on TS3 servers
|
||||
|
||||
=head1 INSTALLATION
|
||||
|
||||
- Copy this plugin in your munin plugins directory
|
||||
|
||||
=over 2
|
||||
|
||||
ln -s /usr/share/munin/plugins/teamspeak_user /etc/munin/plugins/teamspeak_user
|
||||
|
||||
=back
|
||||
|
||||
After the installation you need to restart your munin-node service.
|
||||
|
||||
=head1 CONFIGURATION
|
||||
|
||||
You need to create a file named teamspeak_user placed in the directory
|
||||
/etc/munin/plugin-conf.d/ with the following config:
|
||||
|
||||
=over 2
|
||||
|
||||
[teamspeak_user]
|
||||
env.hostname 127.0.0.1
|
||||
env.port 10011
|
||||
env.username serveradmin
|
||||
env.password <password>
|
||||
|
||||
=back
|
||||
|
||||
=head1 AUTHORS
|
||||
|
||||
Tim Wulkau - www.wulkau.de
|
||||
|
||||
=head1 CHANGELOG
|
||||
|
||||
23.01.22 - v0.5
|
||||
-add environment variables
|
||||
18.11.10 - v0.4
|
||||
-added queryuser login
|
||||
-subtract queryclients from usercount (tanks to Jakob Lenfers for the idea)
|
||||
02.10.10 - v0.3
|
||||
-fixed welcomemessage error
|
||||
31.01.10 - v0.2
|
||||
-fixed multiserver support
|
||||
-corrected usercount
|
||||
17.01.10 - v0.1
|
||||
-initial release
|
||||
|
||||
=cut
|
||||
|
||||
use strict;
|
||||
use Net::Telnet;
|
||||
|
|
Loading…
Reference in New Issue