Debian Codegraph @

check_ssl_cert/src/INSTALL.md

raw
1 # check\_ssl\_check
2
3 ## Requirements
4
5 * ```bc```
6 * [curl](https://curl.se)
7 * ```date```
8 * ```file```
9 * ```host```
10 * [nmap](https://nmap.org)
11 * [OpenSSL](https://www.openssl.org)
12
13 ## Optional dependencies
14
15 * check\_ssl\_cert requires [```expect```](http://en.wikipedia.org/wiki/Expect) or [```timeout```](https://man7.org/linux/man-pages/man1/timeout.1.html) to enable timeouts. If ```expect``` or ```timeout``` are not present on your system timeouts will be disabled.
16 * ```dig``` for
17 * DANE checks
18 * DNSSEC checks
19 * [gmake](https://www.gnu.org/software/make/) on [FreeBSD](https://www.freebsd.org)
20 * ```expand``` for ```--info```
21 * ```tar``` and ```bzip2``` to build release packages
22 * ```ip``` or ```ifconfig``` to be able to use the ```-4``` and ```-6``` options
23 * [nectcat](https://nc110.sourceforge.io) for ```--ignore-connection-state```
24 * Python 3.0 for the TDS (Tabular Data Stream) protocol check
25 * Java for KeyStore checks
26
27 ## Development
28
29 Following tools are required for development:
30
31 * [shUnit2](https://github.com/kward/shunit2) for the tests
32 * [shfmt](https://github.com/mvdan/sh) to format the source files
33 * [ShellCheck](https://www.shellcheck.net) for the code quality checks
34 * [codespell](https://github.com/codespell-project/codespell) for the spelling checks
35 * ```dig``` for IPv6 tests
36
37 You can check the installed dependencies with the ```utils/check_deps.sh``` script.
38
39 ## Installation
40
41 * You can run the plugin from the shell.
42 * If you want to install it systemwide, copy the plugin to a directory in the path, and ```check_ssl_cert.1``` in an appropriate directory in the ```$MANPATH```
43 * Simply copy the plugin to your Nagios/Icinga plugin directory (e.g., ```/usr/lib64/nagios/plugins/```)
44 * Use ```make install``` by defining the ```DESTDIR``` and ```MANDIR``` variables with the installation targets. E.g, ```make DESTDIR=/nagios/plugins/dir MANDIR=/nagios/plugins/man/dir install``` or ```sudo make -E DESTDIR=/usr/local/bin MANDIR=/usr/local/man```
45 * To install the bash completion script run ```sudo make install_bash_completion``` (it will install the completion script in the directory defined by ```pkg-config --variable=completionsdir bash-completion```)