Docs: Fix internal links and remove obsolete admonitions (#8946)
* Fixed a few more links * Remove old syntax * Abs-relative links to files in docs folder * Trying to fix nother doc learn link * Fix a few more links * Add testing doc * Tracking down mysteries * Cleanup * Update broken external links * Remove index.html that appeared from testing * Fix remainder of links
Joel Hans committed
May 11, 2020 at 08:48 UTC
74fda3de8e45e4211da8a574daabbfc30c74f0a9
27 files changed
+87
-87
CONTRIBUTING.md
+1
-1
@@ -75,7 +75,7 @@ Our documentation is in need of constant improvement and expansion. As Netdata's
75
76
We also need to produce beginner-level tutorials on using Netdata to monitor common applications, web servers, and more.
77
78
-Start with the [guide for contributing to documentation](docs/contributing/contributing-documentation.md), and then review the [documentation style guide](docs/contributing/style-guide.md) for specifics on how we write our documentation.
78
+Start with the [guide for contributing to documentation](/docs/contributing/contributing-documentation.md), and then review the [documentation style guide](/docs/contributing/style-guide.md) for specifics on how we write our documentation.
79
80
Don't be afraid to submit a pull request with your corrections or additions! We need a lot of help and are willing to guide new contributors through the process.
81
aclk/README.md
+2
-2
@@ -99,7 +99,7 @@ reinstall Netdata with Cloud enabled or change the runtime setting in your `clou
99
100
If you passed `--disable-cloud` to `netdata-installer.sh` during installation, you must reinstall your Agent. Use the
101
same method as before, but pass `--require-cloud` to the installer. When installation finishes you can [claim your
102
-node](/claim/README.md#claim-a-node).
102
+node](/claim/README.md#how-to-claim-a-node).
103
104
If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf` file, edit the file again and change
105
`enabled` to `yes`:
@@ -109,6 +109,6 @@ If you changed the runtime setting in your `var/lib/netdata/cloud.d/cloud.conf`
109
enabled = yes
110
```
111
112
-Restart your Agent and [claim your node](/claim/README.md#claim-a-node).
112
+Restart your Agent and [claim your node](/claim/README.md#how-to-claim-a-node).
113
114
[](<>)
collectors/QUICKSTART.md
+2
-2
@@ -82,7 +82,7 @@ Despite Netdata's auto-detection capabilities, it's important to know how to edi
82
83
You should always edit configuration files with the `edit-config` script that comes with every installation of Netdata.
84
To edit a collector configuration file, navigate to your [Netdata configuration
85
-directory](../docs/step-by-step/step-04.md#find-your-netdataconf-file). Launch `edit-config` with the path to the
85
+directory](/docs/step-by-step/step-04.md#find-your-netdataconf-file). Launch `edit-config` with the path to the
86
collector's configuration file.
87
88
How do you find that path to the collector's configuration file? Look under the **Configuration** heading in the
@@ -105,7 +105,7 @@ Most collectors are enabled and will auto-detect their app/service without manua
105
restart Netdata to trigger the auto-detection process.
106
107
To restart Netdata on most systems, use `service netdata restart`. For other systems, see the [other restart
108
-methods](../docs/getting-started.md#start-stop-and-restart-netdata).
108
+methods](/docs/getting-started.md#start-stop-and-restart-netdata).
109
110
Open Netdata's dashboard in your browser, or refresh the page if you already have it open. You should now see a new
111
entry in the menu and new interactive charts!
collectors/freeipmi.plugin/README.md
+2
-7
@@ -163,13 +163,8 @@ You will get verbose output on what the plugin does.
163
164
## kipmi0 CPU usage
165
166
-There have been reports that kipmi is showing increased CPU when the IPMI is queried.
167
-
168
-[IBM has given a few explanations](http://www-01.ibm.com/support/docview.wss?uid=nas7d580df3d15874988862575fa0050f604).
169
-
170
-Check also [this stackexchange post](http://unix.stackexchange.com/questions/74900/kipmi0-eating-up-to-99-8-cpu-on-centos-6-4).
171
-
172
-To lower the CPU consumption of the system you can issue this command:
166
+There have been reports that kipmi is showing increased CPU when the IPMI is queried. To lower the CPU consumption of
167
+the system you can issue this command:
168
169
```sh
170
echo 10 > /sys/module/ipmi_si/parameters/kipmid_max_busy_us
collectors/python.d.plugin/oracledb/README.md
+3
-2
@@ -46,9 +46,10 @@ It produces following charts:
46
47
To use the Oracle module do the following:
48
49
-1. Install `cx_Oracle` package ([link](https://cx-oracle.readthedocs.io/en/latest/installation.html#install-cx-oracle)).
49
+1. Install `cx_Oracle` package ([link](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html)).
50
51
-2. Install Oracle Client libraries ([link](https://cx-oracle.readthedocs.io/en/latest/installation.html#install-oracle-client)).
51
+2. Install Oracle Client libraries
52
+ ([link](https://cx-oracle.readthedocs.io/en/latest/user_guide/installation.html#install-oracle-client)).
53
54
3. Create a read-only `netdata` user with proper access to your Oracle Database Server.
55
docs/Donations-netdata-has-received.md
-1
@@ -18,7 +18,6 @@ This is a list of the donations we have received for Netdata (sorted alphabetica
18
| Cloud VMs|[london.my-netdata.io](https://london.my-netdata.io) (Several VMs)|**[DigitalOcean.com](https://www.digitalocean.com/)**|**DigitalOcean.com** donated 1000 USD to be used in their excellent Cloud Computing services. Many thanks to [Justin Paine](https://github.com/xxdesmus) for making this happen.|
19
| Development IDE|-|**[JetBrains.com](https://www.jetbrains.com/)**|**JetBrains.com** donated an open source license for 4 developers for 1 year, to their excellent IDEs.|
20
| Cloud VM|[octopuscs.my-netdata.io](https://octopuscs.my-netdata.io)|**[OctopusCS.com](https://octopuscs.com/)**|**OctopusCS.com** donated a VM with 4 CPU cores, 16GB RAM and 50GB HD in their excellent Cloud Computing services.|
21
-| Cloud VM|[ventureer.my-netdata.io](https://ventureer.my-netdata.io)|**[Ventureer.com](https://ventureer.com/)**|**Ventureer.com** donated a VM with 4 CPU cores, 8GB RAM and 50GB HD in their excellent Cloud Computing services.|
21
| Cloud VM|[stackscale.my-netdata.io](https://stackscale.my-netdata.io)|**[stackscale.com](https://www.stackscale.com/)**|**StackScale.com** donated a VM with 4 CPU cores, 16GB RAM and 100GB HD in their excellent Cloud Computing services.|
22
23
Thank you!
docs/Running-behind-haproxy.md
+5
-4
@@ -11,9 +11,10 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/Running-beh
11
> and proxying for TCP and HTTP-based applications. It is particularly suited for very high traffic web sites
12
> and powers quite a number of the world's most visited ones.
13
14
-If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name
15
-can be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to
16
-connect to Netdata at <https://example.com> or <https://example.com/netdata/>, which is a much nicer experience then <http://example.com:19999>.
14
+If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name can
15
+be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to connect to
16
+Netdata at `https://example.com` or `https://example.com/netdata/`, which is a much nicer experience then
17
+`http://example.com:19999`.
18
19
To proxy requests from [HAProxy](https://github.com/haproxy/haproxy) to Netdata,
20
the following configuration can be used:
@@ -29,7 +30,7 @@ defaults
30
31
## Simple Configuration
32
32
-A simple example where the base URL, say <http://example.com>, is used with no subpath:
33
+A simple example where the base URL, say `http://example.com`, is used with no subpath:
34
35
### Frontend
36
docs/anonymous-statistics.md
+1
-1
@@ -97,7 +97,7 @@ update. You can also export the environment variable `DO_NOT_TRACK` with a non-z
97
98
When using Docker, **set your `DO_NOT_TRACK` environment variable to `1`.** You can set this variable with the following
99
command: `export DO_NOT_TRACK=1`. When creating a container using Netdata's [Docker
100
-image](/packaging/docker/README.md#run-netdata-with-the-docker-command) for the first time, this variable will disable
100
+image](/packaging/docker/README.md#run-the-agent-with-the-docker-command) for the first time, this variable will disable
101
the anonymous statistics script inside of the container.
102
103
Each of these opt-out processes does the following:
docs/contributing/contributing-documentation.md
+4
-7
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Contributing to documentation"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/contributing-documentation.md
5
----
4
-->
5
6
# Contributing to documentation
@@ -70,9 +68,9 @@ button.
68
After you've hit that button, jump down to our instructions on [pull requests and
69
cleanup](#pull-requests-and-final-steps) for your next steps.
70
73
-!!! note This process will create a branch directly on the `netdata/netdata` repository, which then requires manual
74
- cleanup. If you're going to make significant documentation contributions, or contribute often, we recommend the
75
- local editing process just below.
71
+> This process will create a branch directly on the `netdata/netdata` repository, which then requires manual cleanup. If
72
+> you're going to make significant documentation contributions, or contribute often, we recommend the local editing
73
+> process just below.
74
75
## Edit documentation locally
76
@@ -115,8 +113,7 @@ folder and either name it `README.md` for generic documentation, or with another
113
#### The `docs` folder
114
115
At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have
118
-a direct relationship to a specific component of Netdata. It's where we house our [getting started
119
-guide](/docs/getting-started.md), guides on [running Netdata behind Nginx](/docs/Running-behind-nginx.md), and more.
116
+a direct relationship to a specific component of Netdata.
117
118
If the documentation you're working on doesn't have a direct relaionship to a component of Netdata, it can be placed in
119
this `docs/` folder.
docs/contributing/style-guide.md
+7
-9
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Netdata style guide"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/contributing/style-guide.md
5
----
4
-->
5
6
# Netdata style guide
@@ -112,12 +110,12 @@ Conciseness leads to more accurate and understandable writing.
110
Hyperlinks should clearly state its destination. Don't use words like "here" to describe where a link will take your
111
reader.
112
115
-```
113
+```markdown
114
# Not recommended
117
-To install Netdata, click [here](https://docs.netdata.cloud/packaging/installer/).
115
+To install Netdata, click [here](/packaging/installer/README.md).
116
117
# Recommended
120
-To install Netdata, read our [installation instructions](https://docs.netdata.cloud/packaging/installer/).
118
+To install Netdata, read our [installation instructions](/packaging/installer/README.md).
119
```
120
121
In general, guides should include fewer hyperlinks to keep the reader focused on the task at hand. Documentation should
@@ -321,8 +319,8 @@ reference the label text of the link/button with Markdown's (`**bold text**`) ta
319
Click on the **Sign in** button.
320
```
321
324
-!!! note Whenever possible, avoid using directional language to orient readers, because not every reader can use
325
- instructions like "look at the top-left corner" to find their way around an interface.
322
+> Whenever possible, avoid using directional language to orient readers, because not every reader can use instructions
323
+> like "look at the top-left corner" to find their way around an interface.
324
325
If you feel that you must use directional language, perhaps use an [image](#images) (with proper alt text) instead.
326
@@ -370,8 +368,8 @@ Display line numbers by appending `linenums="1"` after the language declaration,
368
number of your choice. Highlight lines by appending `hl_lines="2"`, replacing `2` with the line you'd like to highlight.
369
Or, multiple lines: `hl_lines="1 2 4 12`.
370
373
-!!! note Line numbers and highlights are not compatible with GitHub's Markdown parser, and thus will only be viewable on
374
- our [documentation site](https://docs.netdata.cloud/). They should be used sparingly and only when necessary.
371
+> Line numbers and highlights are not compatible with GitHub's Markdown parser, and thus will only be viewable on our
372
+> [documentation site](https://learn.netdata.cloud/). They should be used sparingly and only when necessary.
373
374
## Accessibility
375
docs/tutorials/collect-apache-nginx-web-logs.md
+5
-4
@@ -130,8 +130,9 @@ web server's access log and begin showing real-time charts!
130
The web log collector is capable of parsing custom Nginx and Apache log formats and presenting them as charts, but we'll
131
leave that topic for a separate tutorial.
132
133
-We do have [extensive documentation](/collectors/go.d.plugin/modules/weblog/README.md#custom-log-format) on how to build
134
-custom parsing for Nginx and Apache logs.
133
+We do have [extensive
134
+documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/weblog/#custom-log-format) on how
135
+to build custom parsing for Nginx and Apache logs.
136
137
## Tweak web log collector alarms
138
@@ -153,8 +154,8 @@ documentation](/health/README.md).
154
## What's next?
155
156
Now that you have web log collection up and running, we recommend you take a look at the documentation for our
156
-[python.d](/collectors/python.d.plugin/web_log/README.md) for some ideas of how you can turn these rather "boring"
157
-logs into powerful real-time tools for keeping your servers happy.
157
+[python.d](/collectors/python.d.plugin/web_log/README.md) for some ideas of how you can turn these rather "boring" logs
158
+into powerful real-time tools for keeping your servers happy.
159
160
Don't forget to give GitHub user [Wing924](https://github.com/Wing924) a big 👍 for his hard work in starting up the Go
161
refactoring effort.
docs/tutorials/monitor-cockroachdb.md
+3
-2
@@ -9,7 +9,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/docs/tutorials/m
9
10
[CockroachDB](https://github.com/cockroachdb/cockroach) is an open-source project that brings SQL databases into
11
scalable, disaster-resilient cloud deployments. Thanks to a [new CockroachDB
12
-collector](https://docs.netdata.cloud/collectors/go.d.plugin/modules/cockroachdb/) released in
12
+collector](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/) released in
13
[v1.20](https://blog.netdata.cloud/posts/release-1.20/), you can now monitor any number of CockroachDB databases with
14
maximum granularity using Netdata. Collect more than 50 unique metrics and put them on interactive visualizations
15
designed for better visual anomaly detection.
@@ -122,7 +122,8 @@ thoughts.
122
123
Also, be sure to check out these useful resources:
124
125
-- [Netdata's CockroachDB documentation](https://docs.netdata.cloud/collectors/go.d.plugin/modules/cockroachdb/)
125
+- [Netdata's CockroachDB
126
+ documentation](https://learn.netdata.cloud/docs/agent/collectors/go.d.plugin/modules/cockroachdb/)
127
- [Netdata's CockroachDB
128
configuration](https://github.com/netdata/go.d.plugin/blob/master/config/go.d/cockroachdb.conf)
129
- [Netdata's CockroachDB
health/QUICKSTART.md
+1
-1
@@ -37,7 +37,7 @@ cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /et
37
> You may need to use `sudo` or another method of elevating your privileges: `sudo ./edit-config health.d/cpu.conf`.
38
>
39
> You can also use the `$EDITOR` environment variable to use your preferred terminal editor with `edit-config`. See
40
-> [this page](../docs/step-by-step/step-04.md#use-edit-config-to-open-netdataconf) for details.
40
+> [this page](/docs/step-by-step/step-04.md#use-edit-config-to-open-netdataconf) for details.
41
42
Each health configuration file contains one or more health entities, which always begin with an `alarm:` or `template:`
43
line. You can edit these entities based on your needs. To make any changes live, be sure to [reload your health
health/REFERENCE.md
+1
-1
@@ -382,7 +382,7 @@ good idea to tell Netdata to not clear the notification, by using the `no-clear-
382
383
#### Alarm line `host labels`
384
385
-Defines the list of labels present on a host. See our [host labels tutorial](../docs/tutorials/using-host-labels.md) for
385
+Defines the list of labels present on a host. See our [host labels tutorial](/docs/tutorials/using-host-labels.md) for
386
an explanation of host labels and how to implement them.
387
388
For example, let's suppose that `netdata.conf` is configured with the following labels:
health/notifications/awssns/README.md
+3
-1
@@ -20,7 +20,9 @@ To get this working, you will need:
20
21
- The Amazon Web Services CLI tools. Most distributions provide these with the package name `awscli`.
22
- An actual home directory for the user you run Netdata as, instead of just using `/` as a home directory. Setup of this is distribution specific. `/var/lib/netdata` is the recommended directory (because the permissions will already be correct) if you are using a dedicated user (which is how most distributions work).
23
-- An Amazon SNS topic to send notifications to with one or more subscribers. The [Getting Started](https://docs.aws.amazon.com/sns/latest/dg/GettingStarted.html) section of the Amazon SNS documentation covers the basics of how to set this up. Make note of the Topic ARN when you create the topic.
23
+- An Amazon SNS topic to send notifications to with one or more subscribers. The [Getting
24
+ Started](https://docs.aws.amazon.com/sns/latest/dg/sns-getting-started.html) section of the Amazon SNS documentation
25
+ covers the basics of how to set this up. Make note of the Topic ARN when you create the topic.
26
- While not mandatory, it is highly recommended to create a dedicated IAM user on your account for Netdata to send notifications. This user needs to have programmatic access, and should only allow access to SNS. If you're really paranoid, you can create one for each system or group of systems.
27
28
Once you have all the above, run the following command as the user Netdata runs under:
health/notifications/dynatrace/README.md
+4
-6
@@ -1,8 +1,6 @@
1
<!--
2
----
2
title: "Dynatrace"
3
custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notifications/dynatrace/README.md
5
----
4
-->
5
6
# Dynatrace
@@ -22,10 +20,10 @@ This is a required parameter.
20
Generate a Dynatrace API authentication token. On your Dynatrace server, go to **Settings** --> **Integration** --> **Dynatrace API** --> **Generate token**.
21
See [Dynatrace API - Authentication](https://www.dynatrace.com/support/help/extend-dynatrace/dynatrace-api/basics/dynatrace-api-authentication/) for more details.
22
This is a required parameter.
25
-3. API Space. This is the URL part of the page you have access in order to generate the API Token. For example, for my generated API Token the URL is:
26
-https://monitor.illumineit.com/e/2a93fe0e-4cd5-469a-9d0d-1a064235cfce/#settings/integration/apikeys;gf=all
27
-In that case, my space is _2a93fe0e-4cd5-469a-9d0d-1a064235cfce_
28
-This is a required parameter.
23
+3. API Space. This is the URL part of the page you have access in order to generate the API Token. For example, the URL
24
+ for a generated API token might look like:
25
+ `https://monitor.illumineit.com/e/2a93fe0e-4cd5-469a-9d0d-1a064235cfce/#settings/integration/apikeys;gf=all` In that
26
+ case, my space is _2a93fe0e-4cd5-469a-9d0d-1a064235cfce_ This is a required parameter.
27
4. Generate a Server Tag. On your Dynatrace Server, go to **Settings** --> **Tags** --> **Manually applied tags** and create the Tag.
28
The Netdata alarm is sent as a Dynatrace Event to be correlated with all those hosts tagged with this Tag you have created.
29
This is a required parameter.
health/notifications/kavenegar/README.md
+1
-1
@@ -7,7 +7,7 @@ custom_edit_url: https://github.com/netdata/netdata/edit/master/health/notificat
7
8
# Kavenegar
9
10
-[Kavenegar](https://www.kavenegar.com/) as service for software developers, based in Iran, provides send and receive SMS, calling voice by using its APIs.
10
+[Kavenegar](https://kavenegar.com/) as service for software developers, based in Iran, provides send and receive SMS, calling voice by using its APIs.
11
12
Will look like this on your Android device:
13
packaging/installer/UPDATE.md
+5
-4
@@ -95,8 +95,9 @@ First, pull the latest version of the image.
95
docker pull netdata/netdata:latest
96
```
97
98
-Next, to stop and remove any containers using the `netdata/netdata` image. Replace `netdata` if you changed
99
-it from the default in our [Docker installation instructions](../docker/README.md#run-netdata-with-the-docker-command).
98
+Next, to stop and remove any containers using the `netdata/netdata` image. Replace `netdata` if you changed it from the
99
+default in our [Docker installation
100
+instructions](/packaging/docker/README.md#run-the-agent-with-the-docker-command).
101
102
```bash
103
docker stop netdata
@@ -104,8 +105,8 @@ docker rm netdata
105
```
106
107
You can now re-create your Netdata container using the `docker` command or a `docker-compose.yml` file. See our [Docker
107
-installation instructions](../docker/README.md#run-netdata-with-the-docker-command) for details. For example, using the
108
-`docker` command:
108
+installation instructions](/packaging/docker/README.md#run-the-agent-with-the-docker-command) for details. For
109
+example, using the `docker` command:
110
111
```bash
112
docker run -d --name=netdata \
packaging/installer/methods/cloud-providers.md
+5
-5
@@ -58,11 +58,11 @@ command from a remote system, and it fails, it's likely that a firewall is block
58
Another option is to put Netdata behind web server, which will proxy requests through standard HTTP/HTTPS ports
59
(80/443), which are likely already open on your instance. We have a number of guides available:
60
61
-- [Apache](../../../docs/Running-behind-apache.md)
62
-- [Nginx](../../../docs/Running-behind-nginx.md)
63
-- [Caddy](../../../docs/Running-behind-caddy.md)
64
-- [HAProxy](../../../docs/Running-behind-haproxy.md)
65
-- [lighttpd](../../../docs/Running-behind-lighttpd.md)
61
+- [Apache](/docs/Running-behind-apache.md)
62
+- [Nginx](/docs/Running-behind-nginx.md)
63
+- [Caddy](/docs/Running-behind-caddy.md)
64
+- [HAProxy](/docs/Running-behind-haproxy.md)
65
+- [lighttpd](/docs/Running-behind-lighttpd.md)
66
67
The next few sections outline how to add firewall rules to GCP, AWS, and Azure instances.
68
packaging/installer/methods/kickstart.md
+3
-3
@@ -44,7 +44,7 @@ installation. Here are a few important parameters:
44
- `--dont-start-it`: Prevent the installer from starting Netdata automatically.
45
- `--stable-channel`: Automatically update only on the release of new major versions.
46
- `--nightly-channel`: Automatically update on every new nightly build.
47
-- `--disable-telemetry`: Opt-out of [anonymous statistics](../../../docs/anonymous-statistics.md) we use to make
47
+- `--disable-telemetry`: Opt-out of [anonymous statistics](/docs/anonymous-statistics.md) we use to make
48
Netdata better.
49
- `--no-updates`: Prevent automatic updates of any kind.
50
- `--local-files`: Used for [offline installations](offline.md). Pass four file paths: the Netdata
@@ -65,8 +65,8 @@ If the script is valid, this command will return `OK, VALID`.
65
66
## What's next?
67
68
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](../../../docs/step-by-step/step-00.md)
68
+When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
69
for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
70
71
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
72
-guide](../../../docs/getting-started.md) for a quick overview.
72
+guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/macos.md
+3
-3
@@ -56,7 +56,7 @@ to install some of Netdata's prerequisites.
56
brew install ossp-uuid autoconf automake pkg-config libuv lz4 json-c openssl@1.1
57
```
58
59
-If you want to use the [database engine](../../../database/engine/README.md) to store your metrics, you need to download
59
+If you want to use the [database engine](/database/engine/README.md) to store your metrics, you need to download
60
and install the [Judy library](https://sourceforge.net/projects/judy/) before proceeding compiling Netdata.
61
62
Next, download Netdata from our GitHub repository:
@@ -79,8 +79,8 @@ sudo ./netdata-installer.sh --install /usr/local
79
80
## What's next?
81
82
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](../../../docs/step-by-step/step-00.md)
82
+When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
83
for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
84
85
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
86
-guide](../../../docs/getting-started.md) for a quick overview.
86
+guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/manual.md
+2
-2
@@ -216,8 +216,8 @@ In most cases, you can do this by running `CC=gcc ./netdata-installer.sh`.
216
217
## What's next?
218
219
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](../../../docs/step-by-step/step-00.md)
219
+When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
220
for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
221
222
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
223
-guide](../../../docs/getting-started.md) for a quick overview.
223
+guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/offline.md
+2
-2
@@ -76,8 +76,8 @@ bash kickstart.sh --local-files /tmp/netdata-(version-number-here).tar.gz /tmp/s
76
bash kickstart-static64.sh --local-files /tmp/netdata-(version-number-here).gz.run /tmp/sha256sums.txt
77
```
78
79
-Now that Netdata is installed, be sure to visit our [getting started guide](../../../docs/getting-started.md) for a
79
+Now that Netdata is installed, be sure to visit our [getting started guide](/docs/getting-started.md) for a
80
quick overview of configuring Netdata, enabling plugins, and controlling Netdata's daemon.
81
82
Or, get the full guided tour of Netdata's capabilities with our [step-by-step
83
-tutorial](../../../docs/step-by-step/step-00.md)!
83
+tutorial](/docs/step-by-step/step-00.md)!
packaging/installer/methods/packages.md
+2
-2
@@ -50,8 +50,8 @@ If you are using such a setup, there are a couple of ways you can work around th
50
51
## What's next?
52
53
-When you finish installing Netdata, be sure to visit our [step-by-step tutorial](../../../docs/step-by-step/step-00.md)
53
+When you finish installing Netdata, be sure to visit our [step-by-step tutorial](/docs/step-by-step/step-00.md)
54
for a fully-guided tour into Netdata's capabilities and how to configure it according to your needs.
55
56
Or, if you're a monitoring and system administration pro, skip ahead to our [getting started
57
-guide](../../../docs/getting-started.md) for a quick overview.
57
+guide](/docs/getting-started.md) for a quick overview.
packaging/installer/methods/synology.md
+1
-1
@@ -24,7 +24,7 @@ installations run it as the `netdata` user, you might wish to do the same. This
24
2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign
25
the user to the `netdata` group. Netdata will chuid to this user when running.
26
3. Change ownership of the following directories, as defined in [Netdata
27
- Security](../../../docs/netdata-security.md#security-design):
27
+ Security](/docs/netdata-security.md#security-design):
28
29
```sh
30
chown -R root:netdata /opt/netdata/usr/share/netdata
streaming/README.md
+6
-4
@@ -230,8 +230,10 @@ Netdata does not activate TLS encryption by default. To encrypt streaming connec
230
231
The word `SSL` appended to the end of the destination tells the slave that connections must be encrypted.
232
233
-??? info "Differences in TLS and SSL terminology"
234
- While Netdata uses Transport Layer Security (TLS) 1.2 to encrypt communications rather than the obsolete SSL protocol, it's still common practice to refer to encrypted web connections as `SSL`. Many vendors, like Nginx and even Netdata itself, use `SSL` in configuration files, whereas documentation will always refer to encrypted communications as `TLS` or `TLS/SSL`.
233
+> While Netdata uses Transport Layer Security (TLS) 1.2 to encrypt communications rather than the obsolete SSL protocol,
234
+> it's still common practice to refer to encrypted web connections as `SSL`. Many vendors, like Nginx and even Netdata
235
+> itself, use `SSL` in configuration files, whereas documentation will always refer to encrypted communications as `TLS`
236
+> or `TLS/SSL`.
237
238
#### Certificate verification
239
@@ -276,8 +278,8 @@ Now you update the list of certificates running the following, again either as `
278
# update-ca-certificates
279
```
280
279
-!!! note
280
- Some Linux distributions have different methods of updating the certificate list. For more details, please read this guide on [addding trusted root certificates](https://github.com/Busindre/How-to-Add-trusted-root-certificates).
281
+> Some Linux distributions have different methods of updating the certificate list. For more details, please read this
282
+> guide on [addding trusted root certificates](https://github.com/Busindre/How-to-Add-trusted-root-certificates).
283
284
Once you update your certificate list, you can set the stream parameters for Netdata to trust the master certificate. Open `stream.conf` for editing and change the following lines:
285
web/server/README.md
+13
-9
@@ -69,9 +69,12 @@ The API requests are serviced as follows:
69
70
Since v1.16.0, Netdata supports encrypted HTTP connections to the web server, plus encryption of streaming data between a slave and its master, via the TLS protocol.
71
72
-Inbound unix socket connections are unaffected, regardless of the TLS settings.\
73
-??? info "Differences in TLS and SSL terminology"
74
- While Netdata uses Transport Layer Security (TLS) to encrypt communications rather than the obsolete SSL protocol, it's still common practice to refer to encrypted web connections as `SSL`. Many vendors, like Nginx and even Netdata itself, use `SSL` in configuration files, whereas documentation will always refer to encrypted communications as `TLS` or `TLS/SSL`.
72
+Inbound unix socket connections are unaffected, regardless of the TLS settings.
73
+
74
+> While Netdata uses Transport Layer Security (TLS) 1.2 to encrypt communications rather than the obsolete SSL protocol,
75
+> it's still common practice to refer to encrypted web connections as `SSL`. Many vendors, like Nginx and even Netdata
76
+> itself, use `SSL` in configuration files, whereas documentation will always refer to encrypted communications as `TLS`
77
+> or `TLS/SSL`.
78
79
To enable TLS, provide the path to your certificate and private key in the `[web]` section of `netdata.conf`:
80
@@ -89,12 +92,13 @@ For test purposes, you can generate self-signed certificates with the following
92
openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out cert.pem
93
```
94
92
-!!! note
93
- If you use 4096 bits for your key and the certificate, Netdata will need more CPU to process the communication. `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. You can verify the difference by running:
94
-
95
-```sh
96
-openssl speed rsa2048 rsa4096
97
-```
95
+> If you use 4096 bits for your key and the certificate, Netdata will need more CPU to process the communication.
96
+> `rsa4096` can be up to 4 times slower than `rsa2048`, so we recommend using 2048 bits. You can verify the difference
97
+> by running:
98
+>
99
+> ```sh
100
+> openssl speed rsa2048 rsa4096
101
+> ```
102
103
### Select TLS version
104