diff options
Diffstat (limited to '')
| -rw-r--r-- | packaging/installer/README.md (renamed from installer/README.md) | 245 |
1 files changed, 146 insertions, 99 deletions
diff --git a/installer/README.md b/packaging/installer/README.md index cbcefab08..eb507a5fc 100644 --- a/installer/README.md +++ b/packaging/installer/README.md @@ -1,72 +1,118 @@ # Installation - -## 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) -## Docker +See also the list of Netdata [package maintainers](../maintainers) for ASUSTOR NAS, OpenWRT, ReadyNAS, etc. -You can [Install netdata with Docker](../docker/#install-netdata-with-docker) +--- + +## One line installation + +> 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. + +To install Netdata from source and keep it up to date automatically, run the following: -## Linux one liner +```bash +bash <(curl -Ss https://my-netdata.io/kickstart.sh) +``` + +*(do not `sudo` this command, it will do it by itself as needed)*   -To install netdata from source to your systems and keep it up to date automatically, run the following: +<details markdown="1"><summary>Click here for more information and advanced use of this command.</summary> -:hash:**`bash <(curl -Ss https://my-netdata.io/kickstart.sh)`** + <br/> +Verify the integrity of the script with this: -(do not `sudo` this command, it will do it by itself as needed) +```bash +[ "b4632ca6c651de0f667e6d4f6e1015fe" = "$(curl -Ss https://my-netdata.io/kickstart.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID" +``` +*It should print `OK, VALID` if the script is the one we ship.* -The command: +The `kickstart.sh` script: -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). +- 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: +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 +```bash + bash <(curl -Ss https://my-netdata.io/kickstart.sh) --dont-wait --dont-start-it ``` -## Linux 64bit pre-built static binary +If you don't want to receive automatic updates, add `--no-updates` when executing `kickstart.sh` script. -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. +</details> <br/> -<br/>  +Once Netdata is installed, see [Getting Started](../../docs/GettingStarted.md). -To install netdata with a binary package on any Linux distro, any kernel version - for **Intel/AMD 64bit** hosts, run the following: +--- -:hash: **`bash <(curl -Ss https://my-netdata.io/kickstart-static64.sh)`** +## Linux 64bit pre-built static binary -(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`) +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. -*Note: The static builds install netdata at `/opt/netdata`* +To install Netdata with a binary package on any Linux distro, any kernel version - for **Intel/AMD 64bit** hosts, run the following: -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-static64.sh) + +``` + +*(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`)* + +  + +> The static builds install Netdata at **`/opt/netdata`** + +<details markdown="1"><summary>Click here for more information and advanced use of this command.</summary> + + <br/> +Verify the integrity of the script with this: + +```bash +[ "ac8e5cf25399b08c42d37e1a53e1a6d3" = "$(curl -Ss https://my-netdata.io/kickstart-static64.sh | md5sum | cut -d ' ' -f 1)" ] && echo "OK, VALID" || echo "FAILED, INVALID" +``` + +*It should print `OK, VALID` if the script is the one we ship.* + +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-static64.sh) --dont-wait --dont-start-it -```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 +```bash # download the script with curl curl https://my-netdata.io/kickstart-static64.sh >/tmp/kickstart-static64.sh @@ -77,39 +123,40 @@ wget -O /tmp/kickstart-static64.sh https://my-netdata.io/kickstart-static64.sh 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. +- 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. + +</details> <br/> + +Once Netdata is installed, see [Getting Started](../../docs/GettingStarted.md). -## Other installation methods +--- -- **Linux manual installation from source** +## Run Netdata in a Docker container - Semi-automatic, with more details about the steps involved and actions taken [here](#install-netdata-on-linux-manually) +You can [Install Netdata with Docker](../docker/#install-netdata-with-docker). -- **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 +## Install Netdata on Linux manually -To install the latest git version of netdata, please follow these 2 steps: +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) +2. [Install Netdata](#install-netdata) - Download and install netdata. You can also update it the same way. + 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: +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 @@ -119,13 +166,13 @@ Try our experimental automatic requirements installer (no need to be root). This - **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`): +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**: +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 @@ -151,16 +198,16 @@ yum install autoconf automake curl gcc git libmnl-devel libuuid-devel lm_sensors 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): +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 +`zlib`|gzip compression for the internal Netdata web server -*netdata will fail to start without the above.* +*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): +Netdata plugins and various aspects of Netdata can be enabled or benefit when these are installed (they are optional): package|description :-----:|----------- @@ -180,34 +227,34 @@ package|description `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.* +*Netdata will greatly benefit if you have the above packages installed, but it will still work without them.* --- -### Install netdata +### Install Netdata -Do this to install and run 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 +git clone https://github.com/netdata/netdata.git --depth=100 cd netdata -# run script with root privileges to build, install, start 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`. +* 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]]**. +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. +To apply the changes you made, you have to restart Netdata. --- @@ -217,49 +264,49 @@ To apply the changes you made, you have to restart netdata. ##### FreeBSD -You can install netdata from ports or packages collection. +You can install Netdata from ports or packages collection. -This is how to install the latest netdata version from sources on FreeBSD: +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 +# download Netdata +git clone https://github.com/netdata/netdata.git --depth=100 -# install netdata in /opt/netdata +# 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). +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:- +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. +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 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`. +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`.  -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. +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. +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 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: +To enable the Netdata service: ``` service netdata config set enable=true ``` @@ -271,9 +318,9 @@ service netdata start ##### macOS -netdata on macOS still has limited charts, but external plugins do work. +Netdata on macOS still has limited charts, but external plugins do work. -You can either install netdata with [Homebrew](https://brew.sh/) +You can either install Netdata with [Homebrew](https://brew.sh/) ```sh brew install netdata @@ -293,29 +340,29 @@ click `Install` in the software update popup window, then # install required packages brew install ossp-uuid autoconf automake pkg-config -# download netdata -git clone https://github.com/netdata/netdata.git --depth=1 +# download Netdata +git clone https://github.com/netdata/netdata.git --depth=100 -# install netdata in /usr/local/netdata +# 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. +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: +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 +# 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 +# download Netdata - the directory 'netdata' will be created +git clone https://github.com/netdata/netdata.git --depth=100 cd netdata @@ -323,11 +370,11 @@ cd netdata ./netdata-installer.sh -# make netdata start at boot +# 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 +# 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 @@ -337,17 +384,15 @@ 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 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. -###### Additional Work - -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: +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#netdata-security): +3. Change ownership of the following directories, as defined in [Netdata Security](../../docs/netdata-security.md#security-design): ``` $ chown -R root:netdata /opt/netdata/usr/share/netdata @@ -355,7 +400,7 @@ $ chown -R netdata:netdata /opt/netdata/var/lib/netdata /opt/netdata/var/cache/n $ 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: +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: @@ -364,3 +409,5 @@ Additionally, as of 2018/06/24, the netdata installer doesn't recognize DSM as a # Netdata startup [ -x /etc/rc.netdata ] && /etc/rc.netdata start ``` + +[]() |