Vous êtes sur la page 1sur 65

Bitrix Intranet Portal

Installation Guide

Preface
This manual is for reading by Bitrix Intranet Portal users. The document covers the following
most important key points:

installation of the evaluation and commercial versions;


installation using Bitrix Environment;
registration of your Bitrix Intranet Portal copy at the Bitrix company web site,
downloading source codes operations that are essential to obtain the fully-functional
open source system.

This guide provides the detailed solutions of various problems that you may encounter during
the system installation on a local machine. If you confront difficulties installing Bitrix Intranet
Portal on a remote server, you will find the solution in the Installing and configuring Bitrix Site
Manager training course.
Should you have any questions installing the system, you can always ask them at the technical
support service.
Note! This guide uses the terms site and portal as synonyms.

Chapter 1. Installing Bitrix Intranet Portal


All versions of Bitrix Intranet Portal are shipped as .zip and .tar.gz archive files for PHP 4 and
PHP 5. Please note that you have to choose the correct version to match your web server.
q

Download Bitrix Intranet Portal installation package to your server or computer.

Extract files from the archive to the root folder of your site. The unpacked files
require approx. 100 MB of disk space. Also, remember to add for the size of the
downloaded archive file.

Your system should meet the following minimum requirements to install and run Bitrix
Environment:
1. If required, install Apache web server and configure it to support PHP. Bitrix Intranet
Portal requires Apache version 1.3 or better and PHP 4.3.9 or better.
2. If required, install database engine (MySQL version 4.1.11 or higher, Oracle 10g or
higher or MSSQL 2000 or higher).
3. If you install a trial or encoded version, install and configure free Zend Optimizer
version 3.3.0 or better.
4. If you install an Oracle version, ensure that a client part version 9 or better exist. Create
a new user.
5. If you reinstall the system, remember to remove all tables.
6. Ensure that you have at least 10 MB of free disk space for the update system.
To start installation:
q

Open http://<your_site>/index.php in your browser, replace here <your_site>


with the real address of your site.

Follow the Installation Wizard instructions.

Step 1. The Initial Installation Screen


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

Fig. 1.1 The first step of the installation wizard


q

Click Next to continue installation.

Step 2. The License Agreement

Fig. 1.2 The License Agreement


q

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

Click Next to open the next window of the wizard.

Step 3. License Key


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

Fig. 1.3 License key and database


q

License Key field: if you have already purchased a license, enter the license key
here. If you install the product for evaluation purposes, leave the default field value
(DEMO).

Choose database field: select here the database you want to support. If you install
the trial version, you can choose any database.

Attention!
The MSSQL database type will be available if only ODBC is supported by your system.
Oracle databases require the OCI8 library (the file php_oci8.dll) to be installed. If your
system does not meet these conditions, the MSSQL and/or Oracle database types will not be
available.
Oracle and MySQL databases can be installed in UTF-8 encoding. If you choose to install UTF8 version, mark the UTF-8 Installation option.
However, selecting UTF encoding requires the mbstring PHP module to be installed. And you
must check PHP settings:

in the file php.ini:

php.ini
6

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

or

in the file .htaccess:

.htaccess
php_value mbstring.func_overload 2
php_value mbstring.internal_encoding UTF-8
q

Click Next to continue.

Step 4. Preliminary Verification


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

Fig. 1.4 Checking the system for minimum requirements

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.
9

Fig. 1.5 Recommended settings

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.
q

Click Next to continue.

10

Step 5. Database Creation


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

Fig. 1.6 MySQL configuration parameters

If you install Bitrix Intranet Portal on a local machine and have the required applications
(Apache, PHP, MySQL, Zend Optimizer for the trial versions), 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.
Important! When installing Bitrix Intranet Portal with Bitrix Web Environment, type
localhost:31006 in this field.

11

Fig. 1.7 Database settings

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. A new group of fields will appear:
Database administrator parameters.
Database name: the name of the database to which the product will be installed. This
can be any text in Latin letters.
Type of database tables: standard tables are generally good for most use cases.
Select Create new database. A new group of fields will appear: Database
administrator parameters.
Type root in the Admin field.
The Admin password field must be empty.

If you install Bitrix Intranet Portal 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;
12

Database: consult whether you need to create a new database;


Database name;
Type of database tables.

Attention! 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
Fill in the following fields:

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.

Attention! 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.

13

MSSQL database parameters

Fig. 1.8 MSSQL configuration parameters

Fill in the following fields:

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.

Attention! 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.

Attention! 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.

14

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

Fig. 1.9 Additional configuration parameters

Fill in the following fields:

