На серверной стороне поддержка мгновенных сообщений осуществляется модулем NGINX: nginx-push-stream-module. Данный модуль обеспечивает поддержку long-polling соединений с клиентами и доставку опубликованных им сообщений.

При открытии страницы клиент ajax-запросом, подключается к своему каналу на одном из портов NGINX: 8893 (http) или 8894 (https). (В случае использования виртуальной машины BitrixVM. При использовании собственной конфигурации сервера администратор волен использовать любые удобные ему порты.) С данного порта NGINX перенаправляет пользователя на внутренний сервер очередей (доступный только по 127.0.0.1:8895), где проверятся наличие канала пользователя и новых сообщений. В случае если в канале нет сообщений, сервер не отдает ответ, а держит соединение в течение 40 сек.

Если в течение этого времени в канал пользователя придет новое сообщение, то сервер отправит его клиенту и закроет соединение. В случае если в канал пользователя не будет новых сообщений в течение 40 секунд, то сервер разорвет соединение и отправит ему заголовок: 304 Not Modified.

После получения ответа сервера и закрытия соединения клиент выполнит повторное подключение к каналу с новой датой последнего изменения.

Сообщения в канал пользователя публикуются посредством вызова соответствующих методов API модуля Push and Pull.

Для работы с мгновенными сообщениями рекомендуем использовать протокол https.

Настройка модуля

При использовании продуктов Bitrix Framework на базе виртуальной машины BitrixVM с v. 5.0 необходимости в настройке модуля нет: всё работает "из коробки". Если проект используется не на штатных средствах установки Bitrix Framework, то необходимо произвести дополнительные настройки.

• Соберите NGINX с поддержкой модуля nginx-push-stream-module;
  

  В качестве примеров можно использовать файлы из нашей виртуальной машины:

  • /etc/nginx/bx/site_enabled/push.conf – настройки push and pull для публикации сообщений, а так же для работы мобильных;
  • /etc/nginx/bx/conf/im_subscrider.conf – настройки для получения сообщений (они подключаются к сайту непосредственно);
  • /etc/nginx/bx/conf/im_settings.conf – количество каналов, объём памяти и т.п.

• Общие настройки (файл /etc/nginx/bx/conf/im_settings.conf):

  # Common settings for nginx-push-stream-module
  push_stream_shared_memory_size 256M;
  push_stream_max_messages_stored_per_channel 1000;
  push_stream_max_channel_id_length 32;
  push_stream_max_number_of_channels 200000;
  push_stream_message_ttl 86400;

• Настроить отдельные виртуальные сервера NGINX на портах 8893, 8894, 8895 (/etc/nginx/bx/site_enabled/push.conf):

  # поддержка мобильных платформ, для http запросов
  server {
      # nginx-push-stream-module server for push & pull
  
  listen 8893;
  server_name _;
  
  # Include error handlers
  include bx/conf/errors.conf;
  
  # Include im subscrider handlers
  include bx/conf/im_subscrider.conf;
  
  location ^~ / { deny all; }
  }
  # поддержка мобильных платформ, для https запросов
  # SSL enabled server for reading personal channels
  server {
      listen 8894;
  server_name _;
      include bx/conf/ssl.conf;
  
  # Include error handlers
  include bx/conf/errors.conf;
  
  # Include im subscrider handlers
  include bx/conf/im_subscrider.conf;
  
  location ^~ / { deny all; }
  }
  # для публикации сообщений
  # Server to push messages to user channels
  server {
      listen 127.0.0.1:8895;
  server_name _;
  
  location ^~ /bitrix/pub/ {
      push_stream_publisher admin;
      push_stream_channels_path $arg_CHANNEL_ID;
      push_stream_store_messages on;
      allow 127.0.0.0/8;
  deny all;
  }
  
  location ^~ / { deny all; }
  
  # Include error handlers
  include bx/conf/errors.conf;
  }

  Для получения сообщений через запрос на стандартный порт (80 для http, 443 для https) в файл /etc/nginx/bx/conf/im_subscrider.conf добавлено:

  # Include im subscrider handlers
  include bx/conf/im_subscrider.conf;

  Этот файл содержит:

  # Location for long-polling connections
  location ^~ /bitrix/sub {
  
  # we don't use callback and droppped it (XSS)
  if ( $arg_callback ) {
      return 400;
  }
  
      push_stream_subscriber            long-polling;
      push_stream_allowed_origins "*";
      push_stream_channels_path        $arg_CHANNEL_ID;
      push_stream_last_received_message_tag    $arg_tag;
      if ($arg_time) {
          push_stream_last_received_message_time "$arg_time";
      }
      push_stream_longpolling_connection_ttl    40;
      push_stream_authorized_channels_only    on;
      push_stream_message_template '#!NGINXNMS!#{"id":~id~,"channel":"~channel~","tag":"~tag~","time":"~time~","eventid":"~event-id~","text":~text~}#!NGINXNME!#';
  }
  
  # Location for websocet connections
  location ^~ /bitrix/subws/ {
      push_stream_subscriber websocket;
      push_stream_channels_path        $arg_CHANNEL_ID;
      push_stream_websocket_allow_publish    off;
      push_stream_ping_message_interval    40s;
      push_stream_authorized_channels_only     on;
      push_stream_last_received_message_tag    "$arg_tag";
      push_stream_last_received_message_time    "$arg_time";
      push_stream_message_template '#!NGINXNMS!#{"id":~id~,"channel":"~channel~","tag":"~tag~","time":"~time~","eventid":"~event-id~","text":~text~}#!NGINXNME!#';
  }  
  

