You are here

README.txt in Node.js integration 8

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

This module adds Node.js integration to Drupal.

Setup
=====

1. Install drupal-node.js package with npm:

    npm install drupal-node.js

Make sure to do this outside of your Drupal modules directory, else Drupal may
try to process folders containing Node.js module information and fail. Follow
the install instructions in the drupal-node.js NPM package. You will need to
provide the hostname and port of your Drupal site to the Node.js process, and
ensure that the service token matches between Drupal and Node.js.

2. Point Drupal at the Node.js server process, either using the configuration
page or settings.php.

To use the configuration page, visit '/admin/config/nodejs/settings', and enter
the appropriate values.

To use your settings file, edit settings.php to add:

    $config['nodejs.config'] = [
      // Configuration values here. See the module's config file:
      //
      //   config/install/nodejs.config.yml
      //
      // for the values you can override.
    ];

3. Visit the reports page to validate that Drupal can communicate successfully
with the Node.js server process.

File

README.txt
View source
  1. Node.js integration
  2. ===================
  3. This module adds Node.js integration to Drupal.
  4. Setup
  5. =====
  6. 1. Install drupal-node.js package with npm:
  7. npm install drupal-node.js
  8. Make sure to do this outside of your Drupal modules directory, else Drupal may
  9. try to process folders containing Node.js module information and fail. Follow
  10. the install instructions in the drupal-node.js NPM package. You will need to
  11. provide the hostname and port of your Drupal site to the Node.js process, and
  12. ensure that the service token matches between Drupal and Node.js.
  13. 2. Point Drupal at the Node.js server process, either using the configuration
  14. page or settings.php.
  15. To use the configuration page, visit '/admin/config/nodejs/settings', and enter
  16. the appropriate values.
  17. To use your settings file, edit settings.php to add:
  18. $config['nodejs.config'] = [
  19. // Configuration values here. See the module's config file:
  20. //
  21. // config/install/nodejs.config.yml
  22. //
  23. // for the values you can override.
  24. ];
  25. 3. Visit the reports page to validate that Drupal can communicate successfully
  26. with the Node.js server process.