Table of Contents

Installation Using Windows Installer

If you install the MySQL version using Bitrix Environment, you will not have to install any additional software manually. A simple and easy-to-use installer will automatically install the following applications to your PC:

  • MySQL 5.1.51;
  • Apache 2.2.15;
  • PHP 5.3.2;
  • Catdoc - MS Office file indexing;
  • xpdf- Adobe PDF file indexing;
  • msmtp E-Mail Manager.

Bitrix Environment copies the application files to an isolated folder. Bitrix Environment helper applications will not conflict with any existing installations of MySQL, Apache or PHP.

Your system should meet the following minimum requiremets to install and run Bitrix24 Self-hosted:

  • Windows 98/ME/NT/2000/XP/2003/Vista/2008 Server;
  • 100 Mb of free disk space;
  • Internet connection if you install using the downloaded Bitrix Environment package.

Setup operations

You can always download the latest version at http://www.bitrixsoft.com/download/intranet/download_intranet.php#tab-local-link or http://www.bitrixsoft.com/download/sources.php. Choose the required installation version.

Run the downloaded file. The initial screen of the installation wizard will open.

The installation wizard will help you install the system taking as less time and efforts as possible. It will:

  • If required, download and install Bitrix Web Environment;
  • Install Bitrix24.

Use the Next and Back buttons to navigate through the wizard steps. The Back button allows you to return to a previous step if you need to change the installation preferences. If you want to abort the installation, click Cancel.

Bitrix24 Installation Wizard

Step 1. The Initial Installation Screen

The first step of the installation wizard

The first wizard window informs you that the installation is starting and displays the basic information about the product.

  • Click Next. This will open the next step containing the Bitrix24 License Agreement.

Step 2. The License Agreement

The License Agreement

Read the Agreement carefully. If you accept the license terms, check the I accept the agreement box. You must accept the License Agreement to continue installation. Click Next to open the next window of the Wizard.

Step 3. Bitrix Environment and Encoding

Setting up Bitrix Environment

If you do not have Bitrix Environment installed on your machine, do the following:

  • Enable the Install Bitrix Environment option.

This will download and run bitrix_env.exe, the Bitrix Environment package (see Installing Bitrix Web Environment) which will install all the required third-party software: MySQL 5.0.51, Apache 2.2.15, PHP 5.3.2, Catdoc - MS Office file indexing, xpdf- Adobe PDF file indexing, msmtp E-Mail Manager.

Important: If you refuse to install Bitrix Environment, the wizard will proceed to the destination folder selection step. In this case, you will have to install all the required software manually. However, if, having installed Bitrix24 you find that you cannot install these applications without assistance, simply run the Wizard again.
  • If you plan to use multiple languages on your site, enable UTF-8 encoding.
  • Click Next.

If you have previously installed Bitrix Environment package, uncheck the Install Bitrix Environment option. Confirm that you do not want to download and install it:

Bitrix Environment installation warning

This will open the destination folder selection window.

Destination folder selection

  • Specify the folder in which the Bitrix24 files will be unpacked and click Next.

The installation confirmation window will appear.

The installation confirmation window

Review all settings. At this step, you still can change them if required by clicking Back.

  • Click Install. The installation progress window will show (step 5).

Step 4. Ready to Install

This window displays a summary of the installation preferences you have specified in the previous steps. Click Back if you need to change settings.

Installation information

  • If you accept the proposed settings, click Install to start installation.

If you have chosen to download and install Bitrix Environment, the web environment installation wizard will start (see Installing Bitrix Web Environment). When it completes, the step 5 will follow.

Step 5. Copying Files

The installation of Bitrix24 is now starting.

Installing Bitrix24

When the installation completes, the last window will open notifying that all the files have been copied successfully.

Step 6. Final Step

The final step of the installation

This window informs that Bitrix24 files have been successfully copied to your machine.

  • To run Bitrix24 right after closing the installation wizard, enable the Run Bitrix24 option.
  • Click Finish to quit the wizard.

Running Bitrix24

The First Run

When the system is starting, it opens a browser window in which you will continue the installation and configuration of Bitrix24:

  • If the product is installed jointly with the Bitrix Web Environment package, the installation of the product will start at the fourth step (Product registration) of the Installation Wizard.
  • If the product is installed in a separately installed Bitrix Web Environment, the Installation Wizard will start at the first step.

Subsequent Runs

You can run Bitrix24:

  • by activating the shortcut on the Desktop (if you have chosen to create it);
  • by running BitrixEnv.exe located in the system installation folder (e.g. C:\Program Files\Bitrix Environment\).

Using the Taskbar Icon

After the system has been launched, the Bitrix Web Environment icon becomes visible in the system tray.

When visible, this icon indicates that all the applications required by the system are up and running. You can now start working with Bitrix24.

Right-click on the icon to bring up the context menu.

The menu includes the following commands:

  • Open:opens the public section (i.e. the index page visible to visitors) of the site in your browser;
  • Settings: go to the start-up settings of the Bitrix applications;
  • Environment: go to the menu where you can start, stop, or restart the Bitrix Web Environment service.
  • About product: navigates to the Bitrix company site;
  • Exit: closes all the applications required by Bitrix24 (web server, database etc.).

System requirements

Server software requirements

PHP enabled web server

Apache (recommended) – the Bitrix software was developed for Apache 2.0 and higher.


PHP

Bitrix Site Manager and Bitrix24 require PHP version 5.3.x or higher. It is recommended that you use the latest stable release of PHP to prevent PHP failures and to provide the maximum security at the server side.

The following PHP extensions are required:

  • GD – image handling library. Required for building graphs and charts which is essential for the Statistics, Advertising and Helpdesk modules. The library is also used with CAPTCHA.
  • PHP XML – used by the update system. This library is inluded in the standard installation package of PHP. The Windows version of PHP has a built-in XML support.
  • FreeType – required for the correct functioning of CAPTCHA.
  • Regular Expression support (POSIX and Perl compatible) – the system requires the regular expression support at the core level.
  • Zlib compression – the compression library is required by the Compression module and the update system to decrease the amount of transferred data.
  • PHP accelerator is highly recommended, for example OPcache or XCache, in order to significantly speed up the operation of PHP applications.

    Attention: eAccelerator is not compatible with PHP v5.3+ and is not supported any longer in Bitrix products starting from Kernel module version 15.0.13.

Note. UTF-8 is available for Oracle and MySQL. To ensure the correct support of UTF encryption, check if the mbstring module is installed in PHP. In this context, the php.ini file in the PHP settings must include:
 mbstring.func_overload=2
 mbstring.internal_encoding=UTF-8


Database server support

MySQL

MySQL version 5.0 and higher is recommended.

To support MySQL, the system requires the MySQL support for PHP to be installed.


Web server configuration

For proper functioning, Bitrix24 requires the following parameters to be set.

PHP settings

The following PHP parameters are essential.

  1. memory_limit = 64M;

    Maximum amount of PHP memory required by the system core.

    Note: this parameter can be changed:
    • by editing the file php.ini directly;
    • from within a script by calling ini_set("memory_limit", "64M");
      This call is added to /bitrix/php_interface/dbconn.php at the installation time using the user-supplied value;
    • in the file .htaccess using the directive: php_value memory_limit 64M
    • in the file httpd.conf using the directive: php_admin_value memory_limit 64M

    Note: parameters can be altered from within the .htaccess file if the following conditions are met:
    • Apache (or compatible) web server is used;
    • .htaccess files are processed by a web server, which means that the web server configuration file (httpd.conf) contains the directive AllowOverride set to All or any value other than None;
    • PHP is installed as an Apache module (if PHP runs as CGI all the required parameters must be set when compiling PHP)

  2. file_uploads = On;
    The parameter defines whether files can be uploaded to a server or not.

    Additionally, the following variables are also to be set:

    • upload_tmp_dir = <folder name>
    • upload_max_filesize = <required file size limit>

    Important: It is essential that the specified directory exists, and a current user (under which the web server runs) is granted the write permissions for this folder.

  3. Proper PHP session handling is the indispensable condition. You are recommended to check that the folder where the session files are saved exists.

    Note: if the parameter session.save_path is missing from php.ini, the default value of /tmp is used.

    If the server URL's happen to contain the PHPSESSID=... parameter, you hide it as follows:
    • Add the line session.use_trans_sid = 0 to php.ini;
    • In .htaccess, add the following directive: php_flag session.use_trans_sid off
      The demo site has this line included in .htaccess, you can uncomment it if required.

Supported standards. Client software requirements

Bitrix Site Manager and Bitrix24 use and support the following technologies.

HTML/XHTML

The system places no restrictions on templates developed with HTML/XHTML.

JavaScript

The system unconditionally supports the use of JavaScript in the site templates, menus and pages.

AJAX

This technology is widely used in the Control Panel and Components 2.0 to speed up the system response and decrease server-to-client data traffic. The system places no restrictions on using AJAX in the public section.

CSS

The design of each site template can be controlled via separate CSS files. Analogously, separate style sheets can be used with public components as well as module templates (e.g. forum, helpdesk, polls). The Control Panel features the use of visual themes: users can create their own custom visual themes through the cascading style sheets.

Flash

The system has limited support for the Macromedia (now Adobe) Flash technology. Flash plug-ins can be used in the following ways:

  • as a part of the site template design;
  • as advertising banners;
  • as user input controls deliberately designed to interact with the system.

RSS

The system supports RSS versions 0.92 and 2.0. In the core, RSS is used to exchange information between the Information Blocks and Blogs modules.

CSV

The system uses the CSV standard to exchange information between the Information Blocks module and other systems.


Browser support

Bitrix Site Manager and Bitrix24 were developed to support the most popular browsers (Internet Explorer 11.0 and higher). The Control Panel is optimized for the maximum performance with them. The public section appearance is browser-independent.


Known problems

  • The visual editor behaviour may somewhat disagree in different browsers (Internet Explorer and FireFox).
  • Some API functions and class methods may produce HTML code that do not fully conform with the XHTML standard, and potentially may not pass the W3C validation.

Installing Bitrix Web Environment