Access permission for site files: 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;
Access permission for site folders: 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.

Attention: 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.

15

Step 6. Installing the System


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.

Fig. 1.10 Installation process

16

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.

Fig. 1.11 Creating the administrator's account

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


Fill in the following fields:

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 Intranet Portal Configuration Wizard will
open.

17

The Intranet Portal Configuration Wizard


Step 1. Initial screen
This screen informs you that the configuration wizard has started.

Fig. 1.12 Running the Intranet Portal Configuration Wizard


q

Here, just click Next.

18

Step 2. The Portal Design


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

Fig. 1.13 Choosing a portal design template


q

Select a desired template by ticking a respective radio button.

Click Next.

19

Step 3. Colour Theme


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

Fig. 1.14 Choosing a portal color theme


q

Choose the desired color theme and click Next.

20

Step 4. Portal Settings


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

Fig. 1.15 Portal settings


q

Type the name of your company.

Click Browse to select the logo image of your company.

Note! The logo image file must not exceed 1.5 MB. The following file formats are supported:
GIF, JPG, PNG.

Tick the option Allow Unauthorized Visitors if you want to allow any visitor,
authorized or unauthorized, to view the portal pages.

If you need to let your users register at the portal without your permission, enable
the option Allow Users to Self-Register.
21

Be sure to leave the option Install Sample Company Structure checked if you
install the system for evaluation purposes.

If you have a properly installed and configured AD server, you can enable users
stored in it to authorize at your portal just leave the option Allow Active
Directory Users to Authorize at Portal checked. If so, you will have to configure
the Active Directory settings after you click Next; otherwise you will see the step 5
of the wizard.

Click Next to go to the next step.

22

Active Directory Configuration


This screen is active if you have left the option Allow Active Directory Users to Authorize at
Portal enabled.

Fig. 1.16 Active Directory settings

Fill in the fields:

Server:port the address and the port of the AD database server (389 is the default
AD server port).
Administrative Login and Administrative Password the login and password
allowing for administrative access to the server.
Click Check to establish a trial connection.
If the trial connection is successful, the server will return a list of available tree roots.
Otherwise, you will see the error description text printed in red.

Tree Root (base DN) the root of the catalog tree in which the user account look-up
will be performed.
23

Use NTLM authentication the domain at which the NTLM authorization will be
performed (your Apache server must have the mod_auth_sspi module installed).
q

Click Next.

Finally, you will have to match the portal user groups to the AD user groups.

Fig. 1.17 Configuring the user group mapping


q

Assign the AD groups the specified portal groups.

Click Install to proceed to the next step.

24

Step 5. Data Installation


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

Fig. 1.18 The portal installation process

25

Step 6. Finishing Configuration


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

Fig. 1.19 The last wizard screen

Note: you can always run the wizard later by selecting Settings -> System Settings- >
Wizards.
Now you can:

Import users to your portal (click Import Users).


Open the portal index page (by clicking Open Portal), or read the portal management
course.

26

Chapter 2. Installation Using Windows Installer


The system exists in the two Windows installer versions:

the trial one (encoded intranet_portal_encode_php5.exe);


and
the commercial version (intranet_portal_source.exe).

Your system should meet the following minimum requirements to install and run Bitrix Intranet
Portal:

Windows 98/ME/NT/2000/XP/2003/Vista/2008 Server;


110 Mb of free disk space;
Internet connection if you install using Bitrix Environment package.

Setup Operations
q

Download the required version at


http://www.bitrixsoft.com/download/intranet/index.php#tab-local-link or
http://www.bitrixsoft.com/download/sources.php.

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 Bitrix Intranet Portal.

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.

27

Step 1. The Initial Installation Screen

Fig. 2.1 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.
q

Click Next. This will open the next step containing the Bitrix Intranet Portal License
Agreement.

28

Step 2. The License Agreement

Fig. 2.2 The License Agreement

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

Click Next to open the next window of the Wizard.

29

Step 3. Bitrix Environment and Encoding

Fig. 2.3 Setting up Bitrix Environment

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

Enable the Download and 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.8, PHP 5.2.6, ZendOptimizer 3.3.0, eAccselerator 0.9.5.
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 Bitrix Intranet Portal 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 Download and install
Bitrix Environment option.

30

Fig. 2.4 Bitrix Environment installation warning


q

Confirm cancellation. The next screen will show.

Fig. 2.5 Destination folder selection


q

Specify the folder in which the Bitrix Intranet Portal files will be unpacked and click
Next.

31

Fig. 2.6 The installation confirmation window

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

If you confirm these preferences, click Install. The step 5 will follow.

32

