Révision 09b88141
Improve documantion of many plugins
Specifically the configuration examples are now indented properly.
| plugins/syncthing/strelaysrv_ | ||
|---|---|---|
| 1 | 1 |
#!/bin/sh |
| 2 | 2 |
: <<=cut |
| 3 | 3 |
=head1 NAME |
| 4 |
|
|
| 4 | 5 |
strelaysrv_ - Plugin to monitor Syncthing relay server |
| 5 | 6 |
|
| 6 | 7 |
=head1 DESCRIPTION |
| 8 |
|
|
| 7 | 9 |
This plugin gathers metrics from a Syncthing relay server. |
| 8 | 10 |
|
| 9 | 11 |
This plugin requires the jq utility : https://stedolan.github.io/jq/ |
| 10 | 12 |
This plugin requires the curl utility : https://curl.haxx.se/ |
| 11 | 13 |
|
| 12 |
Available plugins : |
|
| 13 |
strelaysrv_goroutine # |
|
| 14 |
strelaysrv_num # |
|
| 15 |
strelaysrv_proxied # |
|
| 16 |
strelaysrv_transfer # |
|
| 17 |
strelaysrv_uptime # |
|
| 14 |
Available wildcard plugin features: |
|
| 15 |
|
|
| 16 |
=over 4 |
|
| 17 |
|
|
| 18 |
=item strelaysrv_goroutine |
|
| 19 |
|
|
| 20 |
=item strelaysrv_num |
|
| 21 |
|
|
| 22 |
=item strelaysrv_proxied |
|
| 23 |
|
|
| 24 |
=item strelaysrv_transfer |
|
| 25 |
|
|
| 26 |
=item strelaysrv_uptime |
|
| 27 |
|
|
| 28 |
=back |
|
| 29 |
|
|
| 18 | 30 |
|
| 19 | 31 |
=head1 CONFIGURATION |
| 32 |
|
|
| 20 | 33 |
To make the plugin connect to the Syncthing relay server one has to use this type of |
| 21 |
configuration |
|
| 22 |
[strelaysrv_*] |
|
| 34 |
configuration: |
|
| 23 | 35 |
|
| 24 |
env.syncthing_relaysrv_host 127.0.0.1 |
|
| 25 |
env.syncthing_relaysrv_port 22070 |
|
| 36 |
[strelaysrv_*] |
|
| 37 |
env.syncthing_relaysrv_host 127.0.0.1 |
|
| 38 |
env.syncthing_relaysrv_port 22070 |
|
| 26 | 39 |
|
| 27 | 40 |
=head1 AUTHOR |
| 41 |
|
|
| 28 | 42 |
Pierre-Alain TORET <pierre-alain.toret@protonmail.com> |
| 29 | 43 |
|
| 30 | 44 |
=head1 LICENSE |
| 45 |
|
|
| 31 | 46 |
MIT |
| 47 |
|
|
| 48 |
SPDX-License-Identifier: MIT |
|
| 49 |
|
|
| 32 | 50 |
=cut |
| 33 | 51 |
|
| 34 | 52 |
syncthing_relaysrv_host=${syncthing_relaysrv_host:-}
|
Formats disponibles : Unified diff