summaryrefslogtreecommitdiffstats
path: root/libnetdata/config/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'libnetdata/config/README.md')
-rw-r--r--libnetdata/config/README.md19
1 files changed, 10 insertions, 9 deletions
diff --git a/libnetdata/config/README.md b/libnetdata/config/README.md
index f0a27d951..51216b6db 100644
--- a/libnetdata/config/README.md
+++ b/libnetdata/config/README.md
@@ -1,6 +1,6 @@
-# netdata ini config files
+# Netdata ini config files
-Configuration files `netdata.conf` and `stream.conf` are netdata ini files.
+Configuration files `netdata.conf` and `stream.conf` are Netdata ini files.
## Motivation
@@ -17,9 +17,9 @@ developers and the users.
So, we did this:
-1. No configuration is required to run netdata
-2. There are plenty of options to tweak
-3. There is minimal documentation (or no at all)
+1. No configuration is required to run Netdata
+2. There are plenty of options to tweak
+3. There is minimal documentation (or no at all)
## Why this works?
@@ -33,11 +33,12 @@ In all places, in the code, there are both the `names` and their
file, the default is used. The lookup is made using B-Trees and hashes
(no string comparisons), so they are super fast. Also the `names` of the
settings can be `my super duper setting that once set to yes, will turn the world upside down = no`
-- so goodbye to most of the documentation involved.
-Next, netdata can generate a valid configuration for the user to edit.
+- so goodbye to most of the documentation involved.
+
+Next, Netdata can generate a valid configuration for the user to edit.
No need to remember anything or copy and paste settings. Just get the
-configuration from the server (`/netdata.conf` on your netdata server),
+configuration from the server (`/netdata.conf` on your Netdata server),
edit it and save it.
Last, what about options you believe you have set, but you misspelled?
@@ -45,4 +46,4 @@ When you get the configuration file from the server, there will be a
comment above all `name = value` pairs the server does not use.
So you know that whatever you wrote there, is not used.
-[![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%2Flibnetdata%2Fconfig%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)]()
+[![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%2Flibnetdata%2Fconfig%2FREADME&_u=MAC~&cid=5792dfd7-8dc4-476b-af31-da2fdb9f93d2&tid=UA-64295674-3)](<>)