Step 4. Confirm Installation


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

Fig. 2.7 The installation confirmation window

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

If you confirm these preferences, click Install.

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.

33

Step 5. Copying Files


The installation of Bitrix Intranet Portal is now starting.

Fig. 2.8 Installing Intranet Portal

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

34

Step 6. Final Step

Fig. 2.9 The final step of the installation

This window informs that Bitrix Intranet Portal files have been successfully copied to your
machine.
q

To run Bitrix Intranet Portal right after closing the installation wizard, enable the
Run Bitrix Intranet Portal option.

Click Finish to quit the wizard.

35

Running Bitrix Intranet Portal


The First Run
When the system is starting, it opens a browser window in which you will continue the
installation and configuration of Bitrix Intranet Portal.
If you have installed the system on an existing web environment, the first step of the Intranet
Portal installation wizard will open. A configuration wizard will follow when the installation wizard
completes.
If you have chosen to install the system with Bitrix Web Environment, the number of additional
steps depends on the downloaded version:

the trial version (intranet_portal_encode_php5.exe) includes 2 steps. The first step is


identical to Installing the System step, and the second one - to Creating an
Administrator's Account step. Then, the Intranet Portal Configuration Wizard will start;
the commercial version (intranet_portal_source.exe) includes 3 steps: the first one is
providing the license key; others are similar to those of the trial version.

Subsequent Runs
You can run Bitrix Intranet Portal:

by activating the shortcut

using the Start menu (Start -> Programs -> Bitrix Web Environment ->
Bitrix Web
Environment);
by running BitrixEnv.exe located in the system installation folder (e.g. C:\Program
Files\Bitrix Environment\)

on the Desktop (if you have chosen to create it);

36

Using the Taskbar Icon


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

Fig. 2.10 The taskbar icon

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

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

Fig. 2.11 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;
About product: navigates to the Bitrix company site;
Exit: closes all the applications required by Bitrix Intranet Portal (web server, database
etc.).

37

Chapter 3. Installing Bitrix Web Environment


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

MySQL 5.0.51
Apache 2.2.8
PHP 5.2.6
ZendOptimizer 3.3.0
eAccselerator 0.9.5

Preliminary Operations
Do the following to download Bitrix Web Environment:
q

Open http://www.bitrixsoft.com/download/intranet/index.php#tab-env-link in your


browser (the download page).

Click Download.

Fig. 3.1 Bitrix Web Environment download page


q

Click Save in the file download dialog box.

Run the downloaded file. A Bitrix Web Environment installation wizard window will
open.

38

The Bitrix Web Environment Installation Wizard


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. Note that 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

Fig. 3.2 The first step of the Bitrix Web Environment installation wizard

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

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

39

Step 2. The License Agreement

Fig. 3.3 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.
q

Click Next to open the next window of the Wizard.

40

Step 3. Choosing Installation Folder

Fig. 3.4 Destination folder selection


q

Specify the folder to which the Bitrix Web Environment will be installed. The default
destination directory is \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.

41

Step 4. Shortcuts

Fig. 3.5 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 Intranet Portal. You can
specify a different folder name.
q

Click Next to go to the next step.

42

Step 5. More actions

Fig. 3.6 Additional setup tasks


q

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

Click Next to go to the next step.

43

Step 6. Web Server Parameters

Fig. 3.7 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).
q

Click Next to continue.

44

Step 7. Ready to install

Fig. 3.8 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.
q

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

45

Fig. 3.9 Installing Bitrix Web Environment

Wait until the wizard copies files to your machine.

46

Step 8. Final Step

Fig. 3.10 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 Run Bitrix Web Environment option.
q

Click Finish to quit the wizard.

47

Chapter 4. Side-by-side Installation of Bitrix


Systems
If you need to install and run multiple instances of Bitrix Intranet Portal and/or Bitrix Site
Manager, you can easily accomplish this using a single installation of Bitrix Web Environment.
q

Create a folder in C:\Program Files\Bitrix Environment\. The folder can have any
name.

Add the following lines to httpd.conf (in


C:\Program Files\Bitrix Environment\apache\conf\):

Listen 81
<VirtualHost *:81>
ServerName localhost
DocumentRoot "C:\Program Files\Bitrix Environment\folder_name"
</VirtualHost>

Here, 81 is the port number. The port must be specified twice: with the listen and VirtualHost
directives. You can specify any vacant port number on the range 1 65535 to create a virtual
host.
q

After you have finished the configuration, you will have to restart Bitrix Web
Environment.