• Общие настройки:

  # Common settings for nginx-push-stream-module
  
  push_stream_shared_memory_size			256M;
  push_stream_max_messages_stored_per_channel	1000;
  push_stream_max_channel_id_length		32;
  push_stream_max_number_of_channels		100000;
  push_stream_shared_memory_cleanup_objects_ttl	60;
  push_stream_message_ttl				86400;
  

• Настройки сервера мгновенных сообщений

  	# Nonsecure server for reading personal channels. Use secure server instead.
  	server {
  		# nginx-push-stream-module server for push & pull
  
  		listen	8893;
  		include	bx/node_host.conf;
  
  		# Include error handlers
  		include	bx/conf/errors.conf;
  
  		# Location for long-polling connections
  		location ^~ /bitrix/sub {
  			push_stream_subscriber			long-polling;
  			set $push_stream_channels_path		$arg_CHANNEL_ID;
  			push_stream_last_received_message_tag	$arg_tag;
  			push_stream_longpolling_connection_ttl	40;
  			push_stream_authorized_channels_only	on;
  			push_stream_content_type		"text/html; charset=utf-8";
  			push_stream_message_template "#!NGINXNMS!#{
                              \"id\":~id~,\"tag\":\"~tag~\",\"time\":\"~time~\",\"text\":~text~}#!NGINXNME!#";
  		}
  
  		# Location for websocet connections
  		location ^~ /bitrix/subws/ {
  			push_stream_websocket;
  			set $push_stream_channels_path		$arg_CHANNEL_ID;
  			push_stream_websocket_allow_publish	off;
  			push_stream_ping_message_interval	40s;
  			push_stream_authorized_channels_only on;
  			push_stream_message_template		"#!NGINXNMS!#{
                              \"id\":~id~,\"tag\":\"~tag~\",\"time\":\"~time~\",\"text\":~text~}#!NGINXNME!#";
  		}
  
  		location ^~ / 			{ deny all; }
  	}
  
  	# SSL enabled server for reading personal channels
  	server {
  		listen	8894;
  		include	bx/node_host.conf;
  		include	bx/conf/ssl.conf;
  
  		# Include error handlers
  		include	bx/conf/errors.conf;
  
  		add_header "Access-Control-Allow-Origin" "*";
  		add_header "Access-Control-Allow-Headers" "if-modified-since, origin, if-none-match";
  
  		# Location for long-polling connections
  		location ^~ /bitrix/sub {
  			push_stream_subscriber			long-polling;
  			set $push_stream_channels_path		$arg_CHANNEL_ID;
  			push_stream_last_received_message_tag	$arg_tag;
  			push_stream_longpolling_connection_ttl	40;
  			push_stream_authorized_channels_only	on;
  			push_stream_content_type		"text/html; charset=utf-8";
  			push_stream_message_template		"#!NGINXNMS!#{
                              \"id\":~id~,\"tag\":\"~tag~\",\"time\":\"~time~\",\"text\":~text~}#!NGINXNME!#";
  		}
  
  		# Location for web socket connections
  		location ^~ /bitrix/subws/ {
  			push_stream_websocket;
  			set $push_stream_channels_path		$arg_CHANNEL_ID;
  			push_stream_websocket_allow_publish	off;
  			push_stream_ping_message_interval	40s;
  			push_stream_authorized_channels_only	on;
  			push_stream_message_template		"#!NGINXNMS!#{
                               \"id\":~id~,\"tag\":\"~tag~\",\"time\":\"~time~\",\"text\":~text~}#!NGINXNME!#";
  		}
  
  		location ^~ / 			{ deny all; }
  	}
  
  	# Server to push messages to user channels
  	server {
  		listen 127.0.0.1:8895;
  		include	bx/node_host.conf;
  
  		location ^~ /bitrix/pub/ {
  			push_stream_publisher			admin;
  			set $push_stream_channel_id		$arg_CHANNEL_ID;
  			push_stream_store_messages		on;
  			push_stream_keepalive			off;
  			allow					127.0.0.0/8;
  			deny					all;
  		}
  
  		location ^~ /	{ deny all; }
  
  		# Include error handlers
  		include	bx/conf/errors.conf;
  	}

• Включите в настройках продукта на странице Настройки > Настройки продукта > Настройки модулей > Push and Pull опцию На сервере установлен модуль nginx-push-stream-module:

  Также необходимо выбрать версию используемой вами машины. Рекомендуется использовать Виртуальную машину в версии 4.4 и выше, так как в ней используется более совершенная версия модуля nginx-push-stream-module 0.4.0, позволяющая использовать технологию Веб-сокетов и отправление команд.

• При необходимости перенастройте шаблоны путей. Если используется Виртуальная машина, либо настройка nginx-push-stream-module производилась по аналогии с BitrixEnvironment, то изменения путей не требуется.
Внимание! Если у вас появляется ошибка вида:

XMLHttpRequest cannot load 
http://example.com:8893/bitrix/sub/?CHANNEL_ID=<уникальный_адрес_канала>&tag=1&rnd=1380619831146. 
Origin http://example.com is not allowed by Access-Control-Allow-Origin.

значит, вы используете версию модуля nginx push stream module до 0.3.4.

Необходимо либо обновить версию модуля, либо закомментировать строки:

add_header "Access-Control-Allow-Origin" "*";
add_header "Access-Control-Allow-Headers" "if-modified-since, origin, if-none-match";