Important: Use Bitrix Web Environment for testing purposes only. We don't recommend using it in release configurations.

The Bitrix Web Environment package is extremely useful for testing the trial versions of Bitrix Site Manager. The Bitrix Web Environment installation wizard deploys the following applications required by the system:

  • MySQL 5.1.51
  • Apache 2.2.15
  • PHP 5.3.2
  • Catdoc - MS Office file indexing
  • xpdf- Adobe PDF file indexing
  • msmtp E-Mail Manager
Note: Here, Bitrix Web Environment implies the above listed software but not Bitrix24.

Preliminary operations

Do the following to download Bitrix Web Environment:

Important: If you have chosen to use Bitrix Web Environment, you will have to download a stand-alone Bitrix24 package. You can download it at this page as a .zip or .tar.gz file. Unpack the downloaded archive to the Bitrix Web Environment root (/www/ folder) and follow the Bitrix24 installation instructions (see Installing Bitrix24 Self-hosted).

Important: Use Bitrix Web Environment for testing purposes only. We don't recommend using it in release configurations.

The Bitrix Web Environment Installation Wizard

Important: Use Bitrix Web Environment for testing purposes only. We don't recommend using it in release configurations.

The installation of Bitrix Web Environment is very simple. It will not take more than 5 minutes.

Use the Next and Back buttons to navigate through the wizard steps. The Back button allows you to return to a previous step if you need to change the installation preferences. If you want to abort the installation, click Cancel.

Step 1. The Initial Installation Screen

Click on image to enlarge

The first wizard window informs you that the installation is starting and displays the basic information about the product.

  • Click Next. This will open the next step containing the License Agreement.

Step 2. The License Agreement

The License Agreement

Read the Agreement carefully. If you accept the license terms, check the I accept the agreement box. You must accept the License Agreement to continue installation.

  • Click Next to open the next window of the Wizard.

Step 3. Choosing Installation Folder

Destination folder selection

  • Specify the folder to which the Bitrix Web Environment will be installed. The default destination directory is C:\Program Files\Bitrix Environment. To choose a different folder, click Browse and select the folder in the tree, or type the path in the edit box.
  • Click Next to open the next screen.

Step 4. Shortcuts

Start menu shortcuts

This window shows the name of a folder containing the application shortcuts that will be created in the Start menu. By default, the wizard suggests the folder Bitrix Site Manager. You can specify a different folder name.

  • Click Next to go to the next step.

Step 5. More actions

Additional setup tasks

Enable the Add desktop icon option to place a shortcut to Bitrix Web Environment on your desktop.

  • Click Next to go to the next step.

Step 6. Web Server Parameters

Web server parameters

Here you can change the port at which you will connect to the Apache web server.

By default, the web server is configured to respond at port 6448. You can set any other port number (e.g. 6443) unless this port is not in use by other applications (e.g. IIS).

  • Click Next to continue.

Step 7. Ready to install

The installation options review window

This window displays a summary of the installation preferences you have specified in the previous steps. If you need to change the installation preferences, click Back.

  • If you accept the proposed settings, click Install to start installation.

Installing Bitrix Web Environment

Wait until the wizard copies files to your machine.

Step 8. Final Step

The final step of the installation

This window informs that the Bitrix Web Environment files have been successfully copied to your machine. To run Bitrix Web Environment right after closing the installation wizard, enable the Launch Bitrix Environment option. Click Finish to quit the wizard.

Configuring Bitrix Web Environment

To change the settings for Bitrix Web Environment:

  • Right-click on the Bitrix Web Environment icon in the system tray.
  • Select Settings... in the menu.

  • This will bring up the application start-up parameters dialog box:

Edit the parameters as required. For additional references provided below is a brief description of the dialog box options.

  • Apache Web Server:
    - the port at which the server will be available;
    - the check box option to run the web server is secure mode (SSL), and the port for SSL connection.
  • Start Services:
    - MySQL - runs a MySQL server at start-up;
    - port for use by the MySQL server by default;
    - XMPP - runs an XMPP messaging server (previously known as Jabber);
    - SMTP - runs a mail server.
  • Mail:
    - Send E-Mail Using Bitrix Web Environment - with this option enabled, the e-mail messages will be sent using the SMTP server specified below;
    - SMTP Server - the address of the outgoing e-mail server;
    - Default Sender - specifies the e-mail address seen by recipients as the sender (“From”);
    - Server Requires Authentification - if this option is checked, the username and password will be used for logging on to the SMTP server.

    Bitrix Web Environment 2.0 uses a built-in SMTP server to send e-mails (MSMTP). If you prefer to keep the Send E-Mail Using Bitrix Web Environment option unchecked, the e-mail server specified in php.ini (C:/Program Files/Bitrix Environment/apache2/zendserver/etc/) will be used instead.

  • Use A Separate Process To Send Messages And Run Agents - specifies that, if checked, the system will run a separate dedicated process in which the e-mail server and agents will run. This usually improves system robustness and optimizes performance.
  • Run Bitrix Web Environment At Windows Start-up (as a service) - if checked, Windows will start the Bitrix Web Environment service when Windows is loading. You can provide a custom name for the service.

Another way to edit these settings is by opening the bitrixenv.ini file from the Bitrix Web Environment installation folder (e.g., C:/Program Files/Bitrix Environment/).
[Parameters]
ApachePortSSL=443 ; SSL port
StartApacheSSL=0 ; secure SSL mode
MySQLPort=31006 ; MySQL server port
StartMySQL=1 ; 1 - start MySQL server, 0 – don’t start
StartXMPP=1 ; 1 to start XMPP server, 0 – don’t start
StartSMTP=1 ; 1 to start SMTP server, 0 – don’t start
StartAgents=1 ; 1 to start Apache agents, 0 – don’t start
StartMSMTP=0 ; 1 to start built-in SMTP server , 0 – don’t start
ServiceName=BitrixEnv ; name for the Windows service 
MSMTPAuth=0 ; use SMTP authentication (when StartSMTP is 1), 0 – don’t start
MSMTPServer=localhost ; built-in SMTP server address (used when StartSMTP is 1)
MSMTPAuthPassword=123456 ; password for built-in SMTP server; used when StartSMTP and MSMTPServer are 1
MSMTPAuthLogin=admin ; login for built-in SMTP server; used when StartSMTP and MSMTPServer are 1
ApachePort=6448 ; default port for use by Apache
MSMTPFrom=support@server.local ; default sender address 

Important: Use Bitrix Web Environment for testing purposes only. We don't recommend using it in release configurations.

Installing Bitrix24 Self-hosted

This chapter describes the preliminary steps for the product installation, steps of the installation wizard, as well as selection and initial set-up of the portal for a faster deployment of your project.

Preliminary operations

All versions of Bitrix24 are shipped as .zip and .tar.gz archive files for PHP 5.

  • Download Bitrix24 installation package to your server or computer.
  • Extract files from the archive to the root folder of your site.

Now, ensure your system corresponds minimum requirements.

  1. If required, install Apache web server and configure it to support PHP. Bitrix24 requires Apache version 1.3 or better and PHP 5.0.0 or better.
  2. If required, install database engine (MySQL version 5.0 or higher, Oracle 10g or higher or MSSQL 9.0 (2005) or higher).
  3. If you install the Oracle version, ensure that the client part of Oracle Database 10g Client or higher is installed. Create a new user.
  4. If you reinstall the system, remember to remove all tables.
  5. Ensure that you have at least 10 MB of free disk space for the update system.
Attention: Bitrix24 can only install and operate correctly if your system conforms these minimum requirements.

To start installation, open http://<your_site>/index.php in your browser. Replace here <your_site> with the real address of your site.


If the product is installed on a 64-bit Windows, an SQL server driver for 2012, not for 2008, is required. To verify the MSSQL database connection, use the following script:
<?
$serverName = '192.168.10.16';
$connParams = array('UID'=>'sa', 'PWD'=>'secret', 'Database'=>'sitemanager','ReturnDatesAsStrings'=> true);
$conn = sqlsrv_connect($serverName, $connParams);
if(!$conn){
$errors = sqlsrv_errors();
die(var_dump($errors));
}
die('connected');
?>

Step 1. The start

Note: If the product is installed jointly with Bitrix Web Environment, this step will be skipped.

The first wizard window informs you that the installation is starting and displays the basic information about the product.

The first step of the installation wizard

Click Next to continue installation.

Step 2. The license agreement

Note: If the product is installed jointly with Bitrix Web Environment, this step will be skipped.

Read the Agreement carefully. If you accept the license terms, check the I accept the License Agreement terms box. You must accept the License Agreement to continue installation.

Click Next to open the next window of the wizard.

Step 3. Product registration

Here you will have to enter your license key and select database for which the system will be configured.

  • Enter the product's license key that you received during the purchase of the product into the field license key.

    Note: During the installation of a demo version of the product, the option I want to register my copy of the program and get updates will be available. If enabled, it offers the user to register their copy of the product to receive product updates. Having filled in the registration fields, the user becomes entitled to receiving updates of the product.

    Otherwise, the product will be installed but updates will not be available. After the demo version installation, if required, you can register your demo and receive the demo key for updates (for more information, see Registration of trial (DEMO) version of the product).

  • In the field Database choose the database to be supported by the system.

    Important: Please note that, when installing, the product the MSSQL option will be available if the system was configured to support ODBC or SQL Server Native Client (recommended). To be able to use Oracle, the OCI8 library must be available (namely, php_oci8.dll). If the system does not support the specified requirements, MSSQL and Oracle will not be available.

    Important: If the product is installed jointly with the package Bitrix Web environment, the MySQL version of the product will be available and Database selection will not be available.

For the Oracle and MySQL databases, UTF-8 encoding is available. In order to connect the UTF-8 encoding check the box Install in UTF-8 encoding. To make sure UTF encoding is properly supported please check that the mbstring module is installed in PHP. To that effect, PHP properties in the php.ini file must contain the following:

 mbstring.func_overload=2
 mbstring.internal_encoding=UTF-8

Site Encoding

The product may be installed using UTF-8 encoding by checking the relevant box.

