summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorChris Akritidis <43294513+cakrit@users.noreply.github.com>2018-12-04 12:49:42 +0100
committerGitHub <noreply@github.com>2018-12-04 12:49:42 +0100
commite75ee0eb6ee95ed7d61f717b77c884cd31a8a6bd (patch)
treeffbd5612ad9b536fe48e8fbf38d6c2d6c052e848
parent1f58dd308accf31fb241cc3f687de62ee66999cc (diff)
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
-rwxr-xr-xdocs/generator/buildyaml.sh4
-rw-r--r--packaging/docker/README.md19
2 files changed, 12 insertions, 11 deletions
diff --git a/docs/generator/buildyaml.sh b/docs/generator/buildyaml.sh
index debbdd6f3f..81ad77bba7 100755
--- a/docs/generator/buildyaml.sh
+++ b/docs/generator/buildyaml.sh
@@ -177,8 +177,8 @@ navpart 3 collectors/macos.plugin
navpart 2 collectors/plugins.d "" "External plugins"
navpart 3 collectors/python.d.plugin "" "Python modules" 3
navpart 3 collectors/node.d.plugin "" "Node.js modules" 3
-navpart 3 collectors/charts.d.plugin "" "BASH modules" 3
-echo -ne " - 'collectors/charts.d.plugin/README.md'
+echo -ne " - BASH modules:
+ - 'collectors/charts.d.plugin/README.md'
- 'collectors/charts.d.plugin/ap/README.md'
- 'collectors/charts.d.plugin/apcupsd/README.md'
- 'collectors/charts.d.plugin/example/README.md'
diff --git a/packaging/docker/README.md b/packaging/docker/README.md
index d624855fb7..357888911c 100644
--- a/packaging/docker/README.md
+++ b/packaging/docker/README.md
@@ -1,7 +1,6 @@
# Install netdata with Docker
-> :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.
-> 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).
+> :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).
>
> 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.
@@ -16,8 +15,6 @@ Netdata is then available at http://host:19999
This is good for an internal network or to quickly analyse a host.
-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.
-
```bash
docker run -d --name=netdata \
-p 19999:19999 \
@@ -29,7 +26,7 @@ docker run -d --name=netdata \
netdata/netdata
```
-above can be converted to docker-compose file for ease of management:
+The above can be converted to docker-compose file for ease of management:
```yaml
version: '3'
@@ -56,10 +53,15 @@ If you want to have your container names resolved by netdata it needs to have ac
grep docker /etc/group | cut -d ':' -f 3
```
+### Pass command line options to Netdata
+
+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).
+
## Install Netdata using Docker Compose with SSL/TLS enabled http proxy
-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 before starting.
+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.
+
+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.
### Prerequisites
* [Docker](https://docs.docker.com/install/#server)
@@ -68,8 +70,7 @@ Replace the Domains and email address for Letsencrypt before starting.
### Caddyfile
-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.
-Certificate renewal will happen automatically and will be executed internally by caddy server.
+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.
```
netdata.example.org {