Skip to content

Commit

Permalink
Documentation enhancement for #431
Browse files Browse the repository at this point in the history
  • Loading branch information
Ryan Rawdon committed Jan 30, 2025
1 parent 64409ae commit 7cacff1
Showing 1 changed file with 7 additions and 4 deletions.
11 changes: 7 additions & 4 deletions lib/Smokeping/probes/SSH.pm
Original file line number Diff line number Diff line change
@@ -35,8 +35,11 @@ The Probe asks the given host n-times for it's public key, where n is
the amount specified in the config File.
As part of the initialization, the probe asks 127.0.0.1 for it's public key
and tries to parse the output. Make sure you have SSH running on the
localhost as well.
and tries to parse the output. This is to ensure that the specified ssh-keyscan
binary provides output in the expected formatm before relying on it.Make sure
you have SSH running on the localhost as well, or specify an alternative
init_host target to test against, that is expected to be available during any
smokeping restart.
DOC
authors => <<'DOC',
Christian Recktenwald <smokeping-contact@citecs.de>
@@ -123,9 +126,9 @@ sub probevars {
-x $val or return "ERROR: binary '$val' is not executable";
return undef;
},
},
}
init_host => {
_doc => "Host to use for initialization, defaults to IPv4 localhost 127.0.0.1",
_doc => "Host to use for initialization, defaults to IPv4 localhost of 127.0.0.1",
_example => '127.0.0.1',
_default => '127.0.0.1',
}

0 comments on commit 7cacff1

Please sign in to comment.