UTF-8 (Unicode Transformation Format) is a common encoding that represents every character in the Unicode character set compatible with 8-bit text encoding.

Currently, the choice for HTML-document encoding is between WIN-1251 and UTF-8.

The use of WIN-1251 encoding is recommended for earlier versions of MySQL (up to version 4.x) which malfunctioned with UTF-8. Modern versions of the MySQL database are free of these deficiencies.

The advantage of UTF-8 is the availability of a large number of special characters, typographic symbols, and extended characters. UTF-8 is supported by all modern browsers, starting from Internet Explorer 4.

In order to achieve the maximum flexibility and amplitude of use of the existing characters, the use of UTF-8 encoding is recommended.

To continue the installation, please click Next.

Step 4. Preliminary verification

Note: If the product is installed jointly with Bitrix Web Environment, this step will be skipped.

The installation wizard checks your system for minimum requirements and displays advices on how to tune your system for optimum performance.

If your system does not match minimum requirements, the problem description in red will display on the top of the screen. The detailed description of the incompatibility can be found in the page body. You cannot continue installation until you fix the problem.

Attention: In case of product installation in UTF-8 encoding the value of the mbstring.func_overload parameter must be equal to 2. Other values for this encoding are unacceptable.

In case of product installation onto the MSSQL database UTF-8 encoding may not be selected. If during product installation in UTF-8 encoding at the stage of preliminary check mbstring.func_overload and mbstring.internal_encoding parameters are shown in red, the following lines shall be added in the php.ini file located in a website root to correct this:
mbstring.func_overload = 2
mbstring.internal_encoding = UTF-8

Note: If hosting uses the PHP version earlier than 5.2.8, the overload parameter may be determined in the file .htaccess.

Note: Website may be installed in cp-1251 encoding, if the value of overload remained equal to 2. For this, it is sufficient to use the value cp1251 for the encoding parameter.

If your system does not match the recommended settings, you can still proceed with the installation. The installer will show the potentially incorrect settings. However, it is strongly recommended that you bring these settings into line with the recommended values. You can verify the system preferences in the Site Check form in Control Panel.

  • Click Next to continue.

Step 5. The database creation

Note: If the product is installed jointly with Bitrix Web Environment, this step will be skipped.

Here the database connection configuration file is created; the database is populated with data. The fields in the Database settings group vary depending on the chosen database type. Other fields are common to all databases.

MySQL database parameters

At this point, the database connection parameters are established.

Local installation

If you install Bitrix24 on a local machine and have the required applications (Apache, PHP, MySQL), or Bitrix Web Environment installed:

  • Server: the address of a server that hosts the database engine (MySQL in this case). This value is usually "localhost" for local servers, and the port number in the format localhost:[port]. You can find the port number in the MySQL configuration files.

    Note: When installing Bitrix24 on Bitrix Web Environment, type localhost:31006 in this field.

  • Database user: select to create a new user;
  • User name: type here any desired database user name (login) that will be used to access the database.
  • Password: the database user password.
  • Database: select to create a new database.
  • Database tables type: standard tables are generally good for most use cases:
    • Standard. Standard type of tables in MySQL is MyISAM that is not transaction-oriented. For MyISAM-type tables, all data are saved in one file and, therefore, the maximum size of the file is at the same time the maximum size of the table.

      Operating systems impose their limits on the maximum size of the file. Normally it ranges from 2 to 4 Gb. MyISAM tables are platform independent. Table files may be transferred between computers of various architectures and various operating systems without any conversion.

    • Innodb. InnoDB tables in MySQL are equipped with a table handler ensuring safe transactions with the possibilities of transaction fixing, rollback, and recovery after a failure.

      Row-level lock is used in InnoDB tables together with the read method without locking in the SELECT command. The transaction log is kept in case transactions are cancelled. It is subject to internal rotation, i.e. when all the records are filled, the oldest records start getting removed. These functions permit improving mutual compatibility and enhancing performance in multi-user mode.

      InnoDB is intended to receive maximum performance when processing high volumes of data. In terms of the efficient use of the processor, this type by far exceeds other models of relational databases with memory on disks.

  • New database: the name of the database to which the product will be installed.
    A new group of fields will appear: Database administrator parameters.

  • Type root in the Login field.
  • The Password field must be empty

Remote Server

If you install Bitrix24 on a remote server, consult the hosting service provider for the database parameters. Specifically, you should obtain values for the following fields:

  • Server address;
  • Database user: consult whether you need to create a new database user;
  • (database) User name;
  • (database) Password;
  • Database: consult whether you need to create a new database;
  • Database name;
  • Type of database tables.

Standard tabled are optimum for most cases. However, web shops are observed to perform better with InnoDB tables.

Note: If you need to create a new database user or a new database, the database user name and password fields are required. If no database exists yet, you must create a new one (by selecting the appropriate option). However, new databases are usually created by the hosting service techsupport. You will only have to obtain the user name, password and connection parameters.

Oracle database parameters

Attention: Before proceeding with the installation, the web server environment has to be set up: environment variable NLS_LANG must establish CP1251 encoding (for example, NLS_LANG=ENGLISH.CP1251), and decimal separator must be “.” – NLS_NUMERIC_CHARACTERS=.
  • Connection string: this field should contain either the name of a local Oracle instance, or the record name in tnsnames.ora to connect to. Example of the name of a local Oracle instance:
    (DESCRIPTION = (ADDRESS_LIST = (ADDRESS = (PROTOCOL = TCP)(HOST = 000.000.0.00)(PORT = 0000)))(CONNECT_DATA = (SERVICE_NAME = BX)))
  • Database user: if checked, a new database user will be created. Otherwise, an existing user will be used.
  • User: a user name (login) of the database user used to access the database.
  • Password: a user password to access the database.
Note: If you choose to create a new database or database user, you will have to provide the database administrator's login and password. The database administrator's user name and password are used only at the installation and database creation time. This information is not stored in the system.

Attention: Oracle full client, and not a RunTime client version, must be installed on the web server without fail.

MSSQL database parameters

  • DSN: a database connection string. The string should contain, at least, the connection driver parameters and the server name. Optionally, you can include the user name, password or other parameters.
  • Note: Sometimes you would need to specify a user DSN name here (a connection must be created in advance). For local servers (if the product is installed on the same server as the database), this parameters usually has a value of localhost.

  • Database user: if checked, a new database user will be created. Otherwise, an existing user will be used.
  • User: a user name (login) used to access the database.
  • Password: a user password to access the database.
  • Create database: check this option if you want to create a new database.
  • Database name: type the name of the database to which the system will be installed.
  • Note: If you choose to create a new database or database user, you will have to provide the database administrator's login and password. The database administrator's user name and password are used only at the installation and database creation time. This information is not stored in the system.


Additional parameters

These parameters define permissions to assign to all files and folder of the site. They are common to all database types.

  • File access permissions: Permissions that will be applied to all newly created files. Access permissions should allow the web server to write to files. The default value is 0644;
  • Folder access permissions: Permissions that will be applied to the newly created folders. Access permissions should allow the web server to write to folders. The default value is 0755.

Note: you can alter the database connection parameters manually by editing the file /bitrix/php_interface/dbconn.php which is created upon installation.

Click Next to continue.

Step 6. System installation

At this stage, the wizard creates the database and copies the system files. You can watch the process proceeding in the progress bar. Upon completion, the wizard will switch to the next step automatically.

Step 7. Creating an administrator's account

Here you will configure the web site and create a web site administrator's account. The administrator's account provides full access to web site management and configuration. After the installation is complete, you can create more users with less permissions.

Note: fields marked with asterisk (*) are required.
  • Login: the site administrator login to access the Control Panel pages. Must contain at least 3 symbols;
  • Password: the site administrator password. Must contain at least 6 symbols;
  • Confirm password: type the password again to validate it.
  • E-Mail: the address of the site administrator's e-mail account;
  • Name, Last name: the real name of the site administrator.

Attention: You will use the provided password and login to authorize in Control Panel.

Click Next to continue installation. The Bitrix24 Configuration Wizard will open.

Bitrix24 Configuration Wizard

This chapter provides detailed step-by-step instructions regarding portal and extranet site set up.

Note: the number of steps in the portal and extranet setup wizards may differ depending on installation options.

Bitrix24 Configuration

Step 1. Initial screen

This screen informs you that the configuration wizard has started.

  • Here, just click Next.

Step 2. Design template

Choose the design template for your Bitrix24. Templates vary in layout, colour, appearance of the main page and settings.

  • Select a desired template by ticking a respective radio button.
  • Click Next.
Note. Portal templates are system templates and cannot be customized! There is a technical possibility to copy, customize, and apply the template, but in this case the backward compatibility will be lost.

Step 3. Colour theme

Here you will choose the desired colour theme for your Bitrix24. Different site design templates offer different colour schemes.

  • Choose the desired color theme and click Next.

Step 4. Portal settings

Provide here the name and the logo of your company. Select the features you want to enable on your Bitrix24.

  • Type the name of your company and click Browse to select the logo image of your company.
  • In order to set the demo data of employees, include social network and external communication functionality, and set up access rights on the portal please select the relevant options.
  • Click Install to proceed to the next step.

Step 5. Data installation

This is an unattended step that installs Bitrix24 according to the selected preferences. You can watch the process proceeding in the progress bar. Upon completion the wizard will open the next step automatically.


Step 6. Finishing configuration

The system has been installed and the initial configuration has been applied.

Now you can:

  • Import users to your Bitrix24 (click Import Users).
  • Open your Bitrix24 and start working (click Launch Bitrix24).
  • Run the Extranet Configuration Wizard (click Configure Extranet).

Note: the Configuration Wizard may also be launched again after the product installation. For example, in order to change a template or color set of the portal or include additional modules (depending on the license), etc. The wizard may be launched using one of the two following ways:
  1. Public interface: using the Wizard button on the Control Panel:

  2. Administrator’s interface: select Install option in the actions menu in Corporate Portal Wizard (Settings > System settings > Wizard list):

Extranet Configuration

