Browse Source

updated installation page, added getting-started (#4734)

##### Summary
Improvements on installation page and addition of a Getting Started page. 

I will add the Getting Started page to the html docs in another PR
Costa Tsaousis 6 years ago
parent
commit
147b51a591
3 changed files with 566 additions and 314 deletions
  1. 180 0
      doc/GettingStarted.md
  2. 29 0
      htmldoc/buildyaml.sh
  3. 357 314
      installer/README.md

+ 180 - 0
doc/GettingStarted.md

@@ -0,0 +1,180 @@
+# Getting Started
+
+These are your first steps **after** you have installed netdata. If you haven't installed it already, please check the [installation page](../installer).
+
+## Accessing the dashboard
+
+To access the netdata dashboard, navigate with your browser to:
+
+```
+http://your.server.ip:19999/
+```
+
+<details markdown="1"><summary>Click here, if it does not work.</summary>
+
+**Verify Netdata is running.**
+
+Open an ssh session to the server and execute `sudo ps -e | grep netdata`. It should respond with the PID of the netdata daemon. If it prints nothing, Netdata is not running. Check the [installation page](../installer) to install it.
+
+**Verify Netdata responds to HTTP requests.**
+
+Using the same ssh session, execute `curl -Ss http://localhost:19999`. It should dump on your screen the `index.html` page of the dashboard. If it does not, check the [installation page](../installer) to install it.
+
+**Verify Netdata receives the HTTP requests.**
+
+On the same ssh session, execute `tail -f /var/log/netdata/access.log` (if you installed the static 64bit package, use: `tail -f /opt/netdata/var/log/netdata/access.log`). This command will print on your screen all HTTP requests Netdata receives.
+
+Next, try to access the dashboard using your web browser, using the URL posted above. If nothing is printed on your terminal, the HTTP request is not routed to your Netdata.
+
+If you are not sure about your server IP, run this for a hint: `ip route get 8.8.8.8 | grep -oP " src [0-9\.]+ "`. It should print the IP of your server.
+
+If still Netdata does not receive the requests, something is blocking them. A firewall possibly. Please check your network.
+
+</details>&nbsp;<br/>
+
+When you install multiple Netdata servers, all your servers will appear at the `my-netdata` menu at the top left of the dashboard. For this to work, you have to manually access just once, the dashboard of each of your netdata servers.
+
+The `my-netdata` menu is more than just browser bookmarks. When switching Netdata servers from that menu, any settings of the current view are propagated to the other netdata server:
+
+- the current charts panning (drag the charts left or right),
+- the current charts zooming (`SHIFT` + mouse wheel over a chart),
+- the highlighted time-frame (`ALT` + select an area on a chart),
+- the scrolling position of the dashboard,
+- the theme you use,
+- etc.
+
+are all sent over to other netdata server, to allow you troubleshoot cross-server performance issues easily.
+
+## Starting and stopping Netdata
+
+Netdata installer integrates Netdata to your init / systemd environment.
+
+To start/stop Netdata, depending on your environment, you should use:
+
+- `systemctl start netdata` and `systemctl stop netdata`
+- `service netdata start` and `service netdata stop`
+- `/etc/init.d/netdata start` and `/etc/init.d/netdata stop`
+
+Once netdata is installed, the installer configures it to start at boot and stop at shutdown.
+
+For more information about using these commands, consult your system documentation.
+
+## Sizing Netdata
+
+The default installation of netdata is configured for a small round-robin database: just 1 hour of data. Depending on the memory your system has and the amount you can dedicate to Netdata, you should adapt this. On production systems with limited RAM, we suggest to set this to 3-4 hours. For best results you should set this to 24 or 48 hours.
+
+For every hour of data, Netdata needs about 25MB of RAM. If you can dedicate about 100MB of RAM to netdata, you should set its database size to 4 hours.
+
+To do this, edit `/etc/netdata/netdata.conf` (or `/opt/netdata/etc/netdata/netdata.conf`) and set:
+
+```
+[global]
+    history = SECONDS
+```
+
+Make sure the `history` line is not commented (comment lines start with `#`).
+
+1 hour is 3600 seconds, so the number you need to set is the result of `HOURS * 3600`.
+
+!!! danger
+    Be careful when you set this on production systems. If you set it too high, your system may run out of memory. By default, netdata is configured to be killed first when the system starves for memory, but better be careful to avoid issues.
+
+For more information about Netdata memory requirements, [check this page](../database).
+
+If your kernel supports KSM (most do), you can [enable KSM to half netdata memory requirement](../database#ksm).
+
+## Service discovery and auto-detection
+
+Netdata supports auto-detection of data collection sources. It auto-detects almost everything: database servers, web servers, dns server, etc.
+
+This auto-detection process happens **only once**, when netdata starts. To have Netdata re-discover data sources, you need to restart it. There are a few exceptions to this:
+
+- containers and VMs are auto-detected forever (when Netdata is running at the host).
+- many data sources are collected but are silenced by default, until there is useful information to collect (for example network interface dropped packet, will appear after a packet has been dropped).
+- services that are not optimal to collect on all systems, are disabled by default.
+- services we received feedback from users that caused issues when monitored, are also disabled by default (for example, `chrony` is disabled by default, because CentOS ships a version of it that uses 100% CPU when queried for statistics).
+
+Once a data collection source is detected, netdata will never quit trying to collect data from it, until Netdata is restarted. So, if you stop your web server, netdata will pick it up automatically when it is started again.
+
+Since Netdata is installed on all your systems (even inside containers), auto-detection is limited to `localhost`. This simplifies significantly the security model of a Netdata monitored infrastructure, since most applications allow `localhost` access  by default.
+
+A few well known data collection sources that commonly need to be configured are:
+
+- [systemd services utilization](../collectors/cgroups.plugin/#monitoring-systemd-services) are not exposed by default on most systems, so `systemd` has to be configured to expose those metrics.
+
+## Configuration quick start
+
+In netdata we have:
+
+- **internal** data collection plugins (running inside the netdata daemon)
+- **external** data collection plugins (independent processes, sending data to netdata over pipes)
+- modular plugin **orchestrators** (external plugins that have multiple data collection modules)
+
+You can enable and disable plugins (internal and external) via `netdata.conf` at the section `[plugins]`.
+
+All plugins have dedicated sections in `netdata.conf`, like `[plugin:XXX]` for overwriting their default data collection frequency and providing additional command line options to them.
+
+All external plugins have their own `.conf` file.
+
+All modular plugin orchestrators have a directory in `/etc/netdata` with a `.conf` file for each of their modules.
+
+It is complex. So, let's see the whole configuration tree for the `nginx` module of `python.d.plugin`:
+
+In `netdata.conf` at the `[plugins]` section, `python.d.plugin` can be enabled or disabled:
+
+```
+[plugins]
+    python.d = yes
+```
+
+In `netdata.conf` at the `[plugin:python.d]` section, we can provide additional command line options for `python.d.plugin` and overwite its data collection frequency:
+
+```
+[plugin:python.d]
+	update every = 1
+	command options = 
+```
+
+`python.d.plugin` has its own configuration file for enabling and disabling its modules (here you can disable `nginx` for example):
+
+```bash
+sudo /etc/netdata/edit-config python.d.conf
+```
+
+Then, `nginx` has its own configuration file for configuring its data collection jobs (most modules can collect data from multiple sources, so the `nginx` module can collect metrics from multiple, local or remote, `nginx` servers):
+
+```bash
+sudo /etc/netdata/edit-config python.d/nginx.conf
+```
+
+## Health monitoring and alarms
+
+Netdata ships hundreds of health monitoring alarms for detecting anomalies. These are optimized for production servers.
+
+Many users install netdata on workstations and are frustrated by the default alarms shipped with netdata. On these cases, we suggest to disable health monitoring.
+
+To disable it, edit `/etc/netdata/netdata.conf` (or `/opt/netdata/etc/netdata/netdata.conf` if you installed the static 64bit package) and set:
+
+```
+[health]
+    enabled = no
+```
+
+The above will disable health monitoring entirely.
+
+If you want to keep health monitoring enabled for the dashboard, but you want to disable email notifications, run this:
+
+```bash
+sudo /etc/netdata/edit-config health_alarm_notify.conf
+```
+
+and set `SEND_EMAIL="NO"`.
+
+(For static 64bit installations use `sudo /opt/netdata/etc/netdata/edit-config health_alarm_notify.conf`).
+
+## What is next?
+
+- Check [Data Collection](../collectors) for configuring data collection plugins.
+- Check [Health Monitoring](../health) for configuring your own alarms, or setting up alarm notifications.
+- Check [Streaming](../streaming) for centralizing netdata metrics.
+- Check [Backends](../backends) for long term archiving of netdata metrics to time-series databases.

+ 29 - 0
htmldoc/buildyaml.sh

@@ -72,6 +72,30 @@ markdown_extensions:
     permalink: True
     separator: "-"
  - wikilinks
+ - pymdownx.arithmatex
+ - pymdownx.betterem:
+    smart_enable: all
+ - pymdownx.caret
+ - pymdownx.critic
+ - pymdownx.details
+ - pymdownx.emoji:
+    emoji_generator: !!python/name:pymdownx.emoji.to_svg
+ - pymdownx.inlinehilite
+ - pymdownx.magiclink
+ - pymdownx.mark
+ - pymdownx.smartsymbols
+ - pymdownx.superfences
+ - pymdownx.tasklist:
+    custom_checkbox: true
+ - pymdownx.tilde
+ - pymdownx.betterem
+ - pymdownx.superfences
+ - markdown.extensions.footnotes
+ - markdown.extensions.attr_list
+ - markdown.extensions.def_list
+ - markdown.extensions.tables
+ - markdown.extensions.abbr
+ - pymdownx.extrarawhtml
 nav:'
 
 navpart 1 . README "About"
@@ -91,6 +115,11 @@ echo -ne "- Installation:
     - 'installer/UPDATE.md'
     - 'installer/UNINSTALL.md'
 "
+
+echo -ne "- Getting Started:
+    - 'doc/GettingStarted.md'
+"
+
 echo -ne "- Running netdata:
 "
 navpart 2 daemon

+ 357 - 314
installer/README.md

@@ -1,366 +1,409 @@
 # Installation
-![image10](https://cloud.githubusercontent.com/assets/2662304/14253729/534c6f9c-fa95-11e5-8243-93eb0df719aa.gif)
 
-## Linux package managers
+Netdata is a **monitoring agent**. It is designed to be installed and run on all your systems: **physical** and **virtual** servers, **containers**, even **IoT**.
 
-You can install the latest release of netdata, using your package manager in
+The best way to install Netdata is directly from source. Our **automatic installer** will install any required system packages and compile Netdata directly on your systems.
 
-   - Arch Linux (`sudo pacman -S netdata`)
-   - Alpine Linux (`sudo apk add netdata`)
-   - Debian Linux (`sudo apt install netdata`)
-   - Gentoo Linux (`sudo emerge --ask netdata`)
-   - OpenSUSE (`sudo zypper install netdata`)
-   - Solus Linux (`sudo eopkg install netdata`)
-   - Ubuntu Linux >= 18.04 (`sudo apt install netdata`)
+!!! warning
+    You can find Netdata packages distributed by third parties. In many cases, these packages are either too old or broken. So, the suggested ways to install Netdata are the ones in this page.
+    **We are currently working to provide our binary packages for all Linux distros.** Stay tuned...
 
-Please note that the particular packages are not build by netdata.
+1. [Automatic one line installation](#one-line-installation), easy installation from source, **this is the default**
+2. [Install pre-built static binary on any 64bit Linux](#linux-64bit-pre-built-static-binary)
+3. [Run Netdata in a docker container](#run-netdata-in-a-docker-container)
+4. [Manual installation, step by step](#install-netdata-on-linux-manually)
+5. [Install on FreeBSD](#freebsd)
+6. [Install on pfSense](#pfsense)
+7. [Enable on FreeNAS Corral](#freenas)
+8. [Install on macOS (OS X)](#macos)
 
-## Linux one liner
-
-![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0) ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-86400&label=today&units=installations&precision=0)
-
-To install netdata from source to your systems and keep it up to date automatically, run the following:
-
-:hash:**`bash <(curl -Ss https://my-netdata.io/kickstart.sh)`**
-
-(do not `sudo` this command, it will do it by itself as needed)
-
-The command:
-
-1. detects the distro and **installs the required system packages** for building netdata (will ask for confirmation)
-2. downloads the latest netdata source tree to `/usr/src/netdata.git`.
-3. installs netdata by running `./netdata-installer.sh` from the source tree.
-4. installs `netdata-updater.sh` to `cron.daily`, so your netdata installation will be updated daily (you will get a message from cron only if the update fails).
-
-The `kickstart.sh` script passes all its parameters to `netdata-installer.sh`, so you can add more parameters to change the installation directory, enable/disable plugins, etc (check below).
-
-For automated installs, append a space + `--dont-wait` to the command line. You can also append `--dont-start-it` to prevent the installer from starting netdata. Example:
-
-```sh
-bash <(curl -Ss https://my-netdata.io/kickstart.sh) all --dont-wait --dont-start-it
-```
-
-## Linux 64bit pre-built static binary 
-
-You can install a pre-compiled static binary of netdata for any Intel/AMD 64bit Linux system (even those that don't have a package manager, like CoreOS, CirrOS, busybox systems, etc). You can also use these packages on systems with broken or unsupported package managers.
-
-<br/>![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart64&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0) ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart64&group=sum&after=-86400&label=today&units=installations&precision=0)
-
-To install netdata with a binary package on any Linux distro, any kernel version - for **Intel/AMD 64bit** hosts, run the following:
-
-:hash:&nbsp; **`bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh)`**
-
-(do not `sudo` this command, it will do it by itself as needed; the target system does not need `bash` installed, check below for instructions to run it without `bash`)
-
-*Note: The static builds install netdata at `/opt/netdata`*
-
-For automated installs, append a space + `--dont-wait` to the command line. You can also append `--dont-start-it` to prevent the installer from starting netdata. Example:
-
-```sh
-bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) --dont-wait --dont-start-it
-```
-
-If your shell fails to handle the above one liner, do this:
-
-```sh
-# download the script with curl
-curl https://my-netdata.io/kickstart-static64.sh >/tmp/kickstart-static64.sh
-
-# or, download the script with wget
-wget -O /tmp/kickstart-static64.sh https://my-netdata.io/kickstart-static64.sh
-
-# run the downloaded script (any sh is fine, no need for bash)
-sh /tmp/kickstart-static64.sh
-```
-
-The static binary files are kept in repo [binary-packages](https://github.com/netdata/binary-packages). You can download any of the `.run` files, and run it. These files are self-extracting shell scripts built with [makeself](https://github.com/megastep/makeself). The target system does **not** need to have bash installed. The same files can be used for updates too.
-
-## Docker
-
-You can [Install netdata with Docker](../docker/#install-netdata-with-docker)
-
-## Other installation methods
-
-- **Linux manual installation from source**
-
-    Semi-automatic, with more details about the steps involved and actions taken [here](#install-netdata-on-linux-manually)
-
-- **Non-Linux installation**
-    - [Install from package or source, on FreeBSD](#freebsd)
-    - [Install from package, on pfSense](#pfsense)
-    - [Enable netdata on FreeNAS Corral](#freenas)
-    - [Install from package or source, on macOS (OS X)](#macos)
-
-    See also the list of netdata [package maintainers](../packaging/maintainers) for ASUSTOR NAS, OpenWRT, ReadyNAS, etc.
- 
-## Install netdata on Linux manually
-
-To install the latest git version of netdata, please follow these 2 steps:
-
-1. [Prepare your system](#prepare-your-system)
-
-   Install the required packages on your system.
-
-2. [Install netdata](#install-netdata)
-
-   Download and install netdata. You can also update it the same way.
+See also the list of Netdata [package maintainers](../packaging/maintainers) for ASUSTOR NAS, OpenWRT, ReadyNAS, etc.  
 
 ---
 
-### Prepare your system
+## One line installation
 
-Try our experimental automatic requirements installer (no need to be root). This will try to find the packages that should be installed on your system to build and run netdata. It supports most major Linux distributions released after 2010:
+> This method is **fully automatic on all Linux** distributions. FreeBSD and MacOS systems need some preparations before installing Netdata for the first time. Check the [FreeBSD](#freebsd) and the [MacOS](#macos) sections for more information.
 
-- **Alpine** Linux and its derivatives (you have to install `bash` yourself, before using the installer)
-- **Arch** Linux and its derivatives
-- **Gentoo** Linux and its derivatives
-- **Debian** Linux and its derivatives (including **Ubuntu**, **Mint**)
-- **Fedora** and its derivatives (including **Red Hat Enterprise Linux**, **CentOS**, **Amazon Machine Image**)
-- **SuSe** Linux and its derivatives (including **openSuSe**)
-- **SLE12** Must have your system registered with Suse Customer Center or have the DVD. See [#1162](https://github.com/netdata/netdata/issues/1162)
+To install Netdata from source and keep it up to date automatically, run the following:
 
-Install the packages for having a **basic netdata installation** (system monitoring and many applications, without  `mysql` / `mariadb`, `postgres`, `named`, hardware sensors and `SNMP`):
-
-```sh
-curl -Ss 'https://raw.githubusercontent.com/netdata/netdata-demo-site/master/install-required-packages.sh' >/tmp/kickstart.sh && bash /tmp/kickstart.sh -i netdata
-```
-
-Install all the required packages for **monitoring everything netdata can monitor**:
-
-```sh
-curl -Ss 'https://raw.githubusercontent.com/netdata/netdata-demo-site/master/install-required-packages.sh' >/tmp/kickstart.sh && bash /tmp/kickstart.sh -i netdata-all
+```bash
+bash <(curl -Ss https://my-netdata.io/kickstart.sh)
 ```
 
-If the above do not work for you, please [open a github issue](https://github.com/netdata/netdata/issues/new?title=packages%20installer%20failed&labels=installation%20help&body=The%20experimental%20packages%20installer%20failed.%0A%0AThis%20is%20what%20it%20says:%0A%0A%60%60%60txt%0A%0Aplease%20paste%20your%20screen%20here%0A%0A%60%60%60) with a copy of the message you get on screen. We are trying to make it work everywhere (this is also why the script [reports back](https://github.com/netdata/netdata/issues/2054) success or failure for all its runs).
-
----
-
-This is how to do it by hand:
+*(do not `sudo` this command, it will do it by itself as needed)*  
 
-```sh
-# Debian / Ubuntu
-apt-get install zlib1g-dev uuid-dev libmnl-dev gcc make git autoconf autoconf-archive autogen automake pkg-config curl
+![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0) ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart&group=sum&after=-86400&label=today&units=installations&precision=0)
 
-# Fedora
-dnf install zlib-devel libuuid-devel libmnl-devel gcc make git autoconf autoconf-archive autogen automake pkgconfig curl findutils
+<details markdown="1"><summary>Click here for more information and advanced use of this command.</summary>
 
-# CentOS / Red Hat Enterprise Linux
-yum install autoconf automake curl gcc git libmnl-devel libuuid-devel lm_sensors make MySQL-python nc pkgconfig python python-psycopg2 PyYAML zlib-devel
+&nbsp;<br/>
+Verify the integrity of the script with this:
 
+```bash
+[ "6c15b7d7d31dc130631c42da65df71ae" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
 ```
-
-Please note that for RHEL/CentOS you might need [EPEL](http://www.tecmint.com/how-to-enable-epel-repository-for-rhel-centos-6-5/).
-
-Once netdata is compiled, to run it the following packages are required (already installed using the above commands):
-
-package|description
-:-----:|-----------
-`libuuid`|part of `util-linux` for GUIDs management
-`zlib`|gzip compression for the internal netdata web server
-
-*netdata will fail to start without the above.*
-
-netdata plugins and various aspects of netdata can be enabled or benefit when these are installed (they are optional):
-
-package|description
-:-----:|-----------
-`bash`|for shell plugins and **alarm notifications**
-`curl`|for shell plugins and **alarm notifications**
-`iproute` or `iproute2`|for monitoring **Linux traffic QoS**<br/>use `iproute2` if `iproute` reports as not available or obsolete
-`python`|for most of the external plugins
-`python-yaml`|used for monitoring **beanstalkd**
-`python-beanstalkc`|used for monitoring **beanstalkd**
-`python-dnspython`|used for monitoring DNS query time
-`python-ipaddress`|used for monitoring **DHCPd**<br/>this package is required only if the system has python v2. python v3 has this functionality embedded
-`python-mysqldb`<br/>or<br/>`python-pymysql`|used for monitoring **mysql** or **mariadb** databases<br/>`python-mysqldb` is a lot faster and thus preferred
-`python-psycopg2`|used for monitoring **postgresql** databases
-`python-pymongo`|used for monitoring **mongodb** databases
-`nodejs`|used for `node.js` plugins for monitoring **named** and **SNMP** devices
-`lm-sensors`|for monitoring **hardware sensors**
-`libmnl`|for collecting netfilter metrics
-`netcat`|for shell plugins to collect metrics from remote systems
-
-*netdata will greatly benefit if you have the above packages installed, but it will still work without them.*
-
----
-
-### Install netdata
-
-Do this to install and run netdata:
-
-```sh
-
-# download it - the directory 'netdata' will be created
-git clone https://github.com/netdata/netdata.git --depth=1
-cd netdata
-
-# run script with root privileges to build, install, start netdata
-./netdata-installer.sh
-
+*It should print `OK, VALID` if the script is the one we ship.*
+
+The `kickstart.sh` script:
+
+- detects the Linux distro and **installs the required system packages** for building Netdata (will ask for confirmation)  
+- downloads the latest Netdata source tree to `/usr/src/netdata.git`.  
+- installs Netdata by running `./netdata-installer.sh` from the source tree.  
+- installs `netdata-updater.sh` to `cron.daily`, so your Netdata installation will be updated daily (you will get a message from cron only if the update fails).
+- For QA purposes, this installation method lets us know if it succeed or failed.
+
+The `kickstart.sh` script passes all its parameters to `netdata-installer.sh`, so you can add more parameters to change the installation directory, enable/disable plugins, etc (check below).  
+  
+For automated installs, append a space + `--dont-wait` to the command line. You can also append `--dont-start-it` to prevent the installer from starting Netdata. Example:
+  
+```bash
+  bash <(curl -Ss https://my-netdata.io/kickstart.sh) --dont-wait --dont-start-it
 ```
 
-* If you don't want to run it straight-away, add `--dont-start-it` option.
-
-* If you don't want to install it on the default directories, you can run the installer like this: `./netdata-installer.sh --install /opt`. This one will install netdata in `/opt/netdata`.
-
-Once the installer completes, the file `/etc/netdata/netdata.conf` will be created (if you changed the installation directory, the configuration will appear in that directory too).
-
-You can edit this file to set options. One common option to tweak is `history`, which controls the size of the memory database netdata will use. By default is `3600` seconds (an hour of data at the charts) which makes netdata use about 10-15MB of RAM (depending on the number of charts detected on your system). Check **[[Memory Requirements]]**.
+</details>&nbsp;<br/>
 
-To apply the changes you made, you have to restart netdata.
+Once Netdata is installed, see [Getting Started](../doc/GettingStarted.md).
 
 ---
 
-## Other Systems
-
-
-
-##### FreeBSD
-
-You can install netdata from ports or packages collection.
-
-This is how to install the latest netdata version from sources on FreeBSD:
-
-```sh
-# install required packages
-pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof
-
-# download netdata
-git clone https://github.com/netdata/netdata.git --depth=1
-
-# install netdata in /opt/netdata
-cd netdata
-./netdata-installer.sh --install /opt
-```
-
-##### pfSense
-To install netdata on pfSense run the following commands (within a shell or under Diagnostics/Command Prompt within the pfSense web interface).
-
-Change platform (i386/amd64, etc) and FreeBSD versions (10/11, etc) according to your environment and change netdata version (1.10.0 in example) according to latest version present within the FreeSBD repository:-
-
-Note first three packages are downloaded from the pfSense repository for maintaining compatibility with pfSense, netdata is downloaded from the FreeBSD repository.
-```
-pkg install pkgconf
-pkg install bash
-pkg install e2fsprogs-libuuid
-pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/netdata-1.11.0.txz
-```
-To start netdata manually run `service netdata onestart`
-
-To start netdata automatically at each boot add `service netdata start` as a Shellcmd within the pfSense web interface (under **Services/Shellcmd**, which you need to install beforehand under **System/Package Manager/Available Packages**).
-Shellcmd Type should be set to `Shellcmd`. 
-![](https://user-images.githubusercontent.com/36808164/36930790-4db3aa84-1f0d-11e8-8752-cdc08bb7207c.png)
-Alternatively more information can be found in https://doc.pfsense.org/index.php/Installing_FreeBSD_Packages, for achieving the same via the command line and scripts.  
+## Linux 64bit pre-built static binary
 
-If you experience an issue with `/usr/bin/install` absense on pfSense 2.3 or earlier, update pfSense or use workaround from [https://redmine.pfsense.org/issues/6643](https://redmine.pfsense.org/issues/6643)
+You can install a pre-compiled static binary of Netdata on any Intel/AMD 64bit Linux system  
+(even those that don't have a package manager, like CoreOS, CirrOS, busybox systems, etc).  
+You can also use these packages on systems with broken or unsupported package managers.
 
-##### FreeNAS
-On FreeNAS-Corral-RELEASE (>=10.0.3), netdata is pre-installed. 
+To install Netdata with a binary package on any Linux distro, any kernel version - for **Intel/AMD 64bit** hosts, run the following:
+  
+```bash
 
-To use netdata, the service will need to be enabled and started from the FreeNAS **[CLI](https://github.com/freenas/cli)**.
+  bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh)  
 
-To enable the netdata service:
-```
-service netdata config set enable=true
 ```
 
-To start the netdata service:
-```
-service netdata start
-```
-
-##### macOS
+*(do not `sudo` this command, it will do it by itself as needed; if the target system does not have `bash` installed, see below for instructions to run it without `bash`)*
 
-netdata on macOS still has limited charts, but external plugins do work.
+![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart64&group=sum&after=-3600&label=last+hour&units=installations&value_color=orange&precision=0) ![](https://registry.my-netdata.io/api/v1/badge.svg?chart=web_log_nginx.requests_per_url&options=unaligned&dimensions=kickstart64&group=sum&after=-86400&label=today&units=installations&precision=0)  
 
-You can either install netdata with [Homebrew](https://brew.sh/)
+> The static builds install Netdata at **`/opt/netdata`**
 
-```sh
-brew install netdata
-```
+<details markdown="1"><summary>Click here for more information and advanced use of this command.</summary>
 
-or from source:
+&nbsp;<br/>
+Verify the integrity of the script with this:
 
-```sh
-# install Xcode Command Line Tools
-xcode-select --install
+```bash
+[ "a5c16b3126b696ff7b4c8d8d8dc6957d" = "$(curl -Ss https://my-netdata.io/kickstart-static64.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID"
 ```
-click `Install` in the software update popup window, then
-```sh
-# install HomeBrew package manager
-/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
 
-# install required packages
-brew install ossp-uuid autoconf automake pkg-config
+*It should print `OK, VALID` if the script is the one we ship.*
 
-# download netdata
-git clone https://github.com/netdata/netdata.git --depth=1
+For automated installs, append a space + `--dont-wait` to the command line. You can also append `--dont-start-it` to prevent the installer from starting Netdata.  
+  
+Example:  
+  
+```bash
 
-# install netdata in /usr/local/netdata
-cd netdata
-sudo ./netdata-installer.sh --install /usr/local
-```
-
-The installer will also install a startup plist to start netdata when your Mac boots.
-
-##### Alpine 3.x
-
-Execute these commands to install netdata in Alpine Linux 3.x:
+  bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh) --dont-wait --dont-start-it  
 
 ```
-# install required packages
-apk add alpine-sdk bash curl zlib-dev util-linux-dev libmnl-dev gcc make git autoconf automake pkgconfig python logrotate
-
-# if you plan to run node.js netdata plugins
-apk add nodejs
-
-# download netdata - the directory 'netdata' will be created
-git clone https://github.com/netdata/netdata.git --depth=1
-cd netdata
 
-
-# build it, install it, start it
-./netdata-installer.sh
-
-
-# make netdata start at boot
-echo -e "#!/usr/bin/env bash\n/usr/sbin/netdata" >/etc/local.d/netdata.start
-chmod 755 /etc/local.d/netdata.start
-
-# make netdata stop at shutdown
-echo -e "#!/usr/bin/env bash\nkillall netdata" >/etc/local.d/netdata.stop
-chmod 755 /etc/local.d/netdata.stop
-
-# enable the local service to start automatically
-rc-update add local
+If your shell fails to handle the above one liner, do this:  
+  
+```bash
+# download the script with curl  
+curl https://my-netdata.io/kickstart-static64.sh >/tmp/kickstart-static64.sh  
+  
+# or, download the script with wget  
+wget -O /tmp/kickstart-static64.sh https://my-netdata.io/kickstart-static64.sh  
+  
+# run the downloaded script (any sh is fine, no need for bash)  
+sh /tmp/kickstart-static64.sh  
 ```
 
-##### Synology
-
-The documentation previously recommended installing the Debian Chroot package from the Synology community package sources and then running netdata from within the chroot. This does not work, as the chroot environment does not have access to `/proc`, and therefore exposes very few metrics to netdata. Additionally, [this issue](https://github.com/SynoCommunity/spksrc/issues/2758), still open as of 2018/06/24, indicates that the Debian Chroot package is not suitable for DSM versions greater than version 5 and may corrupt system libraries and render the NAS unable to boot. 
-
-The good news is that the 64-bit static installer works fine if your NAS is one that uses the amd64 architecture. It will install the content into `/opt/netdata`, making future removal safe and simple.
+- The static binary files are kept in repo [binary-packages](https://github.com/netdata/binary-packages). You can download any of the `.run` files, and run it. These files are self-extracting shell scripts built with [makeself](https://github.com/megastep/makeself).
+- The target system does **not** need to have bash installed.
+- The same files can be used for updates too.
+- For QA purposes, this installation method lets us know if it succeed or failed.
 
-###### Additional Work
+</details>&nbsp;<br/>
 
-When netdata is first installed, it will run as _root_. This may or may not be acceptable for you, and since other installations run it as the _netdata_ user, you might wish to do the same. This requires some extra work:
+Once Netdata is installed, see [Getting Started](../doc/GettingStarted.md).
 
-1. Creat a group `netdata` via the Synology group interface. Give it no access to anything.
-2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign the user to the `netdata` group. Netdata will chuid to this user when running.
-3. Change ownership of the following directories, as defined in [Netdata Security](../doc/netdata-security.md#security-design):
-
-```
-$ chown -R root:netdata /opt/netdata/usr/share/netdata
-$ chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/netdata
-$ chown -R netdata:root /opt/netdata/var/log/netdata
-```
+---
 
-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:
+## Run Netdata in a Docker container
+  
+You can [Install Netdata with Docker](../docker/#install-netdata-with-docker).
 
-1. Add [this file](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f) as `/etc/rc.netdata`. Make it executable with `chmod 0755 /etc/rc.netdata`.
-2. Edit `/etc/rc.local` and add a line calling `/etc/rc.netdata` to have it start on boot:
+---
 
-```
-# Netdata startup
-[ -x /etc/rc.netdata ] && /etc/rc.netdata start
+## Install Netdata on Linux manually  
+  
+To install the latest git version of Netdata, please follow these 2 steps:  
+  
+1. [Prepare your system](#prepare-your-system)  
+  
+   Install the required packages on your system.  
+  
+2. [Install Netdata](#install-netdata)  
+  
+   Download and install Netdata. You can also update it the same way.  
+  
+---  
+  
+### Prepare your system  
+  
+Try our experimental automatic requirements installer (no need to be root). This will try to find the packages that should be installed on your system to build and run Netdata. It supports most major Linux distributions released after 2010:  
+  
+- **Alpine** Linux and its derivatives (you have to install `bash` yourself, before using the installer)  
+- **Arch** Linux and its derivatives  
+- **Gentoo** Linux and its derivatives  
+- **Debian** Linux and its derivatives (including **Ubuntu**, **Mint**)  
+- **Fedora** and its derivatives (including **Red Hat Enterprise Linux**, **CentOS**, **Amazon Machine Image**)  
+- **SuSe** Linux and its derivatives (including **openSuSe**)  
+- **SLE12** Must have your system registered with Suse Customer Center or have the DVD. See [#1162](https://github.com/netdata/netdata/issues/1162)  
+  
+Install the packages for having a **basic Netdata installation** (system monitoring and many applications, without  `mysql` / `mariadb`, `postgres`, `named`, hardware sensors and `SNMP`):  
+  
+```sh  
+curl -Ss 'https://raw.githubusercontent.com/netdata/netdata-demo-site/master/install-required-packages.sh' >/tmp/kickstart.sh && bash /tmp/kickstart.sh -i netdata  
+```  
+  
+Install all the required packages for **monitoring everything Netdata can monitor**:  
+  
+```sh  
+curl -Ss 'https://raw.githubusercontent.com/netdata/netdata-demo-site/master/install-required-packages.sh' >/tmp/kickstart.sh && bash /tmp/kickstart.sh -i netdata-all  
+```  
+  
+If the above do not work for you, please [open a github issue](https://github.com/netdata/netdata/issues/new?title=packages%20installer%20failed&labels=installation%20help&body=The%20experimental%20packages%20installer%20failed.%0A%0AThis%20is%20what%20it%20says:%0A%0A%60%60%60txt%0A%0Aplease%20paste%20your%20screen%20here%0A%0A%60%60%60) with a copy of the message you get on screen. We are trying to make it work everywhere (this is also why the script [reports back](https://github.com/netdata/netdata/issues/2054) success or failure for all its runs).  
+  
+---  
+  
+This is how to do it by hand:  
+  
+```sh  
+# Debian / Ubuntu  
+apt-get install zlib1g-dev uuid-dev libmnl-dev gcc make git autoconf autoconf-archive autogen automake pkg-config curl  
+  
+# Fedora  
+dnf install zlib-devel libuuid-devel libmnl-devel gcc make git autoconf autoconf-archive autogen automake pkgconfig curl findutils  
+  
+# CentOS / Red Hat Enterprise Linux  
+yum install autoconf automake curl gcc git libmnl-devel libuuid-devel lm_sensors make MySQL-python nc pkgconfig python python-psycopg2 PyYAML zlib-devel  
+  
+```  
+  
+Please note that for RHEL/CentOS you might need [EPEL](http://www.tecmint.com/how-to-enable-epel-repository-for-rhel-centos-6-5/).  
+  
+Once Netdata is compiled, to run it the following packages are required (already installed using the above commands):  
+  
+package|description  
+:-----:|-----------  
+`libuuid`|part of `util-linux` for GUIDs management  
+`zlib`|gzip compression for the internal Netdata web server  
+  
+*Netdata will fail to start without the above.*  
+  
+Netdata plugins and various aspects of Netdata can be enabled or benefit when these are installed (they are optional):  
+  
+package|description  
+:-----:|-----------  
+`bash`|for shell plugins and **alarm notifications**  
+`curl`|for shell plugins and **alarm notifications**  
+`iproute` or `iproute2`|for monitoring **Linux traffic QoS**<br/>use `iproute2` if `iproute` reports as not available or obsolete  
+`python`|for most of the external plugins  
+`python-yaml`|used for monitoring **beanstalkd**  
+`python-beanstalkc`|used for monitoring **beanstalkd**  
+`python-dnspython`|used for monitoring DNS query time  
+`python-ipaddress`|used for monitoring **DHCPd**<br/>this package is required only if the system has python v2. python v3 has this functionality embedded  
+`python-mysqldb`<br/>or<br/>`python-pymysql`|used for monitoring **mysql** or **mariadb** databases<br/>`python-mysqldb` is a lot faster and thus preferred  
+`python-psycopg2`|used for monitoring **postgresql** databases  
+`python-pymongo`|used for monitoring **mongodb** databases  
+`nodejs`|used for `node.js` plugins for monitoring **named** and **SNMP** devices  
+`lm-sensors`|for monitoring **hardware sensors**  
+`libmnl`|for collecting netfilter metrics  
+`netcat`|for shell plugins to collect metrics from remote systems  
+  
+*Netdata will greatly benefit if you have the above packages installed, but it will still work without them.*  
+  
+---  
+  
+### Install Netdata  
+  
+Do this to install and run Netdata:  
+  
+```sh  
+  
+# download it - the directory 'netdata' will be created  
+git clone https://github.com/netdata/netdata.git --depth=1  
+cd netdata  
+  
+# run script with root privileges to build, install, start Netdata  
+./netdata-installer.sh  
+  
+```  
+  
+* If you don't want to run it straight-away, add `--dont-start-it` option.  
+  
+* If you don't want to install it on the default directories, you can run the installer like this: `./netdata-installer.sh --install /opt`. This one will install Netdata in `/opt/netdata`.  
+  
+Once the installer completes, the file `/etc/netdata/netdata.conf` will be created (if you changed the installation directory, the configuration will appear in that directory too).  
+  
+You can edit this file to set options. One common option to tweak is `history`, which controls the size of the memory database Netdata will use. By default is `3600` seconds (an hour of data at the charts) which makes Netdata use about 10-15MB of RAM (depending on the number of charts detected on your system). Check **[[Memory Requirements]]**.  
+  
+To apply the changes you made, you have to restart Netdata.  
+  
+---  
+  
+## Other Systems  
+  
+  
+  
+##### FreeBSD  
+  
+You can install Netdata from ports or packages collection.  
+  
+This is how to install the latest Netdata version from sources on FreeBSD:  
+  
+```sh  
+# install required packages  
+pkg install bash e2fsprogs-libuuid git curl autoconf automake pkgconf pidof  
+  
+# download Netdata  
+git clone https://github.com/netdata/netdata.git --depth=1  
+  
+# install Netdata in /opt/netdata  
+cd netdata  
+./netdata-installer.sh --install /opt  
+```  
+  
+##### pfSense  
+To install Netdata on pfSense run the following commands (within a shell or under Diagnostics/Command Prompt within the pfSense web interface).  
+  
+Change platform (i386/amd64, etc) and FreeBSD versions (10/11, etc) according to your environment and change Netdata version (1.10.0 in example) according to latest version present within the FreeSBD repository:-  
+  
+Note first three packages are downloaded from the pfSense repository for maintaining compatibility with pfSense, Netdata is downloaded from the FreeBSD repository.  
+```  
+pkg install pkgconf  
+pkg install bash  
+pkg install e2fsprogs-libuuid  
+pkg add http://pkg.freebsd.org/FreeBSD:11:amd64/latest/All/netdata-1.11.0.txz  
+```  
+To start Netdata manually run `service netdata onestart`  
+  
+To start Netdata automatically at each boot add `service netdata start` as a Shellcmd within the pfSense web interface (under **Services/Shellcmd**, which you need to install beforehand under **System/Package Manager/Available Packages**).  
+Shellcmd Type should be set to `Shellcmd`.   
+![](https://user-images.githubusercontent.com/36808164/36930790-4db3aa84-1f0d-11e8-8752-cdc08bb7207c.png)  
+Alternatively more information can be found in https://doc.pfsense.org/index.php/Installing_FreeBSD_Packages, for achieving the same via the command line and scripts.    
+  
+If you experience an issue with `/usr/bin/install` absense on pfSense 2.3 or earlier, update pfSense or use workaround from [https://redmine.pfsense.org/issues/6643](https://redmine.pfsense.org/issues/6643)  
+  
+##### FreeNAS  
+On FreeNAS-Corral-RELEASE (>=10.0.3), Netdata is pre-installed.   
+  
+To use Netdata, the service will need to be enabled and started from the FreeNAS **[CLI](https://github.com/freenas/cli)**.  
+  
+To enable the Netdata service:  
+```  
+service netdata config set enable=true  
+```  
+  
+To start the netdata service:  
+```  
+service netdata start  
+```  
+  
+##### macOS  
+  
+Netdata on macOS still has limited charts, but external plugins do work.  
+  
+You can either install Netdata with [Homebrew](https://brew.sh/)  
+  
+```sh  
+brew install netdata  
+```  
+  
+or from source:  
+  
+```sh  
+# install Xcode Command Line Tools  
+xcode-select --install  
+```  
+click `Install` in the software update popup window, then  
+```sh  
+# install HomeBrew package manager  
+/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"  
+  
+# install required packages  
+brew install ossp-uuid autoconf automake pkg-config  
+  
+# download Netdata  
+git clone https://github.com/netdata/netdata.git --depth=1  
+  
+# install Netdata in /usr/local/netdata  
+cd netdata  
+sudo ./netdata-installer.sh --install /usr/local  
+```  
+  
+The installer will also install a startup plist to start Netdata when your Mac boots.  
+  
+##### Alpine 3.x  
+  
+Execute these commands to install Netdata in Alpine Linux 3.x:  
+  
+```  
+# install required packages  
+apk add alpine-sdk bash curl zlib-dev util-linux-dev libmnl-dev gcc make git autoconf automake pkgconfig python logrotate  
+  
+# if you plan to run node.js Netdata plugins  
+apk add nodejs  
+  
+# download Netdata - the directory 'netdata' will be created  
+git clone https://github.com/netdata/netdata.git --depth=1  
+cd netdata  
+  
+  
+# build it, install it, start it  
+./netdata-installer.sh  
+  
+  
+# make Netdata start at boot  
+echo -e "#!/usr/bin/env bash\n/usr/sbin/netdata" >/etc/local.d/netdata.start  
+chmod 755 /etc/local.d/netdata.start  
+  
+# make Netdata stop at shutdown  
+echo -e "#!/usr/bin/env bash\nkillall netdata" >/etc/local.d/netdata.stop  
+chmod 755 /etc/local.d/netdata.stop  
+  
+# enable the local service to start automatically  
+rc-update add local  
+```  
+  
+##### Synology  
+  
+The documentation previously recommended installing the Debian Chroot package from the Synology community package sources and then running Netdata from within the chroot. This does not work, as the chroot environment does not have access to `/proc`, and therefore exposes very few metrics to Netdata. Additionally, [this issue](https://github.com/SynoCommunity/spksrc/issues/2758), still open as of 2018/06/24, indicates that the Debian Chroot package is not suitable for DSM versions greater than version 5 and may corrupt system libraries and render the NAS unable to boot.   
+  
+The good news is that the 64-bit static installer works fine if your NAS is one that uses the amd64 architecture. It will install the content into `/opt/netdata`, making future removal safe and simple.  
+  
+When Netdata is first installed, it will run as _root_. This may or may not be acceptable for you, and since other installations run it as the _netdata_ user, you might wish to do the same. This requires some extra work:  
+  
+1. Creat a group `netdata` via the Synology group interface. Give it no access to anything.  
+2. Create a user `netdata` via the Synology user interface. Give it no access to anything and a random password. Assign the user to the `netdata` group. Netdata will chuid to this user when running.  
+3. Change ownership of the following directories, as defined in [Netdata Security](../doc/netdata-security.md#security-design):  
+  
+```  
+$ chown -R root:netdata /opt/netdata/usr/share/netdata  
+$ chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/netdata  
+$ chown -R netdata:root /opt/netdata/var/log/netdata  
+```  
+  
+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:  
+  
+1. Add [this file](https://gist.github.com/oskapt/055d474d7bfef32c49469c1b53e8225f) as `/etc/rc.netdata`. Make it executable with `chmod 0755 /etc/rc.netdata`.  
+2. Edit `/etc/rc.local` and add a line calling `/etc/rc.netdata` to have it start on boot:  
+  
+```  
+# Netdata startup  
+[ -x /etc/rc.netdata ] && /etc/rc.netdata start  
 ```