Note. You can copy files to the new folder even if Bitrix Web Environment is already running.
Attention! You can create as many sites or portals as required under this model. For each
site, create an individual folder; add a record to httpd.conf specifying a unique port number.
Additionally, the following section in httpd.conf file should be changed:
<Directory>
Options FollowSymLinks
AllowOverride None
</Directory>
q

Replace AllowOverride None with AllowOverride All.

Now you can access your site at http://localhost:81. Use the port number you have specified in
httpd.conf.

48

Chapter 5. Installation Using BitrixInstall


Bitrix Site Manager can be easily installed at a remote server by uploading the installation files
via the FTP or using the BitrixInstall 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 BitrixInstall script to avoid upload
errors and eliminate a frequently occurring problem of different FTP and Apache user access
permissions.
BitrixInstall 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 thirdparty software.
q

Open the page


http://www.bitrixsoft.com/download/intranet/download_intranet.php#tab-setup-link
containing product downloads.

Click the Download link.

Select Save in the download dialog box.

Save the file as bitrixinstall.php.

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>/ bitrixinstall.php (replace <your site>


with the real site name) and press Enter. The browser will display a BitrixInstall
welcome page.

49

Fig. 5.1 The BitrixInstall welcome page

Warning! Please ensure that your web server has enough permissions to create and write
files.

Click Bitrix Site Manager in the Choose a package group and select the product
edition in the drop-down list beside.

Select the product version: evaluation or commercial.


If you select the commercial version, enter your license key.

Click Download. BitrixInstall will start uploading the distribution files to the server.

50

Fig. 5.2 Downloading the installation package using BitrixInstall

BitrixInstall will connect to the Bitrix server directly.


The Back button, when clicked, allows to get back to package selection if you need to change
the upload parameters.
The files of the selected product edition will be copied to the root directory of your server and
unpacked. Upon completion, the Installation Wizard will open in the default system browser
(see The Initial Installation Screen).
Important! For security reasons, bitrixinstall.php will be deleted from the root directory of
your server after file extraction is done.

51

Chapter 6. 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


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:
q

Open Control Panel.

Click Settings -> Update to open the system update form.

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

Fig. 6.1 License key activation message

Here, click Activate Key. The following form will open:

52

Fig. 6.2 Activation form

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


Fill in the following fields:

Key owner (company name or person): specify the name for which the registration
key was issued. This can be a company or an individual person.
Site address: the addresses (URLs) of portals that will be controlled by the system
with this license key.
Phone number of the product copy owner: the contact phone number including the
country and the area codes.
E-mail address for licensing and usage contacts: this e-mail address will be used by
the Bitrix company staff, if such contacts are required.
Contact person responsible for this product copy: specify here the full name of a
contact person including salutation.
E-mail address for technical contacts: the e-mail address of a person who is in
charge of the system maintenance and licensing;
Contact person phone: the phone number of the above mentioned person;
Contact information: any additional contact information you consider essential.
Create user at www.bitrixsoft.com: check this box if you have not registered at the
Bitrix web site yet. If so, upon successful activation, you will be registered there with the
provided personal information. Registration enables you to contact the techsupport
service directly and post to the private forum.

53

I already have a user account: if you are a registered user, select this option and
specify your login.
q

Click Activate key. Now the license is active; you can start using your site.

Registering a Trial Version (DEMO)


If you install the trial version, you will see the License not found message when opening the
Settings -> Update page.

Fig. 6.3 The error notification and the trial key acquisition link

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.
q

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

Fill in the form fields:

54

Fig. 6.4 Registration of the trial version

Last name, Name: specify your last and first names;


E-mail: specify your e-mail address. This must be a valid address; the trial key will be
sent to it;
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;
Database type: select the type of the database on which the system runs.

If you use free versions of Oracle XE / MS SQL Express, enable the Oracle XE / MS SQL
Express option.
q

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 trial license key link, or in the Kernel module
settings page.
q

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.

55

Registering a Trial Version Using a Commercial Key


After you have evaluated the trial version, you can register it again using a commercial license
key. To get a commercial license key, you will need to purchase the Bitrix Intranet Portal
license, enter the key in the License key field (Settings -> System settings -> Module settings > Kernel -> Update system) and click Apply. Then, you will have to activate the key as
described in Registering a Commercial Version. Upon successful registration, you can
download source codes.

56

Chapter 7. The 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! If you use the system at a local machine, your computer must be connected to
the Internet to receive updates.

Updating via Proxy Server


Bitrix Intranet Portal has an option allowing you to set up receiving updates via the proxy server.
The only thing you have to do is specify the proxy server parameters at the Kernel module
settings page (Settings -> System settings -> Module settings -> Kernel -> Update system).