First Step of the Wizard (Setup Start)

The first window informs about the wizard’s start.

  • Click Next.

Second Step of the Wizard (Extranet Site Design)

Automatic step where template is selected.


Third Step of the Wizard (Color Set)

Automatic step where the color set is selected.


Fourth Step of the Wizard (Site Setup)

Here, the main extranet settings are established: Company Name, Extranet Site ID, and Extranet Site Folder.

  • In order to proceed, please click Install.

Fifth Step of the Wizard (Data Setting)

Automatic step where all the extranet settings are determined. Graphic indicator helps to monitor the progress. When the installation is completed, the system will automatically move on to the next step.


Sixth Step of the Wizard (Installation Completion)

The installation and setup are completed.

  • Please click Open Portal to open the extranet home page.

Note: the Extranet Wizard may also be launched again after the product installation. For example, in order to change the extranet template or other settings. The wizard may be launched by either of the following two manners:
  1. Public interface: using the Wizard button on the Control Panel:

  2. Administrator’s interface: select Install option in the actions menu in the Corporate Portal Extranet Setup Wizard (Settings > System settings > Wizard list):

Installation using BitrixSetup

Bitrix24 can be easily installed at a remote server by uploading the installation files via the FTP or using the BitrixSetup script. In the first case, download the commercial or trial version and unpack it at a local machine. Then, use any FTP client to upload the extracted files to the root folder of your web server. Otherwise, upload the archive to the server and extract files remotely.

However, we strongly recommend that you use the special BitrixSetup script to avoid upload errors and eliminate a frequently occurring problem of different FTP and Apache user access permissions.

BitrixSetup uploads the trial or commercial version of Bitrix Site Manager to your site directly from www.bitrixsoft.com without the intermediate downloading step. Furthermore, the script can extract files from the installation package if you cannot access your site via SSH or third-party software.

  • Download the script at http://www.bitrixsoft.com/download/scripts/bitrixsetup.php.
  • Click the Download button.
  • Establish an FTP connection to your server.
  • Upload the downloaded file to the root directory of your web server.
  • In your browser, type http://<your_site>/bitrixsetup.php (replace <your_site> with the real site name) and press Enter. The browser will display a BitrixSetup welcome page.

Warning: Please ensure that your web server has enough permissions to create and write files.
  • Select the appropriate version in the License key field.
    • Demo version can be installed without a license key, or with a trial key.
    • Commercial version requires that you enter the license key previously obtained from Bitrix.
  • In the Choose a package field, select the product edition whose trial version you wish to install.
  • Click Download. This will open the Downloading installation package page.

BitrixSetup will connect to the Bitrix server directly. The script will copy the installation files to the root directory of your site and unpack them if you have chosen to do so.

The Back button allows you to return to the previous section where you can alter the installation settings (e.g. product edition).

The status bar displays diagnostic messages about the current operation (e.g. downloading or extracting files). The progress bar reflects the operation flow.

After the process of loading and extraction is complete, the browser will display the installation wizard form.

Important! After installation, you must delete bitrixsetup.php from the root directory of your site. Unauthorized access to this script may damage your site.

Registration procedure

Before you start using the commercial version, you have to activate your license key. If you install the trial version, you can omit registration yet it is recommended that you proceed to enable system updates during the trial period.

Registering a commercial version

Attention: According to the license agreement, one key allows only two installations of the system: a public installation and a local (developer) installation, the latter being unavailable from the Internet. Should an error message appear about exceeding the acceptable number of product installation please contact Helpdesk.

Registration entitles you to obtain latest system updates and receive support from the Bitrix technical support service..

Moreover, having your commercial copy registered you can access the Bitrix private forum where users and Bitrix developers communicate and discuss important issues, resolve user's problems.

To register your copy:

  • Open Control Panel.
  • Click Marketplace > Platform Update to open the system update form.

Since your copy is not registered yet, you will see the following error message:

  • Press Activate key.

You will see the following form:

Note: fields marked with asterisk (*) are required.
  • Fill in the following fields:
    • Key owner (company name or person): please indicate the name of the company which is the key owner. If a private person owns the key, please provide the name of that person here.
    • Site address: please indicate the addresses of the sites that will be managed using the system with this license key.
    • Phone number of the product copy owner: please indicate the contact telephone number, with the area code, of the product owner.
    • E-mail address for licensing and usage contacts: please provide an email address that may be used by the employees of Bitrix, Inc. to contact you, if necessary.
    • Contact person responsible for this product copy: please indicate the full name of a responsible contact person.
    • E-mail address for technical contacts: please indicate the telephone number of a contact person.
    • Contact person phone: here, you may provide additional contact information: email addresses, mail address, contact telephone numbers, etc.
    • Contact information: here, you may provide additional contact information: email addresses, mail address, contact telephone numbers, etc.
    • Create user at www.bitrixsoft.com: if you are not a registered user at Bitrix, Inc., please check this box. After the activation of your license key you will be registered on the company website with the registration data indicated in the boxes below. Using the indicated registration data you may contact Bitrix Help Desk and also obtain access to a forum on the company website intended for registered users only.
    • I already have a user account...: please check this option if you are registered at www.bitrixsoft.com and indicate your login.
  • Click Activate license key. The license will be activated.
  • Then, you have to obtain a full version of the system without limitation on the operating time. Click Register. The product will be registered using the data provided during activation:

Note: If for some reason, the license key has already been activated, you will be offered to register the product in the update system.

When finished, the license information will be available:

Registering a trial version (DEMO)

If you install the trial version, you will see the License key is not found message when opening the Marketplace > Platform Update page.

Essentially, a local trial version does not require that you obtain a license key. It only enables the system to receive updates. Obtaining a trial key requires that you register at the Bitrix web site.

Click Get a trial license key. This will open the trial registration page at the Bitrix web site.

Note: fields marked with asterisk (*) are required.

Fill in the form fields:

  • Last name, Name: specify your last and first names;
  • E-mail: specify your e-mail address. The trial key will be sent to this address;
  • Company: the company name;
  • Phone: the phone number;
  • Web-site: specify the exact address of a site that runs the trial version of the system;
  • License type: select the version of the product you have just installed.

Complete the form and click Send. The system will inform you that your request is now put in the submission queue.

A message containing the license key and the period of validity will be sent to the address you have previously specified in the trial registration form. You can copy and paste this key in the Control Panel form where you clicked the Get a trial license key link, or in the Kernel module settings page.

  • Open Control Panel.
  • Open the Kernel module settings page: Settings > System settings > Module settings.
  • Open the Update System tab.
  • Paste the key in the License Key field.

Now you can obtain updates during the 30-day trial period.

Note: If during the installation of the trial version of the product on the step Product registration you check the option I want to register my copy of the product and get updates and provide data for the registration of the trial version, then there will be no link to Get a trial license key after the installation of the product. Thus, the trial version will be activated for 30 days.

Registering a trial version using a commercial key

Having tried the demo version of the product you can register it and upgrade it to the commercial version.

To do so, you have to:

  • Buy the license.
  • Introduce your license key:
    1. On the tab Install updates (Marketplace > Platform Update), by clicking Enter license key.


    2. or

    3. On the tab Update system of the setup page Kernel module (Settings > System settings > Module settings > Kernel module) in the License key box.
  • After that, the key activation process shall be launched according to the instructions given in the lesson Registering a commercial version. Upon the completion of commercial registration, the demo version limitation on the operating time will be lifted, and you will obtain the full product.

Update system

The system updates, like the technical support, are available within a year after the moment of registration of the purchased license. If you want to access these services after that period, you will have to renew your license.

Attention: For each installation of Bitrix24, a special token is stored in the Bitrix clients database. When a project is moved to another location (server), the token is replaced once the system requests the Bitrix server for updates for the first time from the new location. Since then, you cannot update the system from the old location.

Your computer must be connected to the Internet to receive updates.

Overview

The update system serves to interact between and transfer data from the update server to a client (installed product copy). The main types of interaction are:

  • updating the product modules to the newest versions, which allows to obtain new functionality and fix possible bugs;
  • downloading new modules that may be available according to the license terms;
  • downloading language files (files with language-dependent messages translated into other languages);
  • downloading the help system in different languages;
  • product registration using the license key;
  • downloading the Bitrix Site Manager or Bitrix24 source code files;
  • obtaining more sites by entering a coupon code.

Update system terms

The following terms are used with the update system.

System core - the /bitrix/modules/ folder (all paths are specified relative to the root folder unless otherwise is explicitly stated). The notion of system core often implies the database structure.

Service area - all subfolders of the /bitrix/ folder except /bitrix/modules/ (i.e. the system core) and /bitrix/updates/. The notion of service area often implies the contents of the auxiliary database tables (for example, b_event_type).

Update system folder - the /bitrix/updates/ directory. This folder is for exclusive use by the update system and cannot be used otherwise.

Public section - all folders related to a given  product copy save the system core, service area and the update system folder. The notion of service area often includes the database contents except for the data of the auxiliary tables.

Product registration - results in removing the trial version restrictions from a given product installation (e.g. time restriction).

License key - a special key (a chain of symbols) which is the statement of the right to use the given product copy.

Site coupon - a special key allowing to create one more site using the given product copy.

Update server - a server that is used to send bits of update data to the update system. The update server address can be explicitly specified on the module settings page (must be www.bitrixsoft.ru or www.bitrixsoft.com).

Important notes on the update system

The update system does not alter the public section in any way. The service area may be changed in case of absolute necessity; but even so, existing files and records remain since they might have been changed by a user. The system core can be modified extremely, but the backward compatibility is guaranteed.

Important! If you have changed even one file of the system core or the database structure manually, the automatic update may cause unpredictable results.

The update system does not collect or send any confidential data regarding the installed product copy. The update system and the update server exchange only the technical data which is required by the update system to function correctly (e.g. current module versions or last update dates).

The modification that the update system performs on the system core is technically complex and intricate. If it fails or completes with errors, the dependent sites may become inoperative. Before update, you are recommended to ensure that a back-up copies of the database, scripts of the system core and the service area are created. It is desirable to perform update when the server load is minimum. If you encounter update problems, you need to contact the Bitrix technical support service immediately.

