Zabbix Documentation 4.0

3.04.04.2 (current)In development:4.4 (devel)Unsupported:1.82.02.22.43.23.4

User Tools

Site Tools


manual:installation:install

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Previous revision
Next revision Both sides next revision
manual:installation:install [2019/01/21 09:37]
manual:installation:install [2019/05/10 07:44]
martins-v write permissions to the assets directory are required for the web server user
Line 1: Line 1:
 +==== 3 Installation from sources ====
 +
 +You can get the very latest version of Zabbix by compiling it from the sources.
 +
 +A step-by-step tutorial for installing Zabbix from the sources is provided here.
 +
 +=== - Installing Zabbix daemons ===
 +
 +== 1 Download the source archive ==
 +
 +Go to the [[http://​www.zabbix.com/​download_sources|Zabbix download page]] and download the source archive. Once downloaded, extract the sources, by running:
 +
 +  $ tar -zxvf zabbix-4.0.0.tar.gz
 + 
 +<note tip>​Enter the correct Zabbix version in the command. It must match the name of the downloaded archive.</​note>​
 +
 +== 2 Create user account ==
 +
 +For all of the Zabbix daemon processes, an unprivileged user is required. If a Zabbix daemon is started from an unprivileged user account, it will run as that user. 
 +
 +However, if a daemon is started from a '​root'​ account, it will switch to a '​zabbix'​ user account, which must be present. To create such a user account (in its own group, "​zabbix"​),​
 +
 +on a RedHat-based system, run:
 +
 +  groupadd --system zabbix
 +  useradd --system -g zabbix -d /​usr/​lib/​zabbix -s /​sbin/​nologin -c "​Zabbix Monitoring System"​ zabbix
 +
 +on a Debian-based system, run:
 +
 +  addgroup --system --quiet zabbix
 +  adduser --quiet --system --disabled-login --ingroup zabbix --home /​var/​lib/​zabbix --no-create-home zabbix
 +
 +<note important>​Zabbix processes do not need a home directory, which is why we do not recommend creating it. However, if you are using some functionality that requires it (e. g. store MySQL credentials in ''​$HOME/​.my.cnf''​) you are free to create it using the following commands.\\ \\ 
 +
 +On RedHat-based systems, run:
 +
 +  mkdir -m u=rwx,​g=rwx,​o= -p /​usr/​lib/​zabbix
 +  chown zabbix:​zabbix /​usr/​lib/​zabbix
 +
 +On Debian-based systems, run:
 +
 +  mkdir -m u=rwx,​g=rwx,​o= -p /​var/​lib/​zabbix
 +  chown zabbix:​zabbix /​var/​lib/​zabbix
 +</​note>​
 +
 +A separate user account is not required for Zabbix frontend installation.
 +
 +If Zabbix [[manual:​concepts:​server|server]] and [[manual:​concepts:​agent|agent]] are run on the same machine it is recommended to use a different user for running the server than for running the agent. Otherwise, if both are run as the same user, the agent can access the server configuration file and any Admin level user in Zabbix can quite easily retrieve, for example, the database password.
 +
 +<note important>​Running Zabbix as ''​root'',​ ''​bin'',​ or any other account with special rights is a security risk.</​note>​
 +
 +== 3 Create Zabbix database ==
 +
 +For Zabbix [[manual:​concepts:​server|server]] and [[manual:​concepts:​proxy|proxy]] daemons, as well as Zabbix frontend, a database is required. It is not needed to run Zabbix [[manual:​concepts:​agent|agent]].
 +
 +SQL [[manual:​appendix:​install:​db_scripts|scripts are provided]] for creating database schema and inserting the dataset. Zabbix proxy database needs only the schema while Zabbix server database requires also the dataset on top of the schema.
 +
 +Having created a Zabbix database, proceed to the following steps of compiling Zabbix.
 +
 +== 4 Configure the sources ==
 +
 +When configuring the sources for a Zabbix server or proxy, you must specify the database type to be used. Only one database type can be compiled with a server or proxy process at a time. 
 +
 +To see all of the supported configuration options, inside the extracted Zabbix source directory run:
 +
 +  ./configure --help
 +
 +To configure the sources for a Zabbix server and agent, you may run something like:
 +
 +  ./configure --enable-server --enable-agent --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-libxml2
 +
 +<​note><​nowiki>​--with-libcurl</​nowiki>​ configuration option with cURL 7.20.0 or higher is required for SMTP authentication,​ supported since Zabbix 3.0.0.\\ <​nowiki>​--with-libcurl</​nowiki>​ and <​nowiki>​--with-libxml2</​nowiki>​ configuration options are required for virtual machine monitoring, supported since Zabbix 2.2.0.</​note>​
 +
 +<note important>​Since version 3.4 Zabbix will always compile with the PCRE library; installing it is not optional. %%--with-libpcre=[DIR]%% only allows pointing to a specific base install directory, instead of searching through a number of common places for the libpcre files.</​note>​
 +
 +To configure the sources for a Zabbix server (with PostgreSQL etc.), you may run:
 +
 +  ./configure --enable-server --with-postgresql --with-net-snmp
 +
 +To configure the sources for a Zabbix proxy (with SQLite etc.), you may run:
 +
 +  ./configure --prefix=/​usr --enable-proxy --with-net-snmp --with-sqlite3 --with-ssh2
 +
 +To configure the sources for a Zabbix agent, you may run:
 +
 +  ./configure --enable-agent
 +
 +You may use the <​nowiki>​--enable-static</​nowiki>​ flag to statically link libraries. If you plan to distribute compiled binaries among different servers, you must use this flag to make these binaries work without required libraries. Note that <​nowiki>​--enable-static</​nowiki>​ [[http://​blogs.sun.com/​rie/​entry/​static_linking_where_did_it|does not work under Solaris]].
 +
 +<note important>​
 +Using <​nowiki>​--enable-static</​nowiki>​ option is not recommended when building server.\\ \\ In order to build the server statically you must have a static version of every external library needed. There is no strict check for that in configure script.
 +</​note>​
 +
 +<​note>​Command-line utilities zabbix_get and zabbix_sender are compiled if %%--enable-agent%% option is used.</​note>​
 +
 +<​note>​
 +Add optional path to the MySQL configuration file <​nowiki>​--with-mysql=/<​path_to_the_file>/​mysql_config</​nowiki>​ to select the desired
 +MySQL client library when there is a need to use one that is not located in the default location.
 +
 +It is useful when there are several versions of MySQL installed or MariaDB installed alongside MySQL on the same system.
 +</​note>​
 +
 +<​note>​Use <​nowiki>​--with-ibm-db2</​nowiki>​ flag to specify location of the CLI API.\\ Use <​nowiki>​--with-oracle</​nowiki>​ flag to specify location of the OCI API.</​note>​
 +
 +For encryption support see [[manual:​encryption#​compiling_zabbix_with_encryption_support|Compiling Zabbix with encryption support]].
 +== 5 Make and install everything ==
 +
 +<​note>​If installing from SVN, it is required to run first:
 +
 +''​$ make dbschema''​
 +</​note>​
 +
 +  make install
 +
 +This step should be run as a user with sufficient permissions (commonly '​root',​ or by using ''​sudo''​).
 +
 +Running ''​make install''​ will by default install the daemon binaries (zabbix_server,​ zabbix_agentd,​ zabbix_proxy) in /​usr/​local/​sbin and the client binaries (zabbix_get,​ zabbix_sender) in /​usr/​local/​bin.
 +
 +<​note>​To specify a different location than /usr/local, use a <​nowiki>​--prefix</​nowiki>​ key in the previous step of configuring sources, for example <​nowiki>​--prefix=/​home/​zabbix</​nowiki>​. In this case daemon binaries will be installed under <​prefix>/​sbin,​ while utilities under <​prefix>/​bin. Man pages will be installed under <​prefix>/​share.</​note>​
 +
 +== 6 Review and edit configuration files ==
 +
 +  * edit the Zabbix agent configuration file **/​usr/​local/​etc/​zabbix_agentd.conf** ​
 +
 +You need to configure this file for every host with zabbix_agentd installed. ​
 +
 +You must specify the Zabbix server **IP address** in the file. Connections from other hosts will be denied.
 +
 +  * edit the Zabbix server configuration file **/​usr/​local/​etc/​zabbix_server.conf**
 +
 +You must specify the database name, user and password (if using any).
 +
 +The rest of the parameters will suit you with their defaults if you have a small installation (up to ten monitored hosts). You should change the default parameters if you want to maximize the performance of Zabbix server (or proxy) though. See the [[manual:​appendix:​performance_tuning|performance tuning]] section for more details.
 +
 +  * if you have installed a Zabbix proxy, edit the proxy configuration file **/​usr/​local/​etc/​zabbix_proxy.conf**
 +
 +You must specify the server IP address and proxy hostname (must be known to the server), as well as the database name, user and password (if using any).
 +
 +<​note>​With SQLite the full path to database file must be specified; DB user and password are not required.</​note>​
 +
 +== 7 Start up the daemons ==
 +
 +Run zabbix_server on the server side. 
 +
 +  shell> zabbix_server
 +  ​
 +<​note>​Make sure that your system allows allocation of 36MB (or a bit more) of shared memory, otherwise the server may not start and you will see "​Cannot allocate shared memory for <type of cache>​."​ in the server log file. This may happen on FreeBSD, Solaris 8.\\ See the [[#​see_also|"​See also"​]] section at the bottom of this page to find out how to configure shared memory.</​note>​
 +
 +Run zabbix_agentd on all the monitored machines. ​
 +
 +  shell> zabbix_agentd
 +
 +<​note>​Make sure that your system allows allocation of 2MB of shared memory, otherwise the agent may not start and you will see "​Cannot allocate shared memory for collector."​ in the agent log file. This may happen on Solaris 8.</​note>​
 +
 +If you have installed Zabbix proxy, run zabbix_proxy. ​
 +
 +  shell> zabbix_proxy
 +
 +=== - Installing Zabbix web interface ===
 +
 +== Copying PHP files ==
 +
 +Zabbix frontend is written in PHP, so to run it a PHP supported webserver is needed. Installation is done by simply copying the PHP files from frontends/​php to the webserver HTML documents directory. ​
 +
 +Common locations of HTML documents directories for Apache web servers include:
 +
 +  * /​usr/​local/​apache2/​htdocs (default directory when installing Apache from source)
 +  * /​srv/​www/​htdocs (OpenSUSE, SLES)
 +  * /​var/​www/​html (Debian, Ubuntu, Fedora, RHEL, CentOS)
 +  ​
 +It is suggested to use a subdirectory instead of the HTML root. To create a subdirectory and copy Zabbix frontend files into it, execute the following commands, replacing the actual directory:
 +
 +  mkdir <​htdocs>/​zabbix
 +  cd frontends/​php
 +  cp -a . <​htdocs>/​zabbix
 +
 +If installing from SVN and planning to use any other language than English, you must generate translation files. To do so, run:
 +
 +  locale/​make_mo.sh
 + 
 +''​msgfmt''​ utility from gettext package is required. ​
 +
 +<​note>​Additionally,​ to use any other language than English, its locale should be installed on the web server. See the [[manual:​web_interface:​user_profile#​see_also|"​See also"​]] section in the "User profile"​ page to find out how to install it if required.</​note>​
 +
 +<note important>​Since Zabbix 4.0.8, //write// permissions to the ''​assets''​ directory are required for the web server user.</​note>​
 +
 +== Installing frontend ==
 +
 +== Step 1 ==
 +
 +In your browser, open Zabbix URL: http:<​nowiki>//</​nowiki><​server_ip_or_name>/​zabbix
 +
 +You should see the first screen of the frontend installation wizard.
 +
 +{{install_1_a.png?​550|}}
 +
 +== Step 2 ==
 +
 +Make sure that all software prerequisites are met.
 +
 +{{install_2.png?​550|}}
 +
 +^Pre-requisite^Minimum value^Description^
 +|//PHP version// ​ |5.4.0 ​ |  |
 +|//PHP memory_limit option// ​ |128MB ​ |In php.ini:\\ memory_limit = 128M  |
 +|//PHP post_max_size option// ​ |16MB  |In php.ini:\\ post_max_size = 16M  |
 +|//PHP upload_max_filesize option// ​ |2MB  |In php.ini:\\ upload_max_filesize = 2M  |
 +|//PHP max_execution_time option// ​ | 300 seconds (values 0 and -1 are allowed) |In php.ini:\\ max_execution_time = 300  |
 +|//PHP max_input_time option// ​ |300 seconds (values 0 and -1 are allowed) |In php.ini:\\ max_input_time = 300  |
 +|//PHP session.auto_start option// ​ |must be disabled ​ |In php.ini:\\ session.auto_start = 0  |
 +|//Database support// ​ |One of: MySQL, Oracle, PostgreSQL, IBM DB2  |One of the following modules must be installed:​\\ mysql, oci8, pgsql, ibm_db2 ​ |
 +|//​bcmath// ​ |  |php-bcmath ​ |
 +|//​mbstring// ​ |  |php-mbstring ​ |
 +|//PHP mbstring.func_overload option// ​ |must be disabled ​ |In php.ini:\\ mbstring.func_overload = 0  |
 +|//PHP always_populate_raw_post_data option// ​ |must be disabled ​ |Required only for PHP versions 5.6.0 or newer.\\ In php.ini:\\ always_populate_raw_post_data = -1 |
 +|//​sockets// ​ |  |php-net-socket. Required for user script support. ​  |
 +|//​gd// ​ |2.0 or higher ​ |php-gd. PHP GD extension must support PNG images (//<​nowiki>​--with-png-dir</​nowiki>//​),​ JPEG (//<​nowiki>​--with-jpeg-dir</​nowiki>//​) images and FreeType 2 (//<​nowiki>​--with-freetype-dir</​nowiki>//​). |
 +|//​libxml// ​ |2.6.15 ​ |php-xml or php5-dom ​ |
 +|//​xmlwriter// ​ |  |php-xmlwriter ​ |
 +|//​xmlreader// ​ |  |php-xmlreader ​ |
 +|//​ctype// ​ |  |php-ctype ​ |
 +|//​session// ​ |  |php-session ​ |
 +|//​gettext// ​ |  |php-gettext\\ Since Zabbix 2.2.1, the PHP gettext extension is not a mandatory requirement for installing Zabbix. If gettext is not installed, the frontend will work as usual, however, the translations will not be available. ​ |
 +
 +Optional pre-requisites may also be present in the list. A failed optional prerequisite is displayed in orange and has a //Warning// status. With a failed optional pre-requisite,​ the setup may continue.
 +
 +<note important>​If there is a need to change the Apache user or user group, permissions to the session folder must be verified. Otherwise Zabbix setup may be unable to continue.</​note>​
 +== Step 3 ==
 +
 +Enter details for connecting to the database. Zabbix database must already be created.
 +
 +{{install_3.png?​550|}}
 +
 +== Step 4 ==
 +
 +Enter Zabbix server details.
 +
 +{{install_4.png?​550|}}
 +
 +Entering a name for Zabbix server is optional, however, if submitted, it will be displayed in the menu bar and page titles.
 +
 +== Step 5 ==
 +
 +Review a summary of settings.
 +
 +{{install_5.png?​550|}}
 +
 +== Step 6 ==
 +
 +Download the configuration file and place it under conf/ in the webserver HTML documents subdirectory where you copied Zabbix PHP files to.
 +
 +{{install_6.png?​550|}}
 +
 +{{saving_zabbix_conf.png?​350|}}
 +
 +<note tip>​Providing the webserver user has write access to conf/ directory the configuration file would be saved automatically and it would be possible to proceed to the next step right away.</​note>​
 +== Step 7 ==
 +
 +Finish the installation.
 +
 +{{install_7.png?​550|}}
 +
 +== Step 8 ==
 +
 +Zabbix frontend is ready! The default user name is **Admin**, password **zabbix**.
 +
 +{{manual:​quickstart:​login.png?​350|}}
 +
 +Proceed to [[manual:​quickstart:​login|getting started with Zabbix]].
 +
 +=== 3 Installing Java gateway ==
 +
 +It is required to install Java gateway only if you want to monitor JMX applications. Java gateway is lightweight and does not require a database.  ​
 +
 +To install from sources, first [[:​manual/​installation/​install#​download_the_source_archive|download]] and extract the source archive.
 +
 +To compile Java gateway, run the ''​./​configure''​ script with ''​%%--enable-java%%''​ option. It is advisable that you specify the ''​%%--prefix%%''​ option to request installation path other than the default /usr/local, because installing Java gateway will create a whole directory tree, not just a single executable.
 +
 +  $ ./configure --enable-java --prefix=$PREFIX
 +
 +To compile and package Java gateway into a JAR file, run ''​make''​. Note that for this step you will need ''​javac''​ and ''​jar''​ executables in your path.
 +
 +  $ make
 +
 +Now you have a zabbix-java-gateway-$VERSION.jar file in src/​zabbix_java/​bin. If you are comfortable with running Java gateway from src/​zabbix_java in the distribution directory, then you can proceed to instructions for configuring and running [[:​manual/​concepts/​java#​overview_of_files_in_java_gateway_distribution|Java gateway]]. Otherwise, make sure you have enough privileges and run ''​make install''​.
 +
 +  $ make install
 +
 +Proceed to [[:​manual/​concepts/​java/​from_sources|setup]] for more details on configuring and running Java gateway.
 +
 +==== See also ====
 +  - [[http://​www.zabbix.org/​wiki/​How_to/​configure_shared_memory|How to configure shared memory for Zabbix daemons]]