@cryptotaxi247 / netdata-1 / commits / 2cd5f0800

Remove Dollar sign from Bash code in documentation and fix remark-lint warnings (#6880)

* remove dollar sign from bash code * remove dollar sign from sh * clean up uninstall doc * remove dollar sign from shell code * fix remark after removing dollar sign * fix HAProxy dollar sign and clean up remark

Promise Akpan committed Sep 18, 2019 at 16:57 UTC 2cd5f08007479b299954e60281afa9d961adfbc9

7 files changed +148 -83

collectors/charts.d.plugin/apache/README.md

+2 -2

@@ -26,7 +26,7 @@ It has been tested with apache 2.2 and apache 2.4. The latter also provides conn

26 Apache 2.2 response:

28 ```sh

29 -$ curl "http://127.0.0.1/server-status?auto"

29 +curl "http://127.0.0.1/server-status?auto"

30 Total Accesses: 80057

31 Total kBytes: 223017

32 CPULoad: .018287

@@ -42,7 +42,7 @@ Scoreboard: _________________________......................................._W__

42 Apache 2.4 response:

44 ```sh

45 -$ curl "http://127.0.0.1/server-status?auto"

45 +curl "http://127.0.0.1/server-status?auto"

46 127.0.0.1

47 ServerVersion: Apache/2.4.18 (Unix)

48 ServerMPM: event

docs/Running-behind-haproxy.md

+28 -21

@@ -1,16 +1,21 @@

1 # Netdata via HAProxy

3 -> HAProxy is a free, very fast and reliable solution offering high availability, load balancing, and proxying for TCP and HTTP-based applications. It is particularly suited for very high traffic web sites and powers quite a number of the world's most visited ones.

3 +> HAProxy is a free, very fast and reliable solution offering high availability, load balancing,

4 +> and proxying for TCP and HTTP-based applications. It is particularly suited for very high traffic web sites

5 +> and powers quite a number of the world's most visited ones.

5 -If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name can be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to connect to Netdata at <https://example.com> or <https://example.com/netdata/>, which is a much nicer experience then <http://example.com:19999>.

7 +If Netdata is running on a host running HAProxy, rather than connecting to Netdata from a port number, a domain name

8 +can be pointed at HAProxy, and HAProxy can redirect connections to the Netdata port. This can make it possible to

9 +connect to Netdata at <https://example.com> or <https://example.com/netdata/>, which is a much nicer experience then <http://example.com:19999>.

7 -To proxy requests from [HAProxy](https://github.com/haproxy/haproxy) to Netdata, the following configuration can be used:

11 +To proxy requests from [HAProxy](https://github.com/haproxy/haproxy) to Netdata,

12 +the following configuration can be used:

14 ## Default Configuration

16 For all examples, set the mode to `http`

13 -```

18 +```conf

19 defaults

20 mode http

21 ```

@@ -23,7 +28,7 @@ A simple example where the base URL, say <http://example.com>, is used with no s

29 Create a frontend to recieve the request.

26 -```

31 +```conf

32 frontend http_frontend

33 ## HTTP ipv4 and ipv6 on all ips ##

34 bind :::80 v4v6

@@ -35,7 +40,7 @@ frontend http_frontend

41 Create the Netdata backend which will send requests to port `19999`.

38 -```

43 +```conf

44 backend netdata_backend

45 option forwardfor

46 server netdata_local 127.0.0.1:19999

@@ -54,7 +59,7 @@ A example where the base URL is used with a subpath `/netdata/`:

60 To use a subpath, create an ACL, which will set a variable based on the subpath.

57 -```

62 +```conf

63 frontend http_frontend

64 ## HTTP ipv4 and ipv6 on all ips ##

65 bind :::80 v4v6

@@ -77,7 +82,7 @@ frontend http_frontend

83 Same as simple example, expept remove `/netdata/` with regex.

80 -```

85 +```conf

86 backend netdata_backend

87 option forwardfor

88 server netdata_local 127.0.0.1:19999

@@ -92,13 +97,14 @@ backend netdata_backend

98 ## Using TLS communication

95 -TLS can be used by adding port `443` and a cert to the frontend. This example will only use Netdata if host matches example.com (replace with your domain).

100 +TLS can be used by adding port `443` and a cert to the frontend.

101 +This example will only use Netdata if host matches example.com (replace with your domain).

102

103 ### Frontend

104

105 This frontend uses a certificate list.

106

101 -```

107 +```conf

108 frontend https_frontend

109 ## HTTP ##

110 bind :::80 v4v6

@@ -123,14 +129,15 @@ In the cert list file place a mapping from a certificate file to the domain used

129

130 `/etc/letsencrypt/certslist.txt`:

131

126 -```

132 +```txt

133 example.com /etc/letsencrypt/live/example.com/example.com.pem

134 ```

135

130 -The file `/etc/letsencrypt/live/example.com/example.com.pem` should contain the key and certificate (in that order) concatenated into a `.pem` file.:

136 +The file `/etc/letsencrypt/live/example.com/example.com.pem` should contain the key and

137 +certificate (in that order) concatenated into a `.pem` file.:

138

132 -```

133 -$ cat /etc/letsencrypt/live/example.com/fullchain.pem \

139 +```sh

140 +cat /etc/letsencrypt/live/example.com/fullchain.pem \

141 /etc/letsencrypt/live/example.com/privkey.pem > \

142 /etc/letsencrypt/live/example.com/example.com.pem

143 ```

@@ -139,7 +146,7 @@ $ cat /etc/letsencrypt/live/example.com/fullchain.pem \

146

147 Same as simple, except set protocol `https`.

148

142 -```

149 +```conf

150 backend netdata_backend

151 option forwardfor

152 server netdata_local 127.0.0.1:19999

@@ -155,7 +162,7 @@ backend netdata_backend

162

163 To use basic HTTP Authentication, create a authentication list:

164

158 -```

165 +```conf

166 # HTTP Auth

167 userlist basic-auth-list

168 group is-admin

@@ -165,20 +172,20 @@ userlist basic-auth-list

172

173 You can create a hashed password using the `mkpassword` utility.

174

168 -```

169 -$ printf "passwordhere" | mkpasswd --stdin --method=sha-256

175 +```sh

176 + printf "passwordhere" | mkpasswd --stdin --method=sha-256

177 $5$l7Gk0VPIpKO$f5iEcxvjfdF11khw.utzSKqP7W.0oq8wX9nJwPLwzy1

178 ```

179

180 Replace `passwordhere` with hash:

181

175 -```

182 +```conf

183 user admin password $5$l7Gk0VPIpKO$f5iEcxvjfdF11khw.utzSKqP7W.0oq8wX9nJwPLwzy1 groups is-admin

184 ```

185

186 Now add at the top of the backend:

187

181 -```

188 +```conf

189 acl devops-auth http_auth_group(basic-auth-list) is-admin

190 http-request auth realm netdata_local unless devops-auth

191 ```

@@ -187,7 +194,7 @@ http-request auth realm netdata_local unless devops-auth

194

195 Full example configuration with HTTP auth over TLS with subpath:

196

190 -```

197 +```conf

198 global

199 maxconn 20000

200

docs/contributing/contributing-documentation.md

+91 -40

@@ -1,12 +1,19 @@

1 # Contributing to documentation

3 -We welcome contributions to Netdata's already extensive documentation, which we host at [docs.netdata.cloud](https://docs.netdata.cloud/) and store inside of the [main repository](https://github.com/netdata/netdata) on GitHub.

3 +We welcome contributions to Netdata's already extensive documentation,

4 +which we host at [docs.netdata.cloud](https://docs.netdata.cloud/)

5 +and store inside of the [main repository](https://github.com/netdata/netdata) on GitHub.

5 -Like all contributing to all other aspects of Netdata, we ask that anyone who wants to help with documentation read and abide by the [Contributor Convenant Code of Conduct](https://docs.netdata.cloud/code_of_conduct/) and follow the instructions outlined in our [Contributing document](../../CONTRIBUTING.md).

7 +Like all contributing to all other aspects of Netdata, we ask that anyone who wants to help with documentation

8 +read and abide by the [Contributor Convenant Code of Conduct](https://docs.netdata.cloud/code_of_conduct/)

9 +and follow the instructions outlined in our [Contributing document](../../CONTRIBUTING.md).

7 -We also ask you to read our [documentation style guide](style-guide.md), which, while not complete, will give you some guidance on how we write and organize our documentation.

11 +We also ask you to read our [documentation style guide](style-guide.md), which, while not complete,

12 +will give you some guidance on how we write and organize our documentation.

9 -All our documentation uses the Markdown syntax. If you're not familiar with how it works, please read the [Markdown introduction post](https://daringfireball.net/projects/markdown/) by its creator, followed by [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub.

14 +All our documentation uses the Markdown syntax. If you're not familiar with how it works,

15 +please read the [Markdown introduction post](https://daringfireball.net/projects/markdown/) by its creator,

16 +followed by [Mastering Markdown](https://guides.github.com/features/mastering-markdown/) guide from GitHub.

18 ## How contributing to the documentation works

@@ -15,11 +22,17 @@ There are two ways to contribute to Netdata's documentation:

22 1. Edit documentation [directly in GitHub](#edit-documentation-directly-on-gitHub).

23 2. Download the repository and [edit documentation locally](#edit-documentation-locally).

18 -Editing in GitHub is a simpler process and is perfect for quick edits to a single document, such as fixing a typo or clarifying a confusing sentence.

25 +Editing in GitHub is a simpler process and is perfect for quick edits to a single document,

26 +such as fixing a typo or clarifying a confusing sentence.

20 -Editing locally is more complex, as you need to download the Netdata repository and build the documentation using `mkdocs`, but allows you to better organize complex projects. By building documentation locally, you can preview your work using a local web server before you submit your PR.

28 +Editing locally is more complex, as you need to download the Netdata repository

29 +and build the documentation using `mkdocs`, but allows you to better organize complex projects.

30 +By building documentation locally, you can preview your work using a local web server before you submit your PR.

22 -In both cases, you'll finish by submitting a pull request (PR). Once you submit your PR, GitHub will initiate a number of jobs, including a Netlify preview. You can use this preview to view the documentation site with your changes applied, which might help you catch any lingering issues.

32 +In both cases, you'll finish by submitting a pull request (PR).

33 +Once you submit your PR, GitHub will initiate a number of jobs, including a Netlify preview.

34 +You can use this preview to view the documentation site with your changes applied,

35 +which might help you catch any lingering issues.

37 To continue, follow one of the paths below:

@@ -28,109 +41,147 @@ To continue, follow one of the paths below:

42 ## Edit documentation directly on GitHub

31 -Start editing documentation on GitHub by clicking the small pencil icon on any page on Netdata's [documentation site](https://docs.netdata.cloud/). You can find them at the top of every page.

44 +Start editing documentation on GitHub by clicking the small pencil icon on any page on Netdata's [documentation site](https://docs.netdata.cloud/).

45 +You can find them at the top of every page.

33 -Clicking on this icon will take you to the associated page in the `netdata/netdata` repository. Then click the small pencil icon on any documentation file (those ending in the `.md` [Markdown] extension) in the `netdata/netdata` repository.

47 +Clicking on this icon will take you to the associated page in the `netdata/netdata` repository.

48 +Then click the small pencil icon on any documentation file (those ending in the `.md` [Markdown] extension) in the `netdata/netdata` repository.

50 ![A screenshot of editing a Markdown file directly in the Netdata repository](https://user-images.githubusercontent.com/1153921/59637188-10426d00-910a-11e9-99f2-ec564d6fb7d5.png)

37 -If you know where a file resides in the Netdata repository already, you can skip the step of beginning on the documentation site and go directly to GitHub.

52 +If you know where a file resides in the Netdata repository already,

53 +you can skip the step of beginning on the documentation site and go directly to GitHub.

39 -Once you've clicked the pencil icon on GitHub, you'll see a full Markdown version of the file. Make changes as you see fit. You can use the `Preview changes` button to ensure your Markdown syntax is working properly.

55 +Once you've clicked the pencil icon on GitHub, you'll see a full Markdown version of the file.

56 +Make changes as you see fit.

57 +You can use the `Preview changes` button to ensure your Markdown syntax is working properly.

41 -Under the `Propose file change` header, write in a descriptive title for your requested change. Beneath that, add a concise descrition of what you've changed and why you think it's important. Then, click the `Propose file change` button.

59 +Under the `Propose file change` header, write in a descriptive title for your requested change.

60 +Beneath that, add a concise descrition of what you've changed and why you think it's important. Then, click the `Propose file change` button.

43 -After you've hit that button, jump down to our instructions on [pull requests and cleanup](#pull-requests-and-final-steps) for your next steps.

62 +After you've hit that button,

63 +jump down to our instructions on [pull requests and cleanup](#pull-requests-and-final-steps) for your next steps.

65 !!! note

46 - This process will create a branch directly on the `netdata/netdata` repository, which then requires manual cleanup. If you're going to make significant documentation contributions, or contribute often, we recommend the local editing process just below.

66 + This process will create a branch directly on the `netdata/netdata` repository, which then requires manual cleanup.

67 + If you're going to make significant documentation contributions, or contribute often,

68 + we recommend the local editing process just below.

70 ## Edit documentation locally

50 -Editing documentation locally is the preferred method for complex changes, PRs that span across multiple documents, or those that change the styling or underlying functionality of the documentation.

72 +Editing documentation locally is the preferred method for complex changes, PRs that span across multiple documents,

73 +or those that change the styling or underlying functionality of the documentation.

52 -Here is the workflow for editing documentation locally. First, create a fork of the Netdata repository, if you don't have one already. Visit the [Netdata repository](https://github.com/netdata/netdata) and click on the `Fork` button in the upper-right corner of the window.

75 +Here is the workflow for editing documentation locally. First, create a fork of the Netdata repository,

76 +if you don't have one already. Visit the [Netdata repository](https://github.com/netdata/netdata)

77 +and click on the `Fork` button in the upper-right corner of the window.

79 ![Screenshot of forking the Netdata repository](https://user-images.githubusercontent.com/1153921/59873572-25f5a380-9351-11e9-92a4-a681fe4a2ed9.png)

56 -GitHub will ask you where you want to clone the repository, and once finished you'll end up at the index of your forked Netdata repository. Clone your fork to your local machine:

81 +GitHub will ask you where you want to clone the repository,

82 +and once finished you'll end up at the index of your forked Netdata repository.

83 +Clone your fork to your local machine:

85 ```bash

59 -$ git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git

86 +git clone https://github.com/YOUR-GITHUB-USERNAME/netdata.git

87 ```

89 You can now jump into the directory and explore Netdata's structure for yourself.

91 ### Understanding the structure of Netdata's documentation

66 -All of Netdata's documentation is stored within the repository itself, as close as possible to the code it corresponds to. Many sub-folders contain a `README.md` file, which is then used to populate the documentation about that feature/component of Netdata.

93 +All of Netdata's documentation is stored within the repository itself, as close as possible to the code it

94 +corresponds to. Many sub-folders contain a `README.md` file,

95 +which is then used to populate the documentation about that feature/component of Netdata.

68 -For example, the file at `packaging/installer/README.md` becomes `https://docs.netdata.cloud/packaging/installer/` and is our installation documentation. By co-locating it with quick-start installtion code, we ensure documentation is always tightly knit with the functions it describes.

97 +For example, the file at `packaging/installer/README.md` becomes `https://docs.netdata.cloud/packaging/installer/`

98 +and is our installation documentation. By co-locating it with quick-start installtion code,

99 +we ensure documentation is always tightly knit with the functions it describes.

100

70 -You might find other `.md` files within these directories. The `packaging/installer/` folder also contains `UPDATE.md` and `UNINSTALL.md`, which become `https://docs.netdata.cloud/packaging/installer/update/` and `https://docs.netdata.cloud/packaging/installer/uninstall/`, respectively.

101 +You might find other `.md` files within these directories. The `packaging/installer/` folder also contains `UPDATE.md`

102 +and `UNINSTALL.md`, which become `https://docs.netdata.cloud/packaging/installer/update/`

103 +and `https://docs.netdata.cloud/packaging/installer/uninstall/`, respectively.

104

72 -If the documentation you're working on has a direct correlation to some component of Netdata, place it into the correct folder and either name it `README.md` for generic documentation, or with another name for very specific instructions.

105 +If the documentation you're working on has a direct correlation to some component of Netdata, place it into the correct

106 +folder and either name it `README.md` for generic documentation, or with another name for very specific instructions.

107

108 #### The `docs` folder

109

76 -At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not have a direct relationship to a specific component of Netdata. It's where we house our [getting started guide](../GettingStarted.md), guides on [running Netdata behind Nginx](../Running-behind-nginx.md), and more.

110 +At the root of the Netdata repository is a `docs/` folder. Inside this folder we place documentation that does not

111 +have a direct relationship to a specific component of Netdata. It's where we house our [getting started guide](../GettingStarted.md),

112 +guides on [running Netdata behind Nginx](../Running-behind-nginx.md), and more.

113

78 -If the documentation you're working on doesn't have a direct relaionship to a component of Netdata, it can be placed in this `docs/` folder.

114 +If the documentation you're working on doesn't have a direct relaionship to a component of Netdata,

115 +it can be placed in this `docs/` folder.

116

117 ### Make your edits

118

82 -Now that you're set up and understand where to find or create your `.md` file, you can now begin to make your edits. Just use your favorite editor and keep in mind our [style guide](style-guide.md) as you work.

119 +Now that you're set up and understand where to find or create your `.md` file, you can now begin to make your edits.

120 +Just use your favorite editor and keep in mind our [style guide](style-guide.md) as you work.

121

84 -If you add a new file to the documentation, you may need to modify the `buildyaml.sh` file to ensure it's added to the site's navigation. This is true for any file added to the `docs/` folder.

122 +If you add a new file to the documentation, you may need to modify the `buildyaml.sh` file to ensure

123 +it's added to the site's navigation. This is true for any file added to the `docs/` folder.

124

86 -Be sure to periodically add/commit your edits so that you don't lose your work! We use version control software for a reason.

125 +Be sure to periodically add/commit your edits so that you don't lose your work!

126 +We use version control software for a reason.

127

128 ### Build the documentation

129

90 -Building the documentation periodically gives you a glimpse into the final product, and is generally required if you're making changes to the table of contents.

130 +Building the documentation periodically gives you a glimpse into the final product, and is generally required

131 +if you're making changes to the table of contents.

132

133 !!! attention ""

93 - We have only tested the build process on Linux. Initial tests on OS X have been unsuccessful. Windows is fully untested at this point, but we would love to know if it works there as well!

134 + We have only tested the build process on Linux. Initial tests on OS X have been unsuccessful.

135 + Windows is fully untested at this point, but we would love to know if it works there as well!

136

137 To build the documentation, you need `python`/`pip`, `mkdocs`, and `mkdocs-material` installed on your machine.

138

139 Follow the [Python installation instructions](https://www.python.org/downloads/) for your machine.

140

99 -Use `pip`, which was installed alongside Python, to install `mkdocs` and `mkdocs-material`. Your operating system might force you to use `pip2` or `pip3` instead, dependin on which version of Python you have installed.

141 +Use `pip`, which was installed alongside Python, to install `mkdocs` and `mkdocs-material`.

142 +Your operating system might force you to use `pip2` or `pip3` instead,

143 +dependin on which version of Python you have installed.

144

145 ```bash

102 -$ pip install mkdocs mkdocs-material

146 +pip install mkdocs mkdocs-material

147 ```

148

149 ??? note "Troubleshooting"

150 If you're having trouble with the installation of Python, `mkdocs`, or `mkdocs-material`, try looking into the `mkdocs` [installation instructions](https://squidfunk.github.io/mkdocs-material/getting-started/#installation).

151

108 -When `pip` is finished installing, navigate to the root directory of the Netdata repository and run the documentation generator script.

152 +When `pip` is finished installing, navigate to the root directory of the Netdata repository

153 +and run the documentation generator script.

154

155 ```bash

111 -$ sh docs/generator/buildhtml.sh

156 +sh docs/generator/buildhtml.sh

157 ```

158

159 This process will take some time. Once finished, the built documentation site will be located at `docs/generator/build/`.

160

161 ### Run a local web server to test documentation

162

118 -The best way to view the documentation site you just built is to run a simple web server from the `docs/generator/build/` directory. So, navigate there and run a Python-based web server:

163 +The best way to view the documentation site you just built is to run a simple web server from the `docs/generator/build/` directory.

164 +So, navigate there and run a Python-based web server:

165

120 -```

121 -$ cd docs/generator/build/

122 -$ python3 -m http.server 20000

166 +```sh

167 +cd docs/generator/build/

168 +python3 -m http.server 20000

169 ```

170

171 Feel free to replace the port number you want this web server to listen on (port `20000` in this case [only one higher than the agent!]).

172

127 -Open your web browser and navigate to `http://localhost:20000`. If you replaced the port earlier, change it here as well. You can now navigate through the documentation as you would on the live site!

173 +Open your web browser and navigate to `http://localhost:20000`.

174 +If you replaced the port earlier, change it here as well.

175 +You can now navigate through the documentation as you would on the live site!

176

177 ## Pull requests and final steps

178

131 -When you're finished with your changes, add and commit them to your fork of the Netdata repository. Head over to GitHub to create your pull request (PR).

179 +When you're finished with your changes, add and commit them to your fork of the Netdata repository.

180 +Head over to GitHub to create your pull request (PR).

181

133 -Once we receive your pull request (PR), we'll take time to read through it and assess it for correctness, conciseness, and overall quality. We may point to specific sections and ask for additional information or other fixes.

182 +Once we receive your pull request (PR), we'll take time to read through it and assess it for correctness, conciseness,

183 +and overall quality.

184 +We may point to specific sections and ask for additional information or other fixes.

185

186 ## What's next

187

packaging/installer/README.md

+7 -7

@@ -33,7 +33,7 @@ This method is **fully automatic on all Linux distributions**. FreeBSD and MacOS

33 To install Netdata from source, and keep it up to date with our **nightly releases** automatically, run the following:

35 ```bash

36 -$ bash <(curl -Ss https://my-netdata.io/kickstart.sh)

36 +bash <(curl -Ss https://my-netdata.io/kickstart.sh)

37 ```

39 !!! note

@@ -72,7 +72,7 @@ The `kickstart.sh` script passes all its parameters to `netdata-installer.sh`, s

72 Example using all the above parameters:

74 ```bash

75 -$ bash <(curl -Ss https://my-netdata.io/kickstart.sh) --dont-wait --dont-start-it --no-updates --stable-channel --local-files /tmp/my-selfdownloaded-tarball.tar.gz /tmp/checksums.txt /tmp/manually.downloaded.go.d.binary.tar.gz /tmp/manually.downloaded.go.d.config.tar.gz

75 +bash <(curl -Ss https://my-netdata.io/kickstart.sh) --dont-wait --dont-start-it --no-updates --stable-channel --local-files /tmp/my-selfdownloaded-tarball.tar.gz /tmp/checksums.txt /tmp/manually.downloaded.go.d.binary.tar.gz /tmp/manually.downloaded.go.d.config.tar.gz

76 ```

77 Note: `--stable-channel` and `--local-files` overlap, if you use the tarball override the stable channel option is not effective

78 </details>

@@ -90,7 +90,7 @@ You can install a pre-compiled static binary of Netdata on any Intel/AMD 64bit L

90 To install Netdata from a binary package on any Linux distro and any kernel version on **Intel/AMD 64bit** systems, and keep it up to date with our **nightly releases** automatically, run the following:

92 ```bash

93 -$ bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh)

93 +bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh)

94 ```

96 !!! note

@@ -125,7 +125,7 @@ The `kickstart-static64.sh` script passes all its parameters to `netdata-install

125 Example using all the above parameters:

126

127 ```sh

128 -$ bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) --dont-wait --dont-start-it --no-updates --stable-channel --local-files /tmp/my-selfdownloaded-tarball.tar.gz /tmp/checksums.txt

128 +bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) --dont-wait --dont-start-it --no-updates --stable-channel --local-files /tmp/my-selfdownloaded-tarball.tar.gz /tmp/checksums.txt

129 ```

130 Note: `--stable-channel` and `--local-files` overlap, if you use the tarball override the stable channel option is not effective

131

@@ -472,9 +472,9 @@ When Netdata is first installed, it will run as *root*. This may or may not be a

472 3. Change ownership of the following directories, as defined in [Netdata Security](../../docs/netdata-security.md#security-design):

473

474 ```sh

475 -$ chown -R root:netdata /opt/netdata/usr/share/netdata

476 -$ chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/netdata

477 -$ chown -R netdata:root /opt/netdata/var/log/netdata

475 +chown -R root:netdata /opt/netdata/usr/share/netdata

476 +chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/netdata

477 +chown -R netdata:root /opt/netdata/var/log/netdata

478 ```

479

480 Additionally, as of 2018/06/24, the Netdata installer doesn't recognize DSM as an operating system, so no init script is installed. You'll have to do this manually:

packaging/installer/UNINSTALL.md

+13 -6

@@ -1,8 +1,14 @@

1 # Uninstalling Netdata

3 -Our self-contained uninstaller is able to remove Netdata installations created with shell installer. It doesn't need any other Netdata repository files to be run. All it needs is an .environment file, which is created during installation (with shell installer) and put in ${NETDATA_USER_CONFIG_DIR}/.environment (by default /etc/netdata/.environment). That file contains some parameters which are passed to our installer and which are needed during uninstallation process. Mainly two parameters are needed:

3 +Our self-contained uninstaller is able to remove Netdata installations created with shell installer.

4 +It doesn't need any other Netdata repository files to be run.

5 +All it needs is an `.environment` file, which is created during installation (with shell installer)

6 +and put in `${NETDATA_USER_CONFIG_DIR}/.environment` (by default `/etc/netdata/.environment`).

7 +That file contains some parameters which are passed to our installer

8 +and which are needed during uninstallation process.

9 +Mainly two parameters are needed:

5 -```

11 +```sh

12 NETDATA_PREFIX

13 NETDATA_ADDED_TO_GROUPS

14 ```

@@ -10,16 +16,16 @@ NETDATA_ADDED_TO_GROUPS

16 A workflow for uninstallation looks like this:

18 1. Find your `.environment` file, which is usually `/etc/netdata/.environment` in a default installation.

13 -2. If you cannot find that file and would like to uninstall Netdata, then create new file with following content:

19 +2. If you cannot find that file and would like to uninstall Netdata, then create a new file with the following content:

15 -```

21 +```sh

22 NETDATA_PREFIX="<installation prefix>" # put what you used as a parameter to shell installed `--install` flag. Otherwise it should be empty

23 NETDATA_ADDED_TO_GROUPS="<additional groups>" # Additional groups for a user running the Netdata process

24 ```

26 3. Run `netdata-uninstaller.sh` as follows

22 -```

28 +```sh

29 ${NETDATA_PREFIX}/usr/libexec/netdata/netdata-uninstaller.sh --yes --env <environment_file>

30 ```

@@ -34,6 +40,7 @@ chmod +x ./netdata-uninstaller.sh

41 The default `environment_file` is `/etc/netdata/.environment`.

37 -Note: This uninstallation method assumes previous installation with `netdata-installer.sh` or the kickstart script. Currently using it when Netdata was installed by a package manager can work or cause unexpected results.

43 +Note: This uninstallation method assumes previous installation with `netdata-installer.sh` or the kickstart script.

44 +Currently using it when Netdata was installed by a package manager can work or cause unexpected results.

46 [![analytics](https://www.google-analytics.com/collect?v=1&aip=1&t=pageview&_s=1&ds=github&dr=https%3A%2F%2Fgithub.com%2Fnetdata%2Fnetdata&dl=https%3A%2F%2Fmy-netdata.io%2Fgithub%2Finstaller%2FUNINSTALL&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)

web/api/formatters/json/README.md

+1 -1

@@ -103,7 +103,7 @@ callback({

103 > Using `format=datatable` and `options=`

104

105 ```bash

106 -$ curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&formdatatable&options='

106 +curl -Ss 'https://registry.my-netdata.io/api/v1/data?chart=nginx_local.connections&after=-3600&points=6&group=average&formdatatable&options='

107 {

108 "cols":

109 [

web/server/README.md

+6 -6

@@ -79,14 +79,14 @@ Both files must be readable by the `netdata` user. If either of these files do n

79 For test purposes, you can generate self-signed certificates with the following command:

81 ```bash

82 -$ openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out cert.pem

82 +openssl req -newkey rsa:2048 -nodes -sha512 -x509 -days 365 -keyout key.pem -out cert.pem

83 ```

85 !!! note

86 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:

88 ```sh

89 -$ openssl speed rsa2048 rsa4096

89 +openssl speed rsa2048 rsa4096

90 ```

92 #### TLS/SSL enforcement

@@ -98,11 +98,11 @@ When the certificates are defined and unless any other options are provided, a N

99 To change this behavior, you need to modify the `bind to` setting in the `[web]` section of `netdata.conf`. At the end of each port definition, you can append `^SSL=force` or `^SSL=optional`. What happens with these settings differs, depending on whether the port is used for HTTP/S requests, or for streaming.

100

102 |:---------:|:-----------:|:------------:|:-----------------:|:----------------|

106

107 Example:

108