The update system main page

You can open the update system page by selecting Marketplace in the top left menu, and then choosing Platform Update.

If you see a message showing that your license key is invalid (or the license is not found), the following reasons are possible:

  • if you already have a license key, enter it in the appropriate field on the update system main page (or on the Kernel module settings page: click Settings on the top toolbar and select Kernel in the drop-down list);
  • if you do not have a license key, you can send a request for a trial key. To do so, click the corresponding link on the update system main page. Enter the obtained key in the appropriate field on the update system main page, or on the Kernel module settings page.

If the update system main page displays a message reading that a license key is not activated, you have to fill in all the fields of the activation form. After you complete and send the form, the license key will become activated.

The update system main page may tell that a new version of the update system is available, you must install it first. You will not be able to proceed with other updates until you install a new version of the update system.

If you have already provided a valid license key, and the update system is up-to-date, the update system main page will offer the following actions which are available according to your license terms.

  • Recommended updates - this action is available if the update server can offer new versions of modules stipulated by terms of your license.
  • Optional updates - available if the update server can offer new versions of files containing language-dependent messages.
  • Register your copy - displayed if your copy is not registered but the current license permits registration. You must register your product copy immediately after you have received the license key, since it will be difficult to restore the site up-state after the trial period expiration. The product registration is a single step operation - all you have to do is click the link.
  • Download source code - available if the source codes of your product copy are enciphered but the current license permits obtaining full open source codes. Before you attempt to download them, you must ensure that all modules are updated to the latest version (i.e. no module updates should be available). Source code download is a one-click operation. Please note that download may take some time if your connection is slow, or the update server load is high.
  • Add extra sites - this action is always available. If you have a coupon for extra sites, you can apply it any time.
  • History of updates - displays the installation journal containing information about 20 recently installed updates including status and error messages.

Update via proxy server

You can configure the update system to communicate via proxy server on the Kernel module settings page (the Update system tab), Settings > System settings > Module settings, select Kernel in the drop-down list:

Note the following options.
  • Force exhaustive update integrity check. Enabling this option makes copying the update files more safe. This function may slow down the update process but allows to get full information about each new file copied to your system.
  • Download only stable updates. Some new modules and/or updates are available at beta testing stage. Changing this option is equivalent to clicking the Allow beta versions / Allow only stable versions button at the Marketplace > Platform Update > Settings.
  • Check for updates. You can completely disable autochecking if required. However, it is not recommended.
  • Stop autochecking for updates if an error occurs. If checked, this option tells the update system to stop any current operation whenever it encounters any error.

After you fill all the required fields and save settings, the update will be performed via the specified proxy server.

Downloading Updates

The update system performs a technically sophisticated modification of the product kernel. If this modification is made improperly, the sites working on that kernel may become inoperative. Should you experience any problems with updates, you have to contact our Help Desk team immediately.

Important: Before proceeding with updates, please make sure you have a backup of both the database and the product kernel and service area scripts. The update procedure should be carried out at a time that the server load is minimal.

Please follow the steps below to download system module updates:

  • Using the Notifications menu located on the administrative panel above, go to the page Site Update (Marketplace > Platform Update):

  • Click Install recommended updates to install all the system module updates.

If you choose not to install all the updates at once, please check only the updates you wish to install on the tab Updates and click Install updates.

If necessary, the update process may be stopped by clicking the Stop button. In this case, the system will not interrupt the update immediately and fully but will complete the downloading of the module that was being updated when the Stop button was clicked. Should any failure occur during installation, the system will notify you about it, and the process will just have to be repeated. If you update modules one by one rather than all at once, then after you have installed each “portion” of the modules you will have to click Check for updates and then install the chosen modules.

Important: If any related module updates are available, either all related modules must be chosen for an update or none of them. The elimination of one related module from the list of updates will result in the automatic elimination of all others.

Attention: Please read the module update descriptions carefully. They contain important information about update installation; they also may contain warnings about possible problems in operation.


Downloading Interface language Files

You have an option to install additional user interface languages.

  • Click the Updates tab;
  • Select the required languages in the optional updates group;
  • Click Install Updates.

Coupon activation

The Bitrix24 Self-hosted system includes a license for 25 users. To increase the number of portal users, a license for the required number of users shall be purchased. The license may also be purchased for an unlimited number of users.

When acquiring licenses for additional users you will be given a coupon for the required number of portal users. Additional licenses (and coupons, accordingly) do not depend on the portal version.

If you already use the TeamPace or BizPace version, you can expand your portal features by upgrading the product. To do so, you need to acquire a coupon for upgrading to the version you need.


In order to have access to the latest product updates and technical support at all times, the coupon for extended technical support and updates must be acquired upon completion of the update availability period.

Having received the coupon, you need to activate it as follows:

  • Open the page SiteUpdate (Marketplace > Platform Update).
  • Go to the tab Activate coupon.

  • Enter the coupon in the relevant box and press Activate coupon.

Common errors

While attempting to update, the error "Error connecting the update server: [110] Connection timed out" appears.

This error indicates that the update script cannot connect to update the server www.bitrixsoft.com on port 80. This may occur due to the following reasons:

  • Socket functions are unavailable, particularly fsockopen();
  • Connections to port 80 are forbidden on the server;
  • Insufficient memory on the server (often occurs on VPS with virtualization OpenVZ and 256 Mb RAM);
  • Network problems.

Please contact the server administrator and provide them with the error description.


Update error [ERROR_WRONG_CODE]

The product update system becomes related to a specific installation and “remembers” the status of the system after the latest update. An error occurs if the current status is inconsistent with that at the time of the last update. This feature is intended to prevent the update attempts of an unlimited number of product installations using one license key.

According to the license agreement, two system installations are permitted for each license key – one public and one local (for developer) installation, the latter being inaccessible from the Internet. Accordingly, the system is set to save data about two installations. In this case, two copies may be updated independently without any problems and without the need to move a copy from a local computer to the server and back. If you have to move the product to a local computer, only one of two copies should be updated – either that on the server or the local one (at your discretion).

The same procedure should be followed when moving your site to a new server. Copy file structure and database onto a new server, and after that, without updating the product on the old server, delete it immediately after updating the DNS.

Configuring IIS for use with the system

IIS 7.0, a new web publication service, comes as a part of Microsoft Windows Server 2008. The key difference of this version, as far as work with Bitrix Framework is concerned, is the use of FastCGI, a request queue, and also the abandonment of nginx. Installation and setup of Bitrix, Inc. products on servers with Windows OS has become much simpler.

There are no significant differences in the installation of the Bitrix Framework onto IIS comparing with the installation on Apache. Only a general sequence of actions changes:

Attention: Currently, the Document library (webdav) module works improperly on web servers controlled by IIS 7.x. The architecture of such web servers in its basic variant does not permit organizing the work of PHP scripts according to the WebDav protocol – the server picks up all the requests and they fail to go through to the Bitrix24 system.

PHP Installation and Setup

In order to install PHP, first of all the PHP 5 installation package shall be downloaded from http://windows.php.net/download/ (Microsoft recommends a Non-thread-safe (NTS) installation package to be used).

Launch the installation package and follow the instructions of the Setup Wizard.

First Step (Installation Start)

The first window of the Wizard informs about the commencement of the installation and provides information about the product.

Click Next.

Second Step of the Wizard (License Agreement)

Read the license agreement carefully. If you agree with its terms and conditions, check the box I accept the terms in the License Agreement.

To proceed with the installation please click Next.

Third Step of the Wizard (Directory Selection)

Please choose the directory to install the software and click Next.

Fourth Step of Installation (Web Server Selection)

Please select IIS FastCGI as the installation web server and click Next to proceed with the installation.

Fifth Step of the Wizard (Component Selection)

Include the necessary Extensions (PHP add-ins) to be installed:

  • GD2;
  • LDAP (in case you will use LDAP authorization);
  • Multi-Byte String (this extension is required if product is to be used in the UTF-8 encoding);
  • MySQL;
  • OpenSSL;
  • zip.

Note: said extensions may be manually added later as extension=name_of_extension_file.dll in the file php.ini in the folder where PHP was installed. For example: extension=php_win32scheduler.dll.

To continue the installation, please click Next.

Sixth Step of the Wizard (Installation)

Click Install to start the installation process:

Please wait while the Setup Wizard copies and installs files.

Seventh Step of the Wizard (Completion of Installation)

PHP has been installed successfully. Please click Finish to exit the Wizard.

PHP Setup

PHP must be setup immediately after its installation:

  • Go to a folder where PHP was installed using any file manager.
  • Open php.ini for editing.
  • Please set the following parameters:
    fastcgi.impersonate = 1
    cgi.fix_pathinfo = 1
    cgi.force_redirect = 0
    short_open_tag = On
    extension_dir = "C:\<path_to_folder>\PHP\ext"
    upload_tmp_dir="C:\inetpub\temp"
    session.save_path="C:\inetpub\temp"
    allow_call_time_pass_reference = On
    display_errors = On

    Note: In Bitrix24 Self-hosted <? is used instead of <?php.

    Note: inetpub means a location where sites will be placed. This folder exists by default.

Please do the following to check the PHP setup:

  • Go to Start > Run;
  • Open command prompt window using the command cmd;
  • Once in the command prompt window, go to a folder with PHP using the following command: cd C:\<path_to_folder>\PHP\;
  • Give the command info to php: php –info.

If everything was done properly, the same configuration file will be offered (php.ini).

FastCGI Module Setup

In order to improve performance, php files must be processed with the FastCGI module. Please do the following:

Note: if you set 1 as the parameter of fastcgi.logging in the php.ini file, errors will be output to the log and not to the monitor. It increases the security of PHP.

Checking PHP

PHP parameters may be checked as follows:

  • In the folder C:/inetpub/wwwroot create a file phpinfo.php containing the line:

    <? phpinfo(); ?>
  • Type the following in the browser address bar: http://<your_portal>/phpinfo.php.
  • If setup is done correctly, a standard page containing information about PHP will open.

