Skip to content

Latest commit

 

History

History
492 lines (293 loc) · 15.8 KB

WEBServer.md

File metadata and controls

492 lines (293 loc) · 15.8 KB
Raw

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.

List of Configuration

Common Keys

Path / Section Key Description
/settings/default [allowed hosts](#/settings/default_allowed hosts) ALLOWED HOSTS
/settings/default [bind to](#/settings/default_bind to) BIND TO ADDRESS
/settings/default [cache allowed hosts](#/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 Description
/settings/default encoding NRPE PAYLOAD ENCODING
/settings/default [socket queue size](#/settings/default_socket queue size) LISTEN QUEUE
/settings/default [thread pool](#/settings/default_thread pool) THREAD POOL
/settings/WEB/server [allowed hosts](#/settings/WEB/server_allowed hosts) ALLOWED HOSTS
/settings/WEB/server [cache allowed hosts](#/settings/WEB/server_cache allowed hosts) CACHE ALLOWED HOSTS
/settings/WEB/server password PASSWORD

Configuration

## 
# 
[/settings/default]
allowed hosts=127.0.0.1
cache allowed hosts=true
inbox=inbox
socket queue size=0
thread pool=10
timeout=30
Key Default Value Description
[allowed hosts](#/settings/default_allowed hosts) 127.0.0.1 ALLOWED HOSTS
[bind to](#/settings/default_bind to) BIND TO ADDRESS
[cache allowed hosts](#/settings/default_cache allowed hosts) true CACHE ALLOWED HOSTS
encoding NRPE PAYLOAD ENCODING
inbox inbox INBOX
password PASSWORD
[socket queue size](#/settings/default_socket queue size) 0 LISTEN QUEUE
[thread pool](#/settings/default_thread pool) 10 THREAD POOL
timeout 30 TIMEOUT
### allowed hosts

ALLOWED HOSTS

A comma separated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges.

Key Description
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

BIND TO ADDRESS

Allows you to bind server to a specific local address. This has to be a dotted ip address not a host name. Leaving this blank will bind to all available IP addresses.

Key Description
Path: /settings/default
Key: bind to
Default value: N/A
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# BIND TO ADDRESS
bind to=
### cache allowed hosts

CACHE ALLOWED HOSTS

If host names (DNS entries) should be cached, improves speed and security somewhat but won't allow you to have dynamic IPs for your Nagios server.

Key Description
Path: /settings/default
Key: cache allowed hosts
Default value: true
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# CACHE ALLOWED HOSTS
cache allowed hosts=true
### encoding

NRPE PAYLOAD ENCODING

Key Description
Path: /settings/default
Key: encoding
Advanced: Yes (means it is not commonly used)
Default value: N/A
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# NRPE PAYLOAD ENCODING
encoding=
### inbox

INBOX

The default channel to post incoming messages on

Key Description
Path: /settings/default
Key: inbox
Default value: inbox
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# INBOX
inbox=inbox
### password

PASSWORD

Password used to authenticate against server

Key Description
Path: /settings/default
Key: password
Default value: N/A
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# PASSWORD
password=
### socket queue size

LISTEN QUEUE

Number of sockets to queue before starting to refuse new incoming connections. This can be used to tweak the amount of simultaneous sockets that the server accepts.

Key Description
Path: /settings/default
Key: socket queue size
Advanced: Yes (means it is not commonly used)
Default value: 0
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# LISTEN QUEUE
socket queue size=0
### thread pool

THREAD POOL

Key Description
Path: /settings/default
Key: thread pool
Advanced: Yes (means it is not commonly used)
Default value: 10
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# THREAD POOL
thread pool=10
### timeout

TIMEOUT

Timeout when reading packets on incoming sockets. If the data has not arrived within this time we will bail out.

Key Description
Path: /settings/default
Key: timeout
Default value: 30
Used by: CheckMKServer, NRPEServer, NSCAServer, NSClientServer, WEBServer

Sample

[/settings/default]
# TIMEOUT
timeout=30
## WEB SERVER SECTION

Section for WEB (WEBServer.dll) (check_WEB) protocol options.

# Section for WEB (WEBServer.dll) (check_WEB) protocol options.
[/settings/WEB/server]
allowed hosts=127.0.0.1
cache allowed hosts=true
certificate=${certificate-path}/certificate.pem
port=8443s
Key Default Value Description
[allowed hosts](#/settings/WEB/server_allowed hosts) 127.0.0.1 ALLOWED HOSTS
[cache allowed hosts](#/settings/WEB/server_cache allowed hosts) true CACHE ALLOWED HOSTS
certificate ${certificate-path}/certificate.pem CERTIFICATE
password PASSWORD
port 8443s PORT NUMBER
### allowed hosts

ALLOWED HOSTS

A comma separated list of allowed hosts. You can use netmasks (/ syntax) or * to create ranges. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.

Key Description
Path: /settings/WEB/server
Key: allowed hosts
Advanced: Yes (means it is not commonly used)
Default value: 127.0.0.1
Used by: WEBServer

Sample

[/settings/WEB/server]
# ALLOWED HOSTS
allowed hosts=127.0.0.1
### cache allowed hosts

CACHE ALLOWED HOSTS

If host names (DNS entries) should be cached, improves speed and security somewhat but won't allow you to have dynamic IPs for your Nagios server. parent for this key is found under: /settings/default this is marked as advanced in favor of the parent.

Key Description
Path: /settings/WEB/server
Key: cache allowed hosts
Advanced: Yes (means it is not commonly used)
Default value: true
Used by: WEBServer

Sample

[/settings/WEB/server]
# CACHE ALLOWED HOSTS
cache allowed hosts=true
### certificate

CERTIFICATE

Ssl certificate to use for the ssl server

Key Description
Path: /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

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.

Key Description
Path: /settings/WEB/server
Key: password
Advanced: Yes (means it is not commonly used)
Default value: N/A
Used by: WEBServer

Sample

[/settings/WEB/server]
# PASSWORD
password=
### port

PORT NUMBER

Port to use for WEB server.

Key Description
Path: /settings/WEB/server
Key: port
Default value: 8443s
Used by: WEBServer

Sample

[/settings/WEB/server]
# PORT NUMBER
port=8443s