3 # reload the user profile
4 [ -f /etc/profile ] && . /etc/profile
6 # fix PKG_CHECK_MODULES error
7 if [ -d /usr/share/aclocal ]
9 ACLOCAL_PATH=${ACLOCAL_PATH-/usr/share/aclocal}
16 # you can set CFLAGS before running installer
17 CFLAGS="${CFLAGS--O3}"
19 # keep a log of this command
20 printf "\n# " >>netdata-installer.log
21 date >>netdata-installer.log
22 printf "CFLAGS=\"%s\" " "${CFLAGS}" >>netdata-installer.log
23 printf "%q " "$0" "${@}" >>netdata-installer.log
24 printf "\n" >>netdata-installer.log
35 ${ME} <installer options>
37 Valid <installer options> are:
39 --install /PATH/TO/INSTALL
41 If your give: --install /opt
42 netdata will be installed in /opt/netdata
46 Do not (re)start netdata.
51 Do not wait for the user to press ENTER.
52 Start immediately building it.
55 --libs-are-really-here
57 If you get errors about missing zlib,
58 or libuuid but you know it is available,
59 you have a broken pkg-config.
60 Use this option to allow it continue
61 without checking pkg-config.
63 Netdata will by default be compiled with gcc optimization -O3
64 If you need to pass different CFLAGS, use something like this:
66 CFLAGS="<gcc options>" ${ME} <installer options>
68 For the installer to complete successfully, you will need
69 these packages installed:
71 gcc make autoconf automake pkg-config zlib1g-dev (or zlib-devel)
72 uuid-dev (or libuuid-devel)
74 For the plugins, you will at least need:
83 if [ "$1" = "--install" ]
85 NETDATA_PREFIX="${2}/netdata"
87 elif [ "$1" = "--zlib-is-really-here" -o "$1" = "--libs-are-really-here" ]
91 elif [ "$1" = "--dont-start-it" ]
95 elif [ "$1" = "--dont-wait" ]
99 elif [ "$1" = "--help" -o "$1" = "-h" ]
106 echo >&2 "I cannot understand option '$1'."
115 Nice to see you are giving it a try!
117 You are about to build and install netdata to your system.
119 It will be installed at these locations:
121 - the daemon at ${NETDATA_PREFIX}/usr/sbin/netdata
122 - config files at ${NETDATA_PREFIX}/etc/netdata
123 - web files at ${NETDATA_PREFIX}/usr/share/netdata
124 - plugins at ${NETDATA_PREFIX}/usr/libexec/netdata
125 - cache files at ${NETDATA_PREFIX}/var/cache/netdata
126 - db files at ${NETDATA_PREFIX}/var/lib/netdata
127 - log files at ${NETDATA_PREFIX}/var/log/netdata
128 - pid file at ${NETDATA_PREFIX}/var/run
130 This installer allows you to change the installation path.
131 Press Control-C and run the same command with --help for help.
135 if [ "${UID}" -ne 0 ]
137 if [ -z "${NETDATA_PREFIX}" ]
139 cat <<-NONROOTNOPREFIX
141 Sorry! This will fail!
143 You are attempting to install netdata as non-root, but you plan to install it
146 Please set an installation prefix, like this:
148 $0 ${@} --install /tmp
150 or, run the installer as root:
154 We suggest to install it as root, or certain data collectors will not be able
155 to work. Netdata drops root privileges when running. So, if you plan to keep
156 it, install it as root to get the full functionality.
165 You are about to install netdata as a non-root user.
166 Netdata will work, but a few data collection modules that
167 require root access will fail.
169 If you installing permanently on your system, run the
179 if [ "$(type autoreconf 2> /dev/null)" ]
187 set -- $(autoreconf -V | sed -ne '1s/.* \([^ ]*\)$/\1/p')
188 eval $maj=\$1 $min=\$2
190 autoconf_maj_min AMAJ AMIN
195 elif [ "$AMAJ" -eq 2 -a "$AMIN" -ge 60 ]
199 echo "Found autotools $AMAJ.$AMIN"
202 echo "No autotools found"
205 if [ ! "$have_autotools" ]
209 echo "Will skip autoreconf step"
213 -------------------------------------------------------------------------------
214 autotools 2.60 or later is required
216 Sorry, you do not seem to have autotools 2.60 or later, which is
217 required to build from the git sources of netdata.
219 You can either install a suitable version of autotools and automake
220 or download a netdata package which does not have these dependencies.
222 Source packages where autotools have already been run are available
224 https://firehol.org/download/netdata/
226 The unsigned/master folder tracks the head of the git tree and released
227 packages are also available.
233 if [ ${DONOTWAIT} -eq 0 ]
235 if [ ! -z "${NETDATA_PREFIX}" ]
237 read -p "Press ENTER to build and install netdata to '${NETDATA_PREFIX}' > "
239 read -p "Press ENTER to build and install netdata to your system > "
246 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
248 Sorry! NetData failed to build...
250 You many need to check these:
252 1. The package uuid-dev (or libuuid-devel) has to be installed.
254 If your system cannot find libuuid, although it is installed
255 run me with the option: --libs-are-really-here
257 2. The package zlib1g-dev (or zlib-devel) has to be installed.
259 If your system cannot find zlib, although it is installed
260 run me with the option: --libs-are-really-here
262 3. You need basic build tools installed, like:
264 gcc make autoconf automake pkg-config
266 Autoconf version 2.60 or higher is required.
268 If you still cannot get it to build, ask for help at github:
270 https://github.com/firehol/netdata/issues
279 printf >>netdata-installer.log "# "
280 printf >>netdata-installer.log "%q " "${@}"
281 printf >>netdata-installer.log " ... "
284 printf >&2 ":-----------------------------------------------------------------------------\n"
285 printf >&2 "Running command:\n"
287 printf >&2 "%q " "${@}"
295 printf >>netdata-installer.log "FAILED!\n"
297 printf >>netdata-installer.log "OK\n"
303 if [ ${LIBS_ARE_HERE} -eq 1 ]
306 echo >&2 "ok, assuming zlib is really installed."
307 export ZLIB_CFLAGS=" "
308 export ZLIB_LIBS="-lz"
309 export UUID_CFLAGS=" "
310 export UUID_LIBS="-luuid"
313 trap build_error EXIT
315 if [ "$have_autotools" ]
317 run ./autogen.sh || exit 1
321 --prefix="${NETDATA_PREFIX}/usr" \
322 --sysconfdir="${NETDATA_PREFIX}/etc" \
323 --localstatedir="${NETDATA_PREFIX}/var" \
324 --with-zlib --with-math --with-user=netdata \
325 CFLAGS="${CFLAGS}" || exit 1
327 # remove the build_error hook
330 if [ -f src/netdata ]
332 echo >&2 "Cleaning a possibly old compilation ..."
336 echo >&2 "Compiling netdata ..."
339 # backup user configurations
340 for x in apps_groups.conf charts.d.conf
342 if [ -f "${NETDATA_PREFIX}/etc/netdata/${x}" ]
344 cp -p "${NETDATA_PREFIX}/etc/netdata/${x}" "${NETDATA_PREFIX}/etc/netdata/${x}.installer_backup"
348 echo >&2 "Installing netdata ..."
349 run make install || exit 1
351 # restore user configurations
352 for x in apps_groups.conf charts.d.conf
354 if [ -f "${NETDATA_PREFIX}/etc/netdata/${x}.installer_backup" ]
356 cp -p "${NETDATA_PREFIX}/etc/netdata/${x}.installer_backup" "${NETDATA_PREFIX}/etc/netdata/${x}"
360 NETDATA_ADDED_TO_DOCKER=0
363 getent group netdata > /dev/null
366 echo >&2 "Adding netdata user group ..."
367 run groupadd -r netdata
370 getent passwd netdata > /dev/null
373 echo >&2 "Adding netdata user account ..."
374 run useradd -r -g netdata -c netdata -s /sbin/nologin -d / netdata
377 getent group docker > /dev/null
380 # find the users in the docker group
381 docker=$(getent group docker | cut -d ':' -f 4)
382 if [[ ",${docker}," =~ ,netdata, ]]
384 # netdata is already there
387 # netdata is not in docker group
388 echo >&2 "Adding netdata user to the docker group (needed to get container names) ..."
389 run usermod -a -G docker netdata
391 # let the uninstall script know
392 NETDATA_ADDED_TO_DOCKER=1
397 # -----------------------------------------------------------------------------
398 # load options from the configuration file
400 # create an empty config if it does not exist
401 [ ! -f "${NETDATA_PREFIX}/etc/netdata/netdata.conf" ] && touch "${NETDATA_PREFIX}/etc/netdata/netdata.conf"
403 # function to extract values from the config file
405 local key="${1}" value="${2}" line=
407 if [ -s "${NETDATA_PREFIX}/etc/netdata/netdata.conf" ]
409 line="$( grep "^[[:space:]]*${key}[[:space:]]*=[[:space:]]*" "${NETDATA_PREFIX}/etc/netdata/netdata.conf" | head -n 1 )"
410 [ ! -z "${line}" ] && value="$( echo "${line}" | cut -d '=' -f 2 | sed -e "s/^[[:space:]]\+//g" -e "s/[[:space:]]\+$//g" )"
418 [ ! "${UID}" = "0" ] && defuser="${USER}"
419 NETDATA_USER="$( config_option "run as user" "${defuser}" )"
421 NETDATA_WEB_USER="$( config_option "web files owner" "${defuser}" )"
422 NETDATA_WEB_GROUP="$( config_option "web files group" "${NETDATA_WEB_USER}" )"
426 NETDATA_DEBUG="$( config_option "debug flags" ${defdebug} )"
430 NETDATA_PORT="$( config_option "port" ${defport} )"
433 NETDATA_LIB_DIR="$( config_option "lib directory" "${NETDATA_PREFIX}/var/lib/netdata" )"
434 NETDATA_CACHE_DIR="$( config_option "cache directory" "${NETDATA_PREFIX}/var/cache/netdata" )"
435 NETDATA_WEB_DIR="$( config_option "web files directory" "${NETDATA_PREFIX}/usr/share/netdata/web" )"
436 NETDATA_LOG_DIR="$( config_option "log directory" "${NETDATA_PREFIX}/var/log/netdata" )"
437 NETDATA_CONF_DIR="$( config_option "config directory" "${NETDATA_PREFIX}/etc/netdata" )"
438 NETDATA_BIND="$( config_option "bind socket to IP" "*" )"
439 NETDATA_RUN_DIR="${NETDATA_PREFIX}/var/run"
442 # -----------------------------------------------------------------------------
443 # prepare the directories
445 # this is needed if NETDATA_PREFIX is not empty
446 if [ ! -d "${NETDATA_RUN_DIR}" ]
448 mkdir -p "${NETDATA_RUN_DIR}" || exit 1
451 echo >&2 "Fixing directories (user: ${NETDATA_USER})..."
452 for x in "${NETDATA_WEB_DIR}" "${NETDATA_CONF_DIR}" "${NETDATA_CACHE_DIR}" "${NETDATA_LOG_DIR}" "${NETDATA_LIB_DIR}"
456 echo >&2 "Creating directory '${x}'"
457 run mkdir -p "${x}" || exit 1
462 if [ "${x}" = "${NETDATA_WEB_DIR}" ]
464 run chown -R "${NETDATA_WEB_USER}:${NETDATA_WEB_GROUP}" "${x}" || echo >&2 "WARNING: Cannot change the ownership of the files in directory ${x} to ${NETDATA_WEB_USER}:${NETDATA_WEB_GROUP}..."
466 run chown -R "${NETDATA_USER}:${NETDATA_USER}" "${x}" || echo >&2 "WARNING: Cannot change the ownership of the files in directory ${x} to ${NETDATA_USER}..."
470 run chmod 0755 "${x}" || echo >&2 "WARNING: Cannot change the permissions of the directory ${x} to 0755..."
475 run chown root "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
476 run chmod 0755 "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
477 run setcap cap_dac_read_search,cap_sys_ptrace+ep "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
480 # fix apps.plugin to be setuid to root
481 run chown root "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
482 run chmod 4755 "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
486 # -----------------------------------------------------------------------------
487 # check if we can re-start netdata
489 if [ ${DONOTSTART} -eq 1 ]
491 if [ ! -s "${NETDATA_PREFIX}/etc/netdata/netdata.conf" ]
493 echo >&2 "Generating empty config file in: ${NETDATA_PREFIX}/etc/netdata/netdata.conf"
494 echo "# Get config from http://127.0.0.1:${NETDATA_PORT}/netdata.conf" >"${NETDATA_PREFIX}/etc/netdata/netdata.conf"
496 if [ "${UID}" -eq 0 ]
498 chown "${NETDATA_USER}" "${NETDATA_PREFIX}/etc/netdata/netdata.conf"
500 chmod 0664 "${NETDATA_PREFIX}/etc/netdata/netdata.conf"
502 echo >&2 "OK. It is now installed and ready."
506 # -----------------------------------------------------------------------------
507 # stop a running netdata
510 [ -z "$1" -o ! -f "/proc/$1/stat" ] && return 1
511 [ "$(cat "/proc/$1/stat" | cut -d '(' -f 2 | cut -d ')' -f 1)" = "netdata" ] && return 0
517 echo >&2 "-------------------------------------------------------------------------------"
519 printf >&2 "Stopping a (possibly) running netdata..."
526 echo >&2 "Cannot stop the running netdata."
532 pid=$(cat "${NETDATA_RUN_DIR}/netdata.pid" 2>/dev/null)
533 # backwards compatibility
534 [ -z "${pid}" ] && pid=$(cat /var/run/netdata.pid 2>/dev/null)
535 [ -z "${pid}" ] && pid=$(cat /var/run/netdata/netdata.pid 2>/dev/null)
537 isnetdata $pid || pid=
540 run kill $pid 2>/dev/null
543 run killall netdata 2>/dev/null
547 test $ret -eq 0 && printf >&2 "." && sleep 2
553 # -----------------------------------------------------------------------------
556 echo >&2 "Starting netdata..."
557 run ${NETDATA_PREFIX}/usr/sbin/netdata -pidfile ${NETDATA_RUN_DIR}/netdata.pid "${@}"
562 echo >&2 "SORRY! FAILED TO START NETDATA!"
565 echo >&2 "OK. NetData Started!"
570 # -----------------------------------------------------------------------------
571 # save a config file, if it is not already there
573 if [ ! -s "${NETDATA_PREFIX}/etc/netdata/netdata.conf" ]
576 echo >&2 "-------------------------------------------------------------------------------"
578 echo >&2 "Downloading default configuration from netdata..."
581 # remove a possibly obsolete download
582 [ -f "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new" ] && rm "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new"
584 # disable a proxy to get data from the local netdata
589 wget 2>/dev/null -O "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new" "http://localhost:${NETDATA_PORT}/netdata.conf"
593 if [ $ret -ne 0 -o ! -s "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new" ]
595 curl -s -o "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new" "http://localhost:${NETDATA_PORT}/netdata.conf"
599 if [ $ret -eq 0 -a -s "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new" ]
601 mv "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new" "${NETDATA_PREFIX}/etc/netdata/netdata.conf"
602 echo >&2 "New configuration saved for you to edit at ${NETDATA_PREFIX}/etc/netdata/netdata.conf"
604 if [ "${UID}" -eq 0 ]
606 chown "${NETDATA_USER}" "${NETDATA_PREFIX}/etc/netdata/netdata.conf"
608 chmod 0664 "${NETDATA_PREFIX}/etc/netdata/netdata.conf"
610 echo >&2 "Cannnot download configuration from netdata daemon using url 'http://localhost:${NETDATA_PORT}/netdata.conf'"
611 [ -f "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new" ] && rm "${NETDATA_PREFIX}/etc/netdata/netdata.conf.new"
615 # -----------------------------------------------------------------------------
618 ksm_is_available_but_disabled() {
621 -------------------------------------------------------------------------------
622 Memory de-duplication instructions
624 I see you have kernel memory de-duper (called Kernel Same-page Merging,
625 or KSM) available, but it is not currently enabled.
629 echo 1 >/sys/kernel/mm/ksm/run
630 echo 1000 >/sys/kernel/mm/ksm/sleep_millisecs
632 If you enable it, you will save 40-60% of netdata memory.
637 ksm_is_not_available() {
640 -------------------------------------------------------------------------------
641 Memory de-duplication not present in your kernel
643 It seems you do not have kernel memory de-duper (called Kernel Same-page
644 Merging, or KSM) available.
646 To enable it, you need a kernel built with CONFIG_KSM=y
648 If you can have it, you will save 40-60% of netdata memory.
653 if [ -f "/sys/kernel/mm/ksm/run" ]
655 if [ $(cat "/sys/kernel/mm/ksm/run") != "1" ]
657 ksm_is_available_but_disabled
663 # -----------------------------------------------------------------------------
664 # Check for version.txt
666 if [ ! -s web/version.txt ]
670 -------------------------------------------------------------------------------
671 Version update check warning
673 The way you downloaded netdata, we cannot find its version. This means the
674 Update check on the dashboard, will not work.
676 If you want to have version update check, please re-install it
677 following the procedure in:
679 https://github.com/firehol/netdata/wiki/Installation
684 # -----------------------------------------------------------------------------
685 # apps.plugin warning
687 if [ "${UID}" -ne 0 ]
689 cat <<-SETUID_WARNING
691 -------------------------------------------------------------------------------
692 apps.plugin needs privileges
694 Since you have installed netdata as a normal user, to have apps.plugin collect
695 all the needed data, you have to give it the access rights it needs, by running
696 either of the following sets of commands:
698 To run apps.plugin with escalated capabilities:
700 sudo chown root:${NETDATA_USER} "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
701 sudo chmod 0750 "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
702 sudo setcap cap_dac_read_search,cap_sys_ptrace+ep "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
704 or, to run apps.plugin as root:
706 sudo chown root "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
707 sudo chmod 4755 "${NETDATA_PREFIX}/usr/libexec/netdata/plugins.d/apps.plugin"
709 These commands allow apps.plugin to run as root.
711 apps.plugin is performing a hard-coded function of data collection for all
712 running processes. It cannot be instructed from the netdata daemon to perform
713 any task, so it is pretty safe to do this.
718 # -----------------------------------------------------------------------------
719 # Keep un-install info
721 cat >netdata-uninstaller.sh <<-UNINSTALL
724 # this script will uninstall netdata
726 if [ "\$1" != "--force" ]
728 echo >&2 "This script will REMOVE netdata from your system."
729 echo >&2 "Run it again with --force to do it."
733 echo >&2 "Stopping a possibly running netdata..."
738 if [ ! -z "\$1" -a -d "\$1" ]
741 echo "Deleting directory '\$1' ..."
746 if [ ! -z "${NETDATA_PREFIX}" -a -d "${NETDATA_PREFIX}" ]
748 # installation prefix was given
750 deletedir "${NETDATA_PREFIX}"
753 # installation prefix was NOT given
755 if [ -f "${NETDATA_PREFIX}/usr/sbin/netdata" ]
757 echo "Deleting ${NETDATA_PREFIX}/usr/sbin/netdata ..."
758 rm -i "${NETDATA_PREFIX}/usr/sbin/netdata"
761 deletedir "${NETDATA_PREFIX}/etc/netdata"
762 deletedir "${NETDATA_PREFIX}/usr/share/netdata"
763 deletedir "${NETDATA_PREFIX}/usr/libexec/netdata"
764 deletedir "${NETDATA_PREFIX}/var/lib/netdata"
765 deletedir "${NETDATA_PREFIX}/var/cache/netdata"
766 deletedir "${NETDATA_PREFIX}/var/log/netdata"
769 getent passwd netdata > /dev/null
773 echo "You may also want to remove the user netdata"
775 echo " userdel netdata"
778 getent group netdata > /dev/null
782 echo "You may also want to remove the group netdata"
784 echo " groupdel netdata"
787 getent group docker > /dev/null
788 if [ $? -eq 0 -a "${NETDATA_ADDED_TO_DOCKER}" = "1" ]
791 echo "You may also want to remove the netdata user from the docker group"
793 echo " gpasswd -d netdata docker"
797 chmod 750 netdata-uninstaller.sh
799 # -----------------------------------------------------------------------------
801 if [ "${NETDATA_BIND}" = "*" ]
805 access="${NETDATA_BIND}"
811 -------------------------------------------------------------------------------
813 OK. NetData is installed and it is running (listening to ${NETDATA_BIND}:${NETDATA_PORT}).
815 -------------------------------------------------------------------------------
818 Hit http://${access}:${NETDATA_PORT}/ from your browser.
820 To stop netdata, just kill it, with:
824 To start it, just run it:
826 ${NETDATA_PREFIX}/usr/sbin/netdata
832 echo >&2 "Uninstall script generated: ./netdata-uninstaller.sh"