summaryrefslogtreecommitdiffstats
path: root/docs/configure
diff options
context:
space:
mode:
authorJoel Hans <joel@netdata.cloud>2020-10-01 07:49:39 -0700
committerGitHub <noreply@github.com>2020-10-01 07:49:39 -0700
commit82ccdfd45eccf420ab11f4ffbdaf4eb3565c9f31 (patch)
treedca0121966c21927ecc25be3f8b92be810c416ca /docs/configure
parentb9bc990af36ce8917fc037f681d0b1987b78eb81 (diff)
Clean up and better cross-link new docsv2 documents (#10015)
* Finish cleanup pass * Fixes for Amy
Diffstat (limited to 'docs/configure')
-rw-r--r--docs/configure/nodes.md12
-rw-r--r--docs/configure/secure-nodes.md17
2 files changed, 14 insertions, 15 deletions
diff --git a/docs/configure/nodes.md b/docs/configure/nodes.md
index 5998c1e746..761350b161 100644
--- a/docs/configure/nodes.md
+++ b/docs/configure/nodes.md
@@ -40,16 +40,14 @@ Upon installation, the Netdata config directory contains a few files and directo
`/usr/lib/netdata/conf.d`, as they are overwritten by updates to the Netdata Agent._
- `edit-config` is a shell script used for [editing configuration files](#use-edit-config-to-edit-netdataconf).
- `go.d/`, `python.d/`, `charts.d/`, `node.d`/, and `custom-plugins.d/`, which are directories for each of Netdata's
- [orchestrators](/collectors/plugins.d/README.md#external-plugins-overview). These directories can each contain
- additional `.conf` files for configuring specific collectors.
+ [orchestrators](/collectors/plugins.d/README.md). These directories can each contain additional `.conf` files for
+ configuring specific collectors.
## Use `edit-config` to edit `netdata.conf`
-The best way to edit any configuration file is with `edit-config` script. This script opens existing Netdata
-configuration files using your system's `$EDITOR`. If the file doesn't yet exist in your config directory, the script
-copies the stock version from `/usr/lib/netdata/conf.d` and opens it for editing.
-
-`edit-config` is the recommended way to easily and safely edit Netdata's configuration.
+The **recommended way to easily and safely edit Netdata's configuration** is with the `edit-config` script. This script
+opens existing Netdata configuration files using your system's `$EDITOR`. If the file doesn't yet exist in your config
+directory, the script copies the stock version from `/usr/lib/netdata/conf.d` and opens it for editing.
Run `edit-config` without any options to see details on its usage and a list of all the configuration files you can
edit.
diff --git a/docs/configure/secure-nodes.md b/docs/configure/secure-nodes.md
index 629409f815..9e5784b311 100644
--- a/docs/configure/secure-nodes.md
+++ b/docs/configure/secure-nodes.md
@@ -8,7 +8,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/configure/s
# Secure your nodes
-Upon installation, the Netdata Agent serves the local dashboard at port `19999`. If the node is accessible to the
+Upon installation, the Netdata Agent serves the **local dashboard** at port `19999`. If the node is accessible to the
internet at large, anyone can access the dashboard and your node's metrics at `http://NODE:19999`. We made this decision
so that the local dashboard was immediately accessible to users, and so that we don't dictate how professionals set up
and secure their infrastructures.
@@ -27,9 +27,9 @@ Instead of dictating how to secure your infrastructure, we give you many options
that align with your goals and your organization's standards.
- [Disable the local dashboard](#disable-the-local-dashboard): **Simplest and recommended method** for those who have
- added nodes to Netdata Cloud and view metrics there.
-- [Restrict access to the local dashboard](#restrict-access-to-the-local-dashboard): Allow dashboard access from only
- certain IP addresses, such as a trusted static IP or connections from behind a management LAN. Full support for
+ added nodes to Netdata Cloud and view dashboards and metrics there.
+- [Restrict access to the local dashboard](#restrict-access-to-the-local-dashboard): Allow local dashboard access from
+ only certain IP addresses, such as a trusted static IP or connections from behind a management LAN. Full support for
Netdata Cloud.
- [Use a reverse proxy](#use-a-reverse-proxy): Password-protect a local dashboard and enable TLS to secure it. Full
support for Netdata Cloud.
@@ -39,13 +39,13 @@ that align with your goals and your organization's standards.
This is the _recommended method for those who have claimed their nodes to Netdata Cloud_ and prefer viewing real-time
metrics using the Nodes view and Cloud dashboards.
-You can disable the local dashboard entirely but retain the encrypted Agent-Cloud link ([ACLK](/aclk/README.md)) that
+You can disable the local dashboard (and API) but retain the encrypted Agent-Cloud link ([ACLK](/aclk/README.md)) that
allows you to stream metrics on demand from your nodes via the Netdata Cloud interface. This change mitigates all
concerns about revealing metrics and system design to the internet at large, while keeping all the functionality you
-need to view metrics and troubleshoot issues.
+need to view metrics and troubleshoot issues with Netdata Cloud.
Open `netdata.conf` with `./edit-config netdata.conf`. Scroll down to the `[web]` section, and find the `mode =
-static-threaded` setting. To disable the local dashboard, change this setting to `none`.
+static-threaded` setting, and change it to `none`.
```conf
[web]
@@ -97,7 +97,8 @@ The `allow connections from` setting is global and restricts access to the dashb
```
See the [web server](/web/server/README.md#access-lists) docs for additional details about access lists. You can take
-access lists one step further by [enabling SSL](/web/server/README.md#enabling-tls-support) to encrypt data in transit.
+access lists one step further by [enabling SSL](/web/server/README.md#enabling-tls-support) to encrypt data from local
+dashboard in transit. The connection to Netdata Cloud is always secured with TLS.
## Use a reverse proxy