manual:installation:install

Differences

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

Link to this comparison view

Next revision
Previous revision
manual:installation:install [2014/09/25 14:42]
sasha Page moved from 2.4:manual:installation:install to manual:installation:install
manual:installation:install [2019/01/21 09:27] (current)
martins-v formatting change
Line 1: Line 1:
-==== Installation from sources ====+==== Installation from sources ====
  
 You can get the very latest version of Zabbix by compiling it from the sources. You can get the very latest version of Zabbix by compiling it from the sources.
Line 9: Line 9:
 == 1 Download the source archive == == 1 Download the source archive ==
  
-Go to the [[http://​www.zabbix.com/​download.php|Zabbix download page]] and download the source archive. Once downloaded, extract the sources, by running:+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-2.2.0.tar.gz+  $ tar -zxvf zabbix-3.4.0.tar.gz
    
 <note tip>​Enter the correct Zabbix version in the command. It must match the name of the downloaded archive.</​note>​ <note tip>​Enter the correct Zabbix version in the command. It must match the name of the downloaded archive.</​note>​
Line 19: Line 19:
 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.  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 Linux systemsrun:+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"​),​
  
-  ​groupadd zabbix +on a RedHat-based system, run: 
-  useradd -g zabbix zabbix+ 
 +  ​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. A separate user account is not required for Zabbix frontend installation.
  
-If Zabbix [[:2.4/manual/concepts/server|server]] and [[:2.4/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.+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>​ <note important>​Running Zabbix as ''​root'',​ ''​bin'',​ or any other account with special rights is a security risk.</​note>​
Line 32: Line 52:
 == 3 Create Zabbix database == == 3 Create Zabbix database ==
  
-For Zabbix [[:2.4/manual/concepts/server|server]] and [[:2.4/manual/concepts/proxy|proxy]] daemons, as well as Zabbix frontend, a database is required. It is not needed to run Zabbix [[:2.4/manual/concepts/agent|agent]].+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 [[:2.4/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.+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. Having created a Zabbix database, proceed to the following steps of compiling Zabbix.
Line 50: Line 70:
   ./configure --enable-server --enable-agent --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-libxml2   ./configure --enable-server --enable-agent --with-mysql --enable-ipv6 --with-net-snmp --with-libcurl --with-libxml2
  
-<​note>​--with-libxml2 ​configuration option is required for virtual machine monitoring, supported since Zabbix 2.2.0.</​note>​+<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: To configure the sources for a Zabbix server (with PostgreSQL etc.), you may run:
Line 64: Line 86:
   ./configure --enable-agent   ./configure --enable-agent
  
-Use can add <​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]].+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>​ <note important>​
-Using <​nowiki>​--enable-static</​nowiki>​ option is not recommended when building server.// //  +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.
- +
-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>​
  
 <​note>​Command-line utilities zabbix_get and zabbix_sender are compiled if %%--enable-agent%% option is used.</​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>​ <​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 == == 5 Make and install everything ==
  
Line 102: Line 131:
 You must specify the database name, user and password (if using any). You must specify 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>​ +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.
- +
-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 [[:2.4/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**   * if you have installed a Zabbix proxy, edit the proxy configuration file **/​usr/​local/​etc/​zabbix_proxy.conf**
Line 140: Line 167:
   * /​usr/​local/​apache2/​htdocs (default directory when installing Apache from source)   * /​usr/​local/​apache2/​htdocs (default directory when installing Apache from source)
   * /​srv/​www/​htdocs (OpenSUSE, SLES)   * /​srv/​www/​htdocs (OpenSUSE, SLES)
-  * /​var/​www/​html (Fedora, RHEL, CentOS+  * /​var/​www/​html (Debian, Ubuntu, ​Fedora, RHEL, CentOS)
-  * /var/www (Debian, Ubuntu)+
   ​   ​
 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: 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:
Line 155: Line 181:
 ''​msgfmt''​ utility from gettext package is required. ​ ''​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 [[:2.4/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>​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>​
  
 == Installing frontend == == Installing frontend ==
Line 165: Line 191:
 You should see the first screen of the frontend installation wizard. You should see the first screen of the frontend installation wizard.
  
-{{:​2.4/​manual/​installation/​install_1.png?​550|}}+{{install_1.png?​550|}}
  
 == Step 2 == == Step 2 ==
Line 171: Line 197:
 Make sure that all software prerequisites are met. Make sure that all software prerequisites are met.
  
-{{:​2.4/​manual/​installation/​install_2.png?​550|}}+{{install_2.png?​550|}}
  
 ^Pre-requisite^Minimum value^Description^ ^Pre-requisite^Minimum value^Description^
-|//PHP version// ​ |5.3.0  |  |+|//PHP version// ​ |5.4.0  |  |
 |//PHP memory_limit option// ​ |128MB ​ |In php.ini:\\ memory_limit = 128M  | |//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 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 upload_max_filesize option// ​ |2MB  |In php.ini:\\ upload_max_filesize = 2M  |
-|//PHP max_execution_time option// ​ |300 seconds ​ |In php.ini:\\ max_execution_time = 300  | +|//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 ​ |In php.ini:\\ max_input_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 | +|//PHP session.auto_start option// ​ |must be disabled ​ |In php.ini:\\ session.auto_start = 0  | 
-|//Database support// ​ |One of: IBM DB2, MySQL, Oracle, PostgreSQL, ​SQLite ​ |One of the following modules must be installed:​\\ ​ibm_db2, ​mysql, oci8, pgsql, ​sqlite3 ​ |+|//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 ​ | |//​bcmath// ​ |  |php-bcmath ​ |
 |//​mbstring// ​ |  |php-mbstring ​ | |//​mbstring// ​ |  |php-mbstring ​ |
-|//PHP mbstring.func_overload option// ​ |must be disabled ​ |In php.ini:\\ mbstring.func_overload = 0 |+|//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. ​  | |//​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>//​). | |//​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>//​). |
Line 196: Line 223:
 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. 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 == == Step 3 ==
  
 Enter details for connecting to the database. Zabbix database must already be created. Enter details for connecting to the database. Zabbix database must already be created.
  
-{{:​2.4/​manual/​installation/​install_3.png?​550|}}+{{install_3.png?​550|}}
  
 == Step 4 == == Step 4 ==
Line 206: Line 234:
 Enter Zabbix server details. Enter Zabbix server details.
  
-{{:​2.4/​manual/​installation/​install_4.png?​550|}}+{{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 == == Step 5 ==
  
 Review a summary of settings. Review a summary of settings.
  
-{{:​2.4/​manual/​installation/​install_5.png?​550|}}+{{install_5.png?​550|}}
  
 == Step 6 == == Step 6 ==
  
-Download the configuration file and place it under conf/.+Download the configuration file and place it under conf/ in the webserver HTML documents subdirectory where you copied Zabbix PHP files to.
  
-{{:​2.4/​manual/​installation/​install_6.png?​550|}}+{{install_6.png?​550|}}
  
-{{:​2.4/​manual/​installation/​saving_zabbix.conf.png|}}+{{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>​ <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>​
Line 227: Line 256:
 Finish the installation. Finish the installation.
  
-{{:​2.4/​manual/​installation/​install_7.png?​550|}}+{{install_7.png?​550|}}
  
 == Step 8 == == Step 8 ==
Line 233: Line 262:
 Zabbix frontend is ready! The default user name is **Admin**, password **zabbix**. Zabbix frontend is ready! The default user name is **Admin**, password **zabbix**.
  
-{{:2.4/manual/quickstart/login.png?550|}} +{{manual:quickstart:login.png?350|}}
- +
-Proceed to [[:​2.4/​manual/​quickstart/​login|getting started with Zabbix]]. +
- +
-==== Troubleshooting ====+
  
-See the section on [[:2.4/manual/​appendix/​install/​troubleshooting|installation-specific issue troubleshooting]].+Proceed to [[manual:​quickstart:​login|getting started with Zabbix]].
  
 ==== See also ==== ==== See also ====
   - [[http://​www.zabbix.org/​wiki/​How_to/​configure_shared_memory|How to configure shared memory for Zabbix daemons]]   - [[http://​www.zabbix.org/​wiki/​How_to/​configure_shared_memory|How to configure shared memory for Zabbix daemons]]