Improve docker installation readme, docs navbar fix (#4914)
Minor improvements to docker installation readme Bug fix to stop presenting empty links in bash modules Related to #4899
Chris Akritidis committed
Dec 4, 2018 at 12:49 UTC
e75ee0eb6ee95ed7d61f717b77c884cd31a8a6bd
2 files changed
+12
-11
docs/generator/buildyaml.sh
+2
-2
@@ -177,8 +177,8 @@ navpart 3 collectors/macos.plugin
177
navpart 2 collectors/plugins.d "" "External plugins"
178
navpart 3 collectors/python.d.plugin "" "Python modules" 3
179
navpart 3 collectors/node.d.plugin "" "Node.js modules" 3
180
-navpart 3 collectors/charts.d.plugin "" "BASH modules" 3
181
-echo -ne " - 'collectors/charts.d.plugin/README.md'
180
+echo -ne " - BASH modules:
181
+ - 'collectors/charts.d.plugin/README.md'
182
- 'collectors/charts.d.plugin/ap/README.md'
183
- 'collectors/charts.d.plugin/apcupsd/README.md'
184
- 'collectors/charts.d.plugin/example/README.md'
packaging/docker/README.md
+10
-9
@@ -1,7 +1,6 @@
1
# Install netdata with Docker
2
3
-> :warning: As of Sep 9th, 2018 we ship [new docker builds](https://github.com/netdata/netdata/pull/3995), running netdata in docker with an ENTRYPOINT directive, not a COMMAND directive. Please adapt your execution scripts accordingly.
4
-> More information about ENTRYPOINT vs COMMAND is presented by goinbigdata [here](http://goinbigdata.com/docker-run-vs-cmd-vs-entrypoint/) and by docker docs [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
3
+> :warning: As of Sep 9th, 2018 we ship [new docker builds](https://github.com/netdata/netdata/pull/3995), running netdata in docker with an [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, not a COMMAND directive. Please adapt your execution scripts accordingly. You can find more information about ENTRYPOINT vs COMMAND is presented by goinbigdata [here](http://goinbigdata.com/docker-run-vs-cmd-vs-entrypoint/) and by docker docs [here](https://docs.docker.com/engine/reference/builder/#understand-how-cmd-and-entrypoint-interact).
4
>
5
> Also, the `latest` is now based on alpine, so **`alpine` is not updated any more** and `armv7hf` is now replaced with `armhf` (to comply with https://github.com/multiarch naming), so **`armv7hf` is not updated** either.
6
@@ -16,8 +15,6 @@ Netdata is then available at http://host:19999
15
16
This is good for an internal network or to quickly analyse a host.
17
19
-For a permanent installation on a public server, you should [[secure the netdata instance|netdata-security]]. See below for an example of how to install netdata with an SSL reverse proxy and basic authentication.
20
-
18
```bash
19
docker run -d --name=netdata \
20
-p 19999:19999 \
@@ -29,7 +26,7 @@ docker run -d --name=netdata \
26
netdata/netdata
27
```
28
32
-above can be converted to docker-compose file for ease of management:
29
+The above can be converted to docker-compose file for ease of management:
30
31
```yaml
32
version: '3'
@@ -56,10 +53,15 @@ If you want to have your container names resolved by netdata it needs to have ac
53
grep docker /etc/group | cut -d ':' -f 3
54
```
55
56
+### Pass command line options to Netdata
57
+
58
+Since we use an [ENTRYPOINT](https://docs.docker.com/engine/reference/builder/#entrypoint) directive, you can provide [netdata daemon command line options](https://docs.netdata.cloud/daemon/#command-line-options) such as the IP address netdata will be running on, using the [command instruction](https://docs.docker.com/engine/reference/builder/#cmd).
59
+
60
## Install Netdata using Docker Compose with SSL/TLS enabled http proxy
61
61
-You can use use the following docker-compose.yml and Caddyfile files to run netdata with docker.
62
-Replace the Domains and email address for Letsencrypt before starting.
62
+For a permanent installation on a public server, you should [secure the netdata instance](../../docs/netdata-security.md). This section contains an example of how to install netdata with an SSL reverse proxy and basic authentication.
63
+
64
+You can use use the following docker-compose.yml and Caddyfile files to run netdata with docker. Replace the Domains and email address for [Letsencrypt](https://letsencrypt.org/) before starting.
65
66
### Prerequisites
67
* [Docker](https://docs.docker.com/install/#server)
@@ -68,8 +70,7 @@ Replace the Domains and email address for Letsencrypt before starting.
70
71
### Caddyfile
72
71
-This file needs to be placed in /opt with nams Caddyfile. Here you customize your domain and you need to provide your email address to obtain Letsencrypt certificate.
72
-Certificate renewal will happen automatically and will be executed internally by caddy server.
73
+This file needs to be placed in /opt with name `Caddyfile`. Here you customize your domain and you need to provide your email address to obtain a Letsencrypt certificate. Certificate renewal will happen automatically and will be executed internally by the caddy server.
74
75
```
76
netdata.example.org {