summaryrefslogtreecommitdiffstats
path: root/web/server
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2018-12-28 14:38:58 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2018-12-28 14:38:58 +0000
commitfa4ece01aed54c9a146af868be0d3db611ded229 (patch)
tree319cffc5f6c2abd7cce514383716153469fc6295 /web/server
parentNew upstream version 1.11.0+dfsg (diff)
downloadnetdata-fa4ece01aed54c9a146af868be0d3db611ded229.tar.xz
netdata-fa4ece01aed54c9a146af868be0d3db611ded229.zip
New upstream version 1.11.1+dfsgupstream/1.11.1+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'web/server')
-rw-r--r--web/server/README.md40
1 files changed, 18 insertions, 22 deletions
diff --git a/web/server/README.md b/web/server/README.md
index 8a6cad139..34ef628bc 100644
--- a/web/server/README.md
+++ b/web/server/README.md
@@ -1,6 +1,6 @@
-# netdata web server
+# Netdata web server
-netdata supports 3 implementation of its internal web server:
+Netdata supports 3 implementations of its internal web server:
- `static-threaded` is a web server with a fix (configured number of threads)
- `single-threaded` is a simple web server running with a single thread
@@ -13,10 +13,9 @@ All versions of the web servers use non-blocking I/O.
All web servers respect the `keep-alive` HTTP header to serve multiple HTTP requests via the same connection.
-
## Configuration
-#### selecting the web server
+### Selecting the web server
You can select the web server implementation by editing `netdata.conf` and setting:
@@ -36,35 +35,33 @@ The `static` web server supports also these settings:
The default number of processor threads is `min(cpu cores, 6)`.
-The `web server max sockets` setting is automatically adjusted to 50% of the max number of open files
-netdata is allowed to use (via `/etc/security/limits.conf` or systemd), to allow enough file descriptors
-to be available for data collection.
+The `web server max sockets` setting is automatically adjusted to 50% of the max number of open files netdata is allowed to use (via `/etc/security/limits.conf` or systemd), to allow enough file descriptors to be available for data collection.
-#### binding netdata to multiple ports
+### Binding netdata to multiple ports
-netdata can bind to multiple IPs and ports. Up to 100 sockets can be used
-(you can increase it at compile time with `CFLAGS="-DMAX_LISTEN_FDS=200" ./netdata-installer.sh ...`).
+Netdata can bind to multiple IPs and ports. Up to 100 sockets can be used (you can increase it at compile time with `CFLAGS="-DMAX_LISTEN_FDS=200" ./netdata-installer.sh ...`).
The ports to bind are controlled via `[web].bind to`, like this:
-
+
```
[web]
default port = 19999
bind to = 127.0.0.1 10.1.1.1:19998 hostname:19997 [::]:19996 localhost:19995 *:http unix:/tmp/netdata.sock
```
-
+
Using the above, netdata will bind to:
- - IPv4 127.0.0.1 at port 19999 (port was used from `default port`)
- - IPv4 10.1.1.1 at port 19998
- - All the IPs `hostname` resolves to (both IPv4 and IPv6 depending on the resolved IPs) at port 19997
- - All IPv6 IPs at port 19996
- - All the IPs `localhost` resolves to (both IPv4 and IPv6 depending the resolved IPs) at port 19996
- - All IPv4 and IPv6 IPs at port `http` as set in `/etc/services`
- - Unix domain socket `/tmp/netdata.sock`
-
+
+- IPv4 127.0.0.1 at port 19999 (port was used from `default port`)
+- IPv4 10.1.1.1 at port 19998
+- All the IPs `hostname` resolves to (both IPv4 and IPv6 depending on the resolved IPs) at port 19997
+- All IPv6 IPs at port 19996
+- All the IPs `localhost` resolves to (both IPv4 and IPv6 depending the resolved IPs) at port 19996
+- All IPv4 and IPv6 IPs at port `http` as set in `/etc/services`
+- Unix domain socket `/tmp/netdata.sock`
+
The option `[web].default port` is used when an entries in `[web].bind to` do not specify a port.
-#### access lists
+### Access lists
Netdata supports access lists in `netdata.conf`:
@@ -104,4 +101,3 @@ If you publish your netdata to the internet, you may want to apply some protecti
3. Don't use all your cpu cores for netdata (lower `[web].web server threads`)
4. Run netdata with a low process scheduling priority (the default is the lowest)
5. If possible, proxy netdata via a full featured web server (nginx, apache, etc)
-