Fig. 7.1 Update system parameters

Example:

Proxy address: 192.168.0.14


Proxy port: 3128

Note the following two options.

Check the integrity of update files. Enabling this option gives 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.
57

Download only stable updates. Certain new modules or updates are available at beta
testing stage. Changing this option is equivalent to clicking the Allow beta versions /
Allow only stable versions link at the Settings -> Update page.

Downloading Updates
To download updates, open the update system page by clicking the button
Panel toolbar.

on the Control

In the Updates tab, you can select the updates for further installation. Thus, you can install
them in required order.
Important! If you encounter any module updates that are dependent on any other available
updates, you must select all the required modules, or none.

Fig. 7.2 Stepwise update form


q

Click Install recommended updates to install the updates selected in the Updates
tab.

58

Downloading Interface Language Files


You can install additional user interface languages.

Fig. 7.3 Downloading interface languages files

Click the Updates tab.


q

Scroll to the Optional updates section, and select the required language and help
files.

Click Install Updates.

59

Downloading Source Codes


After you have registered your product copy and updated the system to the latest version, you
can download the source codes.

Fig. 7.4 Downloading source codes


q

Click the Download source code button. The system will download the source
codes from the Bitrix server.

Now you have the fully functional product copy with the open source codes.
Note! If you install the full, open source code version and enter a commercial license key,
the source code download feature will not be available because all source codes are already
in the distribution package.

60

Chapter 8. Uninstalling Bitrix Intranet Portal


You can uninstall the Bitrix Intranet Portal by selecting one of the commands:
q

Menu Start -> Settings -> Control panel -> Add/Remove Programs

Menu Start -> Programs -> Bitrix Web Environment -> Uninstall

or

Removing Bitrix Intranet Portal from a local machine 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.

61

Chapter 9. Additional Information


Web Server Configuration
By default, the Bitrix Web Environment web server sits at the port 6448. However, you can
change it to any other value on the stipulation that the new port is not in use by other
applications (e.g. IIS).
The virtual web server settings can be changed by editing the file bx_dir.conf, which can be
found in \Program Files\Bitrix Environment\apache\conf\.
DocumentRoot "C:\Program Files\Bitrix Environment\www"
ServerRoot "C:\Program Files\Bitrix Environment\Apache"
Listen 6447

Zend Optimizer Verification


To ensure that Zend Optimizer is installed on the server and obtain its configuration, do the
following.

Create a file test.php. Type the following directive in it:

<?phpinfo();?>

Save the file in the root folder of the site.


Open the file in your browser: http://localhost/test.php.
The browser will display a table similar to the following:

Fig. 9.1 Zend Optimizer verification result

A text framed in red border tells that Zend Optimizer is installed.

62

Fig. 9.2 Current settings of Zend Optimizer installed at a server

Note! For undisturbed operation, Bitrix Intranet Portal requires that Zend Optimizer version
2.6.x or higher is installed.

Creating and Unpacking tar.gz Archives


Creating an archive:
Method 1:
tar -zvcf <dirname>.tar.gz <dirname>/

Method 2:
tar -c dirname|gzip -c - > dirname.tar.gz

Unpacking an archive:
Method 1:
tar -zxvf file_name.tar.gz

Method 2:
gunzip file_name.tar.gz
tar xf file_name

63

Troubleshooting Typical Installation Errors


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

Solution:
Increase memory limit in the MySQL settings.
The recommended parameters to be specified in the MySQL configuration file (my.cnf) include
the following:
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

You will have to restart MySQL after saving changes.

Possible Zend Optimizer Issues


Problem:
The following output is displayed after the site is transferred to a remote hosting:
Zend 2002062301116956658x 2 ZoF * .] tqF$ bKI (m `erJBR
O:6gtm Y:t YfKQ H ywIt w> np>{?f7klp

Solution:
Zend Optimizer is not installed. You should call your hosting techsupport service to solve this
problem, or install it by yourself if possible.
After Zend Optimizer is installed, the corresponding notice will be displayed in the phpinfo()
function report.
We recommend to use Zend Optimizer version 3.3.0 or higher.
Important! Only the trial version requires Zend Optimizer. The commercial version is
shipped with full open source code and does not require it.
64

Problem:
The following error occurs:
Fatal error: Unable to read 63841 bytes in
/disk2/clients/a1922/site.ru/htdocs/bitrix/modules/main/tools.php on line 0

Solution:
This error arises when running the encoded trial version. Files have been obviously transferred
via the FTP in text mode. Files encoded with Zend Optimizer are binary so you have to ensure
you transfer files in binary mode.

65