Preparatory Operations

Preparation of the Installation Package

Download the product installation package as a zip-archive.

Create a folder for the extraction of the installation package in the folder C:\Inetpub\wwwroot\ (or in another folder you determine as a root folder of the web server). For example: C:\Inetpub\wwwroot\bitrixtest and extract the contents of the archive to this folder.

Open the Properties form of the folder C:\Inetpub\wwwroot\bitrixtest and add the Modify rights for the group on behalf of which PHP process is launched (in our case, it is IUSRS) in the tab Security.

Adding a Website

Using IIS manager on the Connections panel go to Sites and eliminate Default Web Site.

Note: you may keep the default website, but in this case you will have to change the port settings for one of the sites during the setup of a new site.

Right click to call the context menu and click Add Web Site

The window for adding a new site will open:

In the Site name box please specify the host name (in our example: bitrixtest), and in the Physical path box, enter the path to the folder containing the installation package.

Click Test Setting…. The system will verify the connection parameters and display a message indicating the errors found, if any.

As a rule, authorization errors occur due to the user’s insufficient access rights to perform the operation of verifying folder access rights. Please do the following to correct this error:

Close the Test Connection window. Click Connect as…, and the following window will open:

Please check the box Specific User and press Set…. Enter the login and password in the window that opens. Click OK.

Verify the connection parameters once again using the Test Setting… button. If the verification is successful, the system will show the following message:

Configuration of Limits

Now, a time-out must be set. For this, do the following:

Please activate bitrixtest in IIS Manager on the Connection panel. The Action panel will be refreshed. Choose Limits in the Configure group.

The limit setting form will open.

In the box Connection time-out (in seconds) type 600. This command establishes an intentionally long timeout for the web server while it waits for the script to complete its operation – 600 seconds.

Open the file php.ini for editing and specify the following values: max_execution_time = 240 and max_input_time = 240.

Note: the indicated values may be user-defined depending on your hosting parameters.

Configuring The Error 404 and SEF URL’s

SEF URL’s are implemented by handling a 404 error.

  • Select bitrix in Connections of IIS Manager. Activate Error Pages in IIS group.
  • Right-click the row containing the error 404 to bring up the error properties form.

  • Click Edit

    Click on image to enlarge
  • Select Execute a URL on this site. Type the error 404 script path in URL: /404.php. This file is created at the product installation time. Click OK.

  • Click the Edit Feature Settings…

    Click on image to enlarge
  • Check the Custom error pages option. Click OK.

Backup and restoration tools

Using the back-up and restoration built-in tools

A special backup feature may be used to move the site to a remote server (or from a remote server to a local computer).


Please note: The backup feature may only be used for an MySQL database.

Before moving the site from a local computer to a remote hosting or from one remote hosting to another using the incorporated backup function and special script restore.php, it is necessary to do the following:

  • Verify that:
    • The remote hosting meets the minimal technical specifications of the product;
    • The user under which Apache (PHP) operates has the rights of at least (0644 – for files and 0744 for folders) for all files in the site root.
  • If an active license is available, it is strongly recommended that the existing product copy be updated to the latest version.

The next step is the creation of a site archive. The archive may be created on the Backup page (Settings > Tools > Backup > Create Backup).

After that, you may proceed with the actual site moving. Please follow the steps indicated below:

  • Download the file containing the archive to the site root directory on a remote server or on a local computer depending on where you moving the site to and from. If the source site is available on the Internet, it is recommended for the archive to be downloaded from a remote server. In this case, all parts of the archive are downloaded automatically. In case of moving from a local computer to a hosting all parts have to be brought together using restore.php.

    Important: if the archive file contains complete site copy (both the kernel and a public part), there is no need to install Bitrix system on the server.

  • Download the restore.php script available through the link provided in the reference at the bottom of the page with backup list. Upload the script to the site root on the server.

  • Note: This link contains a script that corresponds to your installation package version. The latest version of the script is available at bitrixsoft.com.

  • Please type in the address bar: http://your_site/restore.php. Press Continue.

  • Please choose the required option of the archive file location in the dialog window that opens and click Continue.

  • Note: The options Archive is stored in document root folder and Archive is already extracted will appear when the archive has been copied or extracted to the site root, accordingly.

    Note: If the site archive was located in the client’s cloud, please choose the option Download from remote server and indicate the path to the archive:

    If the site archive was located in Bitrix Cloud, please select the option Restore the backup from Bitrix Cloud and enter your active license key:

  • After the archive is downloaded, you will be requested to enter a password (if the archive was protected at the backup stage) in order to extract the files.
  • After the files are extracted, the database connection settings must be established if a database dump was created during the preparation of the backup copy.

    Please indicate the required settings, click Restore and wait for the script to complete its operation.
  • Once extraction is successfully completed, click Delete archive and temporary scripts in the opened dialog box:

    The following files will be deleted to prevent damage to the site or information leak:
    • /restore.php
    • /backup file (file with an extension of .tar.gz or .enc)
    • /bitrix/backup/database dump (file with the extension .sql).
    After that, you will be automatically redirected to a public section of the recovered site.

Special considerations:
  • If IIS is used as a web server, please be advised that the web.config file is also archived. You have to delete the extracted web.config file. Your server will create a new customized file.
  • After migration, numerical control may become inoperable. In this case, .htaccess.restore has to be renamed .htaccess.

