You are here

Home » API reference » Node.js integration 7

README.txt in Node.js integration 7

Same filename and directory in other branches
  1. 8 README.txt
  2. 6 README.txt
Node.js integration
===================

This module adds Node.js integration to Drupal. It provides an API that other
modules can use to add realtime capabilities to Drupal, such as push
notifications or chat. The module relies on a Node.js server application that
maintains an open connection with the visitor's browser to enable instant
communication. In order to use this module, you will need to install the Node.js
application on a server.

Installation
============

1. Install Node.js on your server, if not installed yet. Download the installer
   and follow the instructions on the Node.js website:
   https://nodejs.org/en/download/

2. Install the drupal-node.js server application and ensure that the application
   is running. Follow the instruction on GitHub:
   https://github.com/beejeebus/drupal-nodejs

3. Install and enable the Node.js integration Drupal module on your site.

4. Visit the Node.js configuration page under the Configuration menu, and enter
   the connection information for your Node.js server application. The protocol,
   port, and service key settings should match the settings you entered in the
   config file of the Node.js server application. The host should be set to the
   hostname of the server on which you installed the Node.js server application.
   This host needs to be publicly accessible (i.e. "localhost" will not work).

5. Visit the status page of your Drupal site and ensure that there are no
   errors. Node.js should report that it has successfully connected to the
   Node.js server.

Note: The Drupal module and Node.js server application are sensitive to version
numbers. Ensure that you are running the latest version of both. The Drupal
status page will show an error if the versions are not compatible.

File

README.txt
View source 
  1. Node.js integration

  2. ===================

  3. 

  4. This module adds Node.js integration to Drupal. It provides an API that other

  5. modules can use to add realtime capabilities to Drupal, such as push

  6. notifications or chat. The module relies on a Node.js server application that

  7. maintains an open connection with the visitor's browser to enable instant

  8. communication. In order to use this module, you will need to install the Node.js

  9. application on a server.

  10. 

  11. Installation

  12. ============

  13. 

  14. 1. Install Node.js on your server, if not installed yet. Download the installer

  15.    and follow the instructions on the Node.js website:

  16.    https://nodejs.org/en/download/

  17. 

  18. 2. Install the drupal-node.js server application and ensure that the application

  19.    is running. Follow the instruction on GitHub:

  20.    https://github.com/beejeebus/drupal-nodejs

  21. 

  22. 3. Install and enable the Node.js integration Drupal module on your site.

  23. 

  24. 4. Visit the Node.js configuration page under the Configuration menu, and enter

  25.    the connection information for your Node.js server application. The protocol,

  26.    port, and service key settings should match the settings you entered in the

  27.    config file of the Node.js server application. The host should be set to the

  28.    hostname of the server on which you installed the Node.js server application.

  29.    This host needs to be publicly accessible (i.e. "localhost" will not work).

  30. 

  31. 5. Visit the status page of your Drupal site and ensure that there are no

  32.    errors. Node.js should report that it has successfully connected to the

  33.    Node.js server.

  34. 

  35. Note: The Drupal module and Node.js server application are sensitive to version

  36. numbers. Ensure that you are running the latest version of both. The Drupal

  37. status page will show an error if the versions are not compatible.