Upgrade from Nginx-PushStreamModule to Bitrix Push server 2.0

  General information

The queue server module Nginx-PushStreamModule is out-of-date and can be unstable (slow messaging, crashes). As a result of this, message may not be delivered which causes high load on PHP service due to Nginx operation specifics. It is also has limited features: it doesn't support protobuf and personal channels that work without server, no public channel polling, etc.

The latest Bitrix24 products operate much better with the new Bitrix Push server 2.0 queue server. For example, telephony and chats handle it much faster, i. e. communicate with users directly, skipping the PHP.

  1. VMBitrix update

Update Bitrix Virtual Appliance to the latest stable version: 2. Configure localhost settings > 6. Update server.

  2. Bitrix Push server 2.0 Installation

Bitrix Virtual Appliance version 7.4.4 and lower uses Nginx-PushStreamModule as a queue server by default.

Check Bitrix Virtual Appliance main menu: 9. Configure Push/RTC service for the pool and see which server is used as the queue server. This example shows that it is Nginx-PushStreamModule:

Select the menu item 1. Install/Update NodeJS RTC service, enter the host name Hostname and confirm the installation:

Standby until NodeJS-PushServer service installation and initialization task is complete:

  3. Bitrix Push server 2.0

Control Panel path Settings > System Settings > Module Settings > Push and Pull shows that queue server configured as the module [dw]nginx-push-stream-module[/dw][di][/di].

You need to preliminarily reset queue server settings in the Control Panel: Settings > System Settings > Module Settings > Push and Pull. Click on the

Reset defaults:

To enable new queue server Bitrix Push server 2.0, select Virtual Appliance 7.3 and later (Bitrix Push server 2.0) select in the option Use "Push server": User local server and click save:

All is complete. Usually, no additional settings are required.

  Possible errors

When Bitrix Push server 2.0 is installed and started for the first time, a secret key is generated inside the queue server settings file /etc/push-server/push-server*.json in the section security in the parameter key:

"security": {
	"key": "<your secret key>"
},

When Bitrix Push server 2.0 is started at the BitrixVM Virtual Appliance for the first time, this code is automatically written into the system kernel file /bitrix/.setting.php and in the database, as well as it is visible in the control panel inside the field Signature code for server interaction:

There are situations, when due to some reasons the secret key in the kernel settings file /bitrix/.setting.php and in the database differs from the key that is written in the queue server settings. Because of this, queue server operates incorrectly and messages are not delivered.

To solve this issue, re-create the NodeJS-PushServer role in the BitrixVM Virtual Appliance: 9. Configure Push/RTC service for the pool > 1. Install/Update NodeJS RTC service

When you have your own custom virtual environment, it can be done manually:

1. Copy the key from the queue server settings file /etc/push-server/push-server*.json.
2. Inside the Bitrix24 Control Panel, proceed as follows: Settings > System Settings > Module Settings > Push and Pull and reset queue server settings by clicking on the Restore defaults button.
3. Insert the copied key Signature code for server interaction and save the settings.

After this procedure, the server operation will be restored.

  Extra materials

• Upgrade from Bitrix Push server 1.0 to Bitrix Push server 2.0
• Push and Pull module and queue server settings.