Possible Errors during Migration

  • Site Migration Using Improper Means
  • PHP Settings
  • Problems with Email
  • Extracted Site Is Unavailable
  • Incomplete Archive
  • ERROR 1062 (23000)
  • Errors in .htaссess
  • If IIS is Used as a Web Server
  • Site Migration Using Improper Means

    The migration of site to hosting should be performed using backup/restore tools built in Bitrix Framework.

    Although a site on Bitrix24 Self-hosted is a set of files and a database, copying of files directly to a remote server in most cases will not be a proper solution. Due to a big number of small files, such copying may take several hours. In addition, the use of standard features enables the avoidance of possible future problems with access rights to the site files.

    Among the most common problems are the following:

    1. Web server cannot write to a folder that it needs to or delete temporary files. Possible consequences:

      • Product update is impossible;
      • Site cannot be edited using a web interface;
      • Caching component works improperly;
      • And other problems.

        Note: For example, the system may even create temporary files, but hosting rights do not allow you to delete them. As a result, after a day of work, the account gets blocked because the disc quota is exceeded.

        In this case, the simplest solution will be establishing the rights to all files and folders 777 (for Unix platform) or provide PHP with the write right for these files in any other way.

    2. There is no possibility to edit the files created using a web interface through ftp/ssh files. In this case, it will be hard for many web developers to debug the site.

      One of the simple but not always effective solutions is to determine settings in the file dbconn.php permitting everyone to edit the files created through Bitrix Framework.

      define("BX_FILE_PERMISSIONS", 0666);
      define("BX_DIR_PERMISSIONS", 0777);

      However, you will have to periodically change the rights manually for the files created through ftp/ssh; or, if hosting supports it, to establish the umask setting.

    PHP Settings

    The following problems may occur during the migration of the site to hosting due to the PHP settings:

    • Problems with file owner inconsistency: on a number of hosting PHP works on behalf of one user, but ftp/ssh access is granted to another. In this case, the files created by one method may be unavailable for modification or even cause a runtime error due to a breach of the security settings.
    • Problems with security settings: there are different options to connect PHP, and some of these options establish severe restrictions on the file owner and file rights. In this case, code 500 errors may occur, and the only way for you to solve the problem is to refer to web server error log.

      Example: If PHP is connected as CGI, hosting often requires that the file owner and file rights were consistent. If your account is not the file owner or if the file rights permit writing to all users, PHP will generate an error. In this case, the correct rights to files and folders and also the correct settings in dbconn.php should be established.

    • Limits to the script execution time or other allocated resources. In this case, the site may act strange –sometimes it may open, and sometimes not and then show white screen.

      Example: Various scripts of data import and export are the most sensitive to memory size and execution time. If you experience errors, check hosting resource availability. If the resources are insufficient, change the hoster.

    • Problems with using utf-8 in hosting. Make sure that it is supported (mbstring library and a possibility to set the parameter pgp: mbstring.func_overload=2 must be available).
    • Other problems that are specific for your hoster. To eliminate them, we recommend that the site operation be tested beforehand in the hosting of your choice and that the contact details of the provider’s support team be available.

    Problems with Email

    Sometimes hosting does not permit sending email without authorization. In this case, you will have to redefine email sending function in accordance with the product documentation in order to send emails from the site.

    Extracted Site Is Unavailable

    After extracting a backup copy, the only thing shown on the site is the authorization form. Possible reasons and solutions:

    • Incorrect value of the box Path to the web server root folder of this site in the site settings (Settings > System settings > Websites > Websites).

      Solution: change the value in the box Path to the web server root folder of this site in the site settings to a relevant path in a new hosting by clicking insert current. Leave the box empty if all the sites work on the same web server.

    • If migration was carried out by a simple copying of files (FTP/SSH), the file .access.php may have been left uncopied. This file contains user groups’ access rights to the site. If this file is absent, all users have the right Forbidden.

      Solution 1: Put the file .access.php with the contents to the site root:

      <?  $PERM["/"]["*"]="R"; ?>

      or

      Solution 2: Establish the right Read for the All users (with non-authorized users) group using product’s file manager in the properties of the site root folder in the Access tab.

    Incomplete Archive

    When looking through WinRar, the archive created by the standard backup system, it becomes evident that the archive contains far fewer files than there are files on the site.

    Reason: the point is that the tar format has several dialects. The system zips archive in the format GNU tar the way tar does it in Linux by default. WinRar understands tar, but does not support this dialect in full.

    Backup archive must be extracted by the system restore.php downloaded from the backup copy page. If in this case some files are also missed, the problem should be solved through the helpdesk service.

    ERROR 1062 (23000)

    When extracting a backup copy, the following error occurs: ERROR 1062 (23000) at line 1247: Duplicate entry '2-?' for key 2.

    Reason: the error occurs if the encoding of the archive is different from the encoding used on the new database server.

    • Archive encoding is set depending on the contents of the file /bitrix/php_interface/after_connect.php, for example:
      <?
      $DB->Query("SET NAMES 'utf8'");
      ?>
      i.e. the archive will be created in the utf8 encoding.
    • Database server encoding may be seen in the parameter character_set_server following the execution of a SQL request:
      show variables where Variable_name = 'character_set_server';

    This error may be bypassed or eliminated by way of one of the following ways:

    • In the new database server settings, change encoding in the parameter character_set_server to the encoding used in the archive.

      Attention: you might want to contact server administrator to perform this operation.

    • Open the archive in a text editor and insert the following line at the very beginning:
      SET NAMES 'utf8';
      The encoding is chosen depending on the archive encoding.

      Attention: this solution works only in case of small dumps (which manage to import in one step).

    Errors in .htaссess

    Some errors (for example, error 404 when going to a page with detailed news information) during site migration occur because the file .htaссess is getting renamed by adding “_” (low line). In order to solve this problem, just check the file name and correct it if the error is detected.

    If IIS is Used as a Web Server

    In this case, the file web.config is also archived causing problems with extraction. After extraction, restore.php will not work.

    Solution: eliminate the extracted file web.config. The server will create a new customized file.


    Uninstalling Bitrix24

    You can uninstall the Bitrix24 by selecting one of the commands:

    • Menu Start > Settings > Control panel > Add Remove Programs
    or
    • Menu Start > Programs > Bitrix Web Environment > Uninstall.

    Removing Bitrix24 from a remote server deletes the database files as well as all files and folders from the root folder of your web server.

    Check that …/www folder was removed from the Bitrix Environment folder as well.

    Configuring the server

    Requisite access rights at server

    You (or your hosting service) can configure access permissions on the remote server as desired, but the result must be the only one: scripts should be able to access files for both reading and writing, which means that a primary "user" under which the Apache server runs, must be able to access files with these modes.

    At the same time, if a shared hosting is the case, other users must not be able to read or write your files via their scripts. Your "user" should be able to rewrite files via the FTP as well as modify uploaded files from within scripts.

    The problem is that each hosting provider has their own security policy and preferences.

    Some hosting providers launch the server process under user nobody:group by default. The files that a hosting client stores on a server, should be accessible by the Apache. It means that they has the attribute read for all set, or a user (file owner) and server must belong to the same group. In the latter case, files must be accessible by the group members for reading (FTP servers assign this kind of permission).

    This approach hits hard the security because if all users belong to the same group, they can read each other's files. Say, a user opened a page in the browser which runs a CGI script. As the script in fact is executed by the Apache server which runs under nobody, the script will run with permissions assigned to this user.

    The Bitrix24 remains fully functional with any access permission that you have specified at the installation time.

    To allow the Bitrix24 work correctly with your CHMOD, you have to set the following constants in /bitrix/php_interface/dbconn.php:

    define("BX_FILE_PERMISSIONS", 0644); 
    define("BX_DIR_PERMISSIONS", 0755);

    These are the standard settings of rights used on the majority of hosting types. Should any problems occur, please contact the support service of your hosting.

    You can set the access permission level manually by using CHMOD in console.

    The following command sets the access permission level for both files and folders:

    chmod -R 644 *

    You can use the following command to set rights for folders only:

    find . -type d -exec chmod 0755 {} ';'

    If you need to establish different rights on folders and files, please execute the following script:

    <?php 
    define("BX_FILE_PERMISSIONS", 0644); 
    define("BX_DIR_PERMISSIONS", 0755); 
    
    function chmod_R($path) { 
    
       $handle = opendir($path); 
       while ( false !== ($file = readdir($handle)) ) { 
         if ( ($file !== ".") && ($file !== "..") ) { 
           if ( is_file($path."/".$file) ) { 
             chmod($path . "/" . $file, BX_FILE_PERMISSIONS); 
           } 
           else { 
             chmod($path . "/" . $file, BX_DIR_PERMISSIONS); 
             chmod_R($path . "/" . $file); 
           } 
         } 
       } 
       closedir($handle); 
    } 
    
    $path=dirname(__FILE__); 
    umask(0); 
    chmod_R($path); 
    echo $path; 
    ?>
    

    Some FTP clients allows to recursively set rights for files and folders. For example: FlashFXP version 3.xx.

    Please pay attention to check the appropriate boxes:

    Separately set File and Folder attributes; 
    Apply changes to all subfolders and files

    Each instance has its own level:

     
    Folder permissions   File permissions

    Important: The Site Explorer allows to view the system-level attributes of files and folders.

    When viewing the file structure in the Site Explorer, the level of access rights to files and folders for each user group may be seen in the Access permissions column using the Extended button.

    Using .htaccess

    .htaccess htaccess (hypertext access) is a file of an additional configuration of the Apache web server. It permits you to set a large number of additional parameters and permissions for web server operation in a separate catalog without changing the main configuration file httpd.conf.

    The file .htaccess is similar to httpd.conf, the only difference is that it applies only to the catalog where it is located and to its child directories. The file .htaccess may be located in any catalog unless these directives are redefined by directives of underlying .htaccess files. Proper settings of the main configuration file httpd.conf are necessary for the .htaccess files to become usable (the value of the directive AllowOverride must be set as All). The paths to files and catalogu must be indicated from the server root.

    You do not need to restart server after you have modified the .htaccess file. This file is checked each time the server is queried, that’s why changes take into effect right away. As this is the system file, it cannot be accessed by users from their browser.

    Note: During installation, the processing of .htaccess files is verified in the preliminary check step.

    In the demonstration site, the file .htaccess contains the following directives by default:

    Options -Indexes 
    ErrorDocument 404 /404.php
    
    <IfModule mod_php5.c>
      php_flag allow_call_time_pass_reference 1
      php_flag session.use_trans_sid off
    
      #php_value display_errors 1
    
      #php_value mbstring.func_overload 2
      #php_value mbstring.internal_encoding UTF-8
    </IfModule>
    
    <IfModule mod_rewrite.c>
      Options +FollowSymLinks
      RewriteEngine On
    
    RewriteCond %{REQUEST_FILENAME} -f [OR]
    RewriteCond %{REQUEST_FILENAME} -l [OR]
    RewriteCond %{REQUEST_FILENAME} -d
    RewriteCond %{REQUEST_FILENAME} [\xC2-\xDF][\x80-\xBF] [OR]
    RewriteCond %{REQUEST_FILENAME} \xE0[\xA0-\xBF][\x80-\xBF] [OR]
    RewriteCond %{REQUEST_FILENAME} [\xE1-\xEC\xEE\xEF][\x80-\xBF]{2} [OR]
    RewriteCond %{REQUEST_FILENAME} \xED[\x80-\x9F][\x80-\xBF] [OR]
    RewriteCond %{REQUEST_FILENAME} \xF0[\x90-\xBF][\x80-\xBF]{2} [OR]
    RewriteCond %{REQUEST_FILENAME} [\xF1-\xF3][\x80-\xBF]{3} [OR]
    RewriteCond %{REQUEST_FILENAME} \xF4[\x80-\x8F][\x80-\xBF]{2}
    RewriteCond %{REQUEST_FILENAME} !/bitrix/virtual_file_system.php$
    RewriteRule ^(.*)$ /bitrix/virtual_file_system.php [L]
      RewriteCond %{REQUEST_FILENAME} !-f
      RewriteCond %{REQUEST_FILENAME} !-l
      RewriteCond %{REQUEST_FILENAME} !-d
      RewriteCond %{REQUEST_FILENAME} !/bitrix/urlrewrite.php$
      RewriteRule ^(.*)$ /bitrix/urlrewrite.php [L]
      RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization}]
    </IfModule>
    
    <IfModule mod_dir.c>
      DirectoryIndex index.php index.html
    </IfModule>
    
    <IfModule mod_expires.c>
      ExpiresActive on
      ExpiresByType image/jpeg "access plus 3 day"
      ExpiresByType image/gif "access plus 3 day"
      ExpiresByType image/png "access plus 3 day"
      ExpiresByType text/css "access plus 3 day"
      ExpiresByType application/javascript "access plus 3 day"  
    </IfModule> 
    
    

    Note
    To activate the commented PHP directives, you have to remove the comment operator (#) at the beginning of each line. If your Apache server does not allow PHP flags, these directives will incur an internal server error (500). If this is the case, comment these directives back.
    Other uncommented PHP directives are enclosed in the verification condition statements ensuring the required Apace modules are present in the system. These directives will never cause the server errors.

    1. The PHP directive php_flag session.use_trans_sid off disables the session ID in the site URL's.
    2. If the PHP flag php_value display_errors is set to 1, the error messages are enabled and displayed. The directive php_value error_reporting defines which level of PHP interpreter errors is displayed.
    3. The directives php_value mbstring.func_overload 2 and php_value mbstring.internal_encoding UTF-8 control the settings of the mbstring library.
    4. The directive block IfModule mod_rewrite.c - is a setting of rights for mod_rewrite.
    5. The directive AddType application/x-httpd-php .ico determines the processing of the extension ico as php files.
    6. The directive ExpiresActive on enables image caching which boosts their download speed on the repeated queries.

      ExpiresByType image/jpeg "access plus 3 day" and ExpiresByType image/gif "access plus 3 day" define the cached image format and the caching period. By default, .jpeg and .gif files are cached for 3 days.
    Note: The file .htaccess must be saved in the UNIX format (Save as UNIX text option in the FAR manager editor).

    Authorization in the CGI Mode

    Sometimes authorization during data exchange with 1C will not work. The problem is often caused by php operating in the CGI mode. This mode experiences problems with HTTP data transmission to php. It can be verified by viewing phpinfo() in the section Server API: CGI.

    The problem may be bypassed, but .htaccess processing and mod_rewrite must be activated on the server. To activate them, please proceed as follows:

    • Add the following lines in the file .htaccess of the site root:
          RewriteEngine on
          RewriteRule .* - [E=REMOTE_USER:%{HTTP:Authorization},L]
    • Comment out the following lines in the file bitrix/admin/.htaccess that deactivate mod_rewrite:
          #<ifmodule mod_rewrite.c="">
          # RewriteEngine Off
          #</ifmodule>
    • Add the following lines in the file bitrix/php_interface/dbconn.php:
          $remote_user = $_SERVER["REMOTE_USER"] 
          ? $_SERVER["REMOTE_USER"] : $_SERVER["REDIRECT_REMOTE_USER"];
          $strTmp = base64_decode(substr($remote_user,6));
          if ($strTmp)
              list($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']) = explode(':', $strTmp);

    To check the operability of HTTP authorization, please use the script.

    Attention: sometimes this bypass option fails to solve the problem. If after all the recommendations are implemented HTTP authorization fails, please contact your hosting provider about this problem.

    Possible database failures

    Database connection errors

    When a database connection error occurs, the following error message is displayed:

    The visual aspect of the message is defined by the contents of the file /bitrix/php_interface/dbconn_error.php:

    <br>
    <table cellpadding="1" cellspacing="0" width="35%" bgcolor="#9C9A9C">
        <tr>
            <td>
            <table cellpadding="5" cellspacing="0" width="100%">
            <tr>
                <td bgcolor="#FFFFFF" align="center">
                <FONT face="Verdana, Arial, Helvetica, sans-serif" size="-1">
                <font color="#FF0000"><b><?echo "Error connecting to database."?></b></font><br>
                Please try again.</font></td>
            </tr>
            </table>
            </td>
    	</tr>
    </table>	
    <br><br><br>

    To resolve the problem, do the following:

    • check the database connection parameters (in /bitrix/php_interface/dbconn.php);
    • check whether the database is accessible.

    Database query errors

    When a database query error occurs, the following error message is displayed:

    The visual aspect of the message is defined by the contents of the file /bitrix/php_interface/dbquery_error.php.

    Situations may happen when a site denies to reply and returns an empty page to visitors. In this case, open the file bitrix/php_interface/dbconn.php containing the database connection parameters, and set the parameter: $DBDebug = true;

    <?
    define("DBPersistent", true);
    $DBType = "mysql";
    $DBHost = "localhost:31006";
    $DBLogin = "root";
    $DBPassword = "";
    $DBName = "bsm_demo";
    $DBDebug = true;
    $DBDebugToFile = false;
    
    set_time_limit(60);
    
    define("BX_FILE_PERMISSIONS", 0644);
    define("BX_DIR_PERMISSIONS", 0755);
    @ini_set("memory_limit", "64M");
    ?>

    This will cause the error message to be printed. The message usually contains names of damaged tables.

    Run perror.exe (can be found in mysql/bin) with the error code to get the error description:

    Note: The error 28 displays the following description:

    This means that the disk on which the database is installed is out of free space.

    If the database damage is the case, you are recommended to use the built-in database check and repair tool. This will allow you to restore the site functionality in the shortest possible time.

    Note!
    • The standard database check and repair tool only works with the MyISAM tables of MySQL.
    • The check script starts from the administrative section of the site Settings > Tools > System Administration > Database Check:

      If the statistics tables are damaged and you cannot open the Control Panel, you can disable gathering statistics by supplying the parameter ?no_keep_statistic_LICENSE-KEY=Y on the URL (substitute LICENSE-KEY with your license key).

    • There is a possibility to use the check script and recover the database without the need to go to the administrative section.

      To do so, supply the database access login and password on the URL. For example: http://www.mysite.com/bitrix/admin/repair_db.php?login=DB_Login&password=DB_Password. By default, the database access parameters are stored in /bitrix/php_interface/dbconn.php.

    Problem:

    The following error appears on the screen:

    MySQL Query Error: ….. [Out of memory restart server and try again (needed 65528 bytes)]

    Solution:

    Memory size must be increased in MySQL settings.

    The following MySQL parameters should be used and entered in the MySQL configuration file my.cnf:

    key_buffer = 128K
    max_allowed_packet = 16M
    table_cache = 4
    sort_buffer_size = 128K
    read_buffer_size = 128K
    read_rnd_buffer_size = 128K
    net_buffer_length = 128K
    thread_stack = 128K
    

    MySQL will have to be reloaded after you change the parameters.

    Possible server failures

    500 - Internal Server Error

    Since there are a lot of reasons which may cause server errors, their diagnostics is very complex and tedious.

    If a server error occurs, the first thing to do is view the error.log file. This file may contain a line with the error description.

    • Typical situation when a server error may occur is exceeding the allowed server permissions.

      For example: the system creates and saves a page with the 0777 permissions, while the maximum permission allowed by the server is 0644. The server will return the 500 error upon attempt to access the page.
    • A timeout limit for the execution of php scripts may also be a possible cause;
    • Alternatively, the system may have no write or read rights, etc.
    • Another prevailing reason is invalid server configuration or using forbidden directives (for example, in .htaccess). In this case, remove or comment the failure line in the file.
    • Note! If PHP runs as CGI, the 500 error may be cause by a PHP fatal error. In this case, you are recommended to check the program code and diagnose the error.
    • Internal server errors may come about when a CGI script runs on the Apache server and the execution time exceeds the maximum allowed period specified in the server configuration.

    Thus, everything depends on the server configuration.

    It is important to know that the said restrictions are not determined through PHP settings in php.ini.

    Normally, such an error and its cause are recorded in server logs. You have to refer to the hoster requiring that the reason of the error be indicated and the error be eliminated (for example, by increasing the resources). If the hoster could not find a solution, please contact Bitrix helpdesk providing an accurate description of the error and the reasons indicated by the hoster. Helpdesk will not be able to assist you without knowing the reason of the error.

    Document Search Setup

    By default, the product supports MS Office 2007 document search. In order to search all the documents, a number of settings described in this chapter must be made.

    Adding new formats

    By default, Bitrix24 uses the search feature in standard MS Office documents. If it is required to organize a search in documents of other formats, the format list shall be extended and necessary file processing programs shall be connected.

    • Download the necessary programs for converting text information contained in these documents to the plain text mode.
    • Having installed this program on the computer with Bitrix24, open the Intranet module setting page in the administrative section (Settings > System settings > Module settings > Intranet). Go to the Search tab..

    • Enter the required format, e.g., odt in the empty line in the Extension column.
    • In the External command column, enter the command in the format: . The program itself must be able to display data in UTF-8.

      E.g., the external command for the Otf2txt program for the conversion of a document made in the .ODT (OpenOffice) format to the .TXT format is as follows: odt2txt --encoding=UTF-8 #FILE_NAME#:

    • In the column Converter Directory please indicate the path to the catalog with the installed program and save the changes made.
    • In order to enable search in the new format, *.odt must be added in the Include file types box on the Search module setting page (Settings > System settings > Module settings > Search):

    Note: when working with PDF files, some Russian language files may be indexed improperly. In this case, replace the package XPDF by The Poppler Developers (included in the installation package) to the package Poppler-Utils by the Glyph and Cog.

    Setting Up Web Environment with PHP Version below 5.2.6

    If you installed Bitrix24 on Bitrix Web Environment 1.х with a version of PHP earlier than 5.2.6, an error might occur due to the absence of the library php_zip.dll in these installation packages. In this case, the following message appears:

    Attention: The zip_open function is not found. It is possible that the zip extension has not been loaded.

    This error indicates that the system will not index files of MS Office 2007 or OpenOffice.

    Note: In Bitrix Web Environment version 2.0 the library php_zip.dll is already enabled.

    In order to eliminate the error, please proceed as follows:

    • Download the library php_zip.dll from the Internet.
    • Place it into the folder X:\<path_to_folder>\Bitrix Environment\apache\extensions, where X:\<path_to_folder> - is a path to the folder where Bitrix Web Environment is installed.
    • Open the file X:\<path_to_folder>\Bitrix Environment\apache\php.ini.nooci for editing.

      In the section Dynamic Extensions of this file, add the line extension=php_zip.dll in the general list of all extensions. Save the changes made.
    • Restart Bitrix Web Environment. The error will be eliminated.

    Search of MS Office documents of earlier versions

    Search of the documents created in earlier versions of MS Office (before MS Office 2007) (doc, xls, and ppt formats) is possible using Catdoc – a special program package for the conversion of documents into plain text format.

    If Bitrix24 is installed in the Bitrix Web Environment, starting from version 1.1, you already have the Catdoc package installed and enabled.

    Checking for Catdoc Installation

    You may check the availability of the Catdoc package as follows:

    Go to Start > Run. In a opened window, type cmd. Click ОK. Command prompt window opens.

    • If you check the availability of the packet in Bitrix: Web Environment 1.1, type the command CD <full_path_to_environment_folder>\catdoc and press enter. Next, type env.exe HOME=. catdoc.exe -v.

      Note: In Bitrix. Web Environment 2.0 the Catdoc package is already installed in the folder <full_path_to_environment_folder >\catdoc\.

    • If you check the availability of the Catdoc package on the computer, enter the assumed <full_path_to_package_folder>\catdoc.exe -v.

    Press enter. The system must display a message similar to this:

    Usage:

    catdoc [-vu8btawxlV] [-m number] [-s charset] [-d charset] [ -f format] files

    If the message is as follows:

    "C:\..." is not an internal or external command run by a program or a package file.

    then either the specified path is incorrect or Catdoc is not installed.

    Note: the path to the package must be specified in the settings of the Intranet module in the Search tab (Settings > System settings > Module settings > Intranet).

    Installation of the Catdoc Package

    If the Catdoc program package is not installed due to any reasons, please follow the following steps:

    • Open the site http://www.cygwin.com/ in browser and download the file setup.exe of the Cygwin.
    • Start up the program installation and follow the instructions of the Installation Wizard..
    • At the step of selecting packages for installation, open the Text package group and mark the package Catdoc for installation:

    • Complete the installation according to the instructions of the Installation Wizard.
    • In the administrative section of the product, please open the settings page of the Intranet module (Settings > System settings > Module settings > Intranet) and go to the Search tab. Change paths to *.exe files according to their location chosen during the installation of Cygwin: