WEBServer
WEBServer
— WEBServer¶A server that listens for incoming HTTP connection and processes incoming requests. It provides both a WEB UI as well as a REST API in addition to simplifying configuration of WEB Server module.
Commands (Overview):
TODO: Add a list of all external commands (this is not check commands)
Configuration (Overview):
Common Keys:
Path / Section | Key | Description |
---|---|---|
/settings/default |
allowed hosts |
ALLOWED HOSTS |
/settings/default |
bind to |
BIND TO ADDRESS |
/settings/default |
cache allowed hosts |
CACHE ALLOWED HOSTS |
/settings/default |
inbox |
INBOX |
/settings/default |
password |
PASSWORD |
/settings/default |
timeout |
TIMEOUT |
/settings/WEB/server |
certificate |
CERTIFICATE |
/settings/WEB/server |
port |
PORT NUMBER |
Advanced keys:
Path / Section | Key | Default Value | Description |
---|---|---|---|
/settings/default |
encoding |
NRPE PAYLOAD ENCODING | |
/settings/default |
socket queue size |
LISTEN QUEUE | |
/settings/default |
thread pool |
THREAD POOL | |
/settings/WEB/server |
password |
PASSWORD |
/settings/default
(WEBServer)¶Key | Default Value | Description |
---|---|---|
allowed hosts |
127.0.0.1 | ALLOWED HOSTS |
bind to |
BIND TO ADDRESS | |
cache allowed hosts |
1 | CACHE ALLOWED HOSTS |
encoding |
NRPE PAYLOAD ENCODING | |
inbox |
inbox | INBOX |
password |
PASSWORD | |
socket queue size |
0 | LISTEN QUEUE |
thread pool |
10 | THREAD POOL |
timeout |
30 | TIMEOUT |
Sample:
#
#
[/settings/default]
allowed hosts=127.0.0.1
bind to=
cache allowed hosts=1
encoding=
inbox=inbox
password=
socket queue size=0
thread pool=10
timeout=30
allowed hosts
(WEBServer, /settings/default)¶ALLOWED HOSTS
Path: /settings/default
Key: allowed hosts
Default value: 127.0.0.1
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# ALLOWED HOSTS
allowed hosts=127.0.0.1
bind to
(WEBServer, /settings/default)¶BIND TO ADDRESS
Path: /settings/default
Key: bind to
Default value:
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# BIND TO ADDRESS
bind to=
cache allowed hosts
(WEBServer, /settings/default)¶CACHE ALLOWED HOSTS
Path: /settings/default
Key: cache allowed hosts
Default value: 1
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# CACHE ALLOWED HOSTS
cache allowed hosts=1
encoding
(WEBServer, /settings/default)¶NRPE PAYLOAD ENCODING
Advanced (means it is not commonly used)
Path: /settings/default
Key: encoding
Default value:
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# NRPE PAYLOAD ENCODING
encoding=
inbox
(WEBServer, /settings/default)¶INBOX
Path: /settings/default
Key: inbox
Default value: inbox
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# INBOX
inbox=inbox
password
(WEBServer, /settings/default)¶PASSWORD
Path: /settings/default
Key: password
Default value:
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# PASSWORD
password=
socket queue size
(WEBServer, /settings/default)¶LISTEN QUEUE
Advanced (means it is not commonly used)
Path: /settings/default
Key: socket queue size
Default value: 0
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# LISTEN QUEUE
socket queue size=0
thread pool
(WEBServer, /settings/default)¶THREAD POOL
Advanced (means it is not commonly used)
Path: /settings/default
Key: thread pool
Default value: 10
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# THREAD POOL
thread pool=10
timeout
(WEBServer, /settings/default)¶TIMEOUT
Path: /settings/default
Key: timeout
Default value: 30
Used by: CheckMKServer
, NRPEServer
, NSCAServer
, NSClientServer
, WEBServer
Sample:
[/settings/default]
# TIMEOUT
timeout=30
/settings/WEB/server
(WEBServer)¶WEB SERVER SECTION
Section for WEB (WEBServer.dll) (check_WEB) protocol options.
Key Default Value Description certificate
${certificate-path}/certificate.pem CERTIFICATE password
PASSWORD port
8443s PORT NUMBER Sample:
# WEB SERVER SECTION # Section for WEB (WEBServer.dll) (check_WEB) protocol options. [/settings/WEB/server] certificate=${certificate-path}/certificate.pem password= port=8443s
certificate
(WEBServer, /settings/WEB/server)¶CERTIFICATE
Ssl certificate to use for the ssl serverPath: /settings/WEB/server
Key: certificate
Default value: ${certificate-path}/certificate.pem
Used by:
WEBServer
Sample:
[/settings/WEB/server] # CERTIFICATE certificate=${certificate-path}/certificate.pem
password
(WEBServer, /settings/WEB/server)¶PASSWORD
Password used to authenticate against server parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.Advanced (means it is not commonly used)
Path: /settings/WEB/server
Key: password
Default value:
Used by:
WEBServer
Sample:
[/settings/WEB/server] # PASSWORD password=
port
(WEBServer, /settings/WEB/server)¶PORT NUMBER
Port to use for WEB server.Path: /settings/WEB/server
Key: port
Default value: 8443s
Used by:
WEBServer
Sample:
[/settings/WEB/server] # PORT NUMBER port=8443s