You are here

Home » API reference » Node.js integration 6

README.txt in Node.js integration 6

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

This module adds Node.js integration to Drupal.

It is currently alpha software, use at your own risk. It may eat your lunch and kill your kittens.

Setup
=====

Node.js server on Ubuntu:

1. Make sure you have the prerequisites in your ubuntu

        sudo apt-get install build-essential git curl openssl libssl-dev -y

2. Install Node.js.

        mkdir -p ~/local/src && cd ~/local/src && git clone git://github.com/joyent/node.git && cd node && ./configure && make && sudo make install

3. Install [npm](http://npmjs.org/) and run `npm install` (our server relies on
   [Socket.io](http://socket.io/), [connect](http://senchalabs.github.com/connect/),
   and [express](http://expressjs.com/)).

        sudo curl http://npmjs.org/install.sh | sh
        cd /into/the/nodejs/drupalmodule
        npm install

4. Optionally, copy 'server.js' to a directory specific to the Node.js server used by Drupal.

5. Activate the nodejs module and optionally sub-modules.

6. Optionally, copy 'server.js' to a directory specific to the Node.js server used by Drupal.

7. Configure nodejs at your Drupal page: Administration > Configuration > Node.js

8. If you enabled the nodejs_config module, set the fields and save it.
   or copy 'nodejs.config.js.example' to 'nodejs.config.js' (in the same
   directory where server.js is located). Edit the values to taste.

9. Run the node server with the command: node server.js

11. ...

12. Profit!

Useful links:

  - how to turn nodejs into a service http://kevin.vanzonneveld.net/techblog/article/run_nodejs_as_a_service_on_ubuntu_karmic/

Troubleshooting:

  - If running node server.js returns an error:
    - Check your versions of Express and Connect. This module works with Connect 1.1.4 and Express 2.4.3,
      which are NOT the versions npm (node package manager) installs by default.
      You may need to roll these back, which can be done with npm, using these commands:
        - npm install connect@1.1.4
        - npm install express@2.4.3

File

README.txt
View source 
  1. Node.js integration

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

  3. 

  4. This module adds Node.js integration to Drupal.

  5. 

  6. It is currently alpha software, use at your own risk. It may eat your lunch and kill your kittens.

  7. 

  8. Setup

  9. =====

  10. 

  11. Node.js server on Ubuntu:

  12. 

  13. 1. Make sure you have the prerequisites in your ubuntu

  14. 

  15.         sudo apt-get install build-essential git curl openssl libssl-dev -y

  16. 

  17. 2. Install Node.js.

  18. 

  19.         mkdir -p ~/local/src && cd ~/local/src && git clone git://github.com/joyent/node.git && cd node && ./configure && make && sudo make install

  20. 

  21. 3. Install [npm](http://npmjs.org/) and run `npm install` (our server relies on

  22.    [Socket.io](http://socket.io/), [connect](http://senchalabs.github.com/connect/),

  23.    and [express](http://expressjs.com/)).

  24. 

  25.         sudo curl http://npmjs.org/install.sh | sh

  26.         cd /into/the/nodejs/drupalmodule

  27.         npm install

  28. 

  29. 4. Optionally, copy 'server.js' to a directory specific to the Node.js server used by Drupal.

  30. 

  31. 5. Activate the nodejs module and optionally sub-modules.

  32. 

  33. 6. Optionally, copy 'server.js' to a directory specific to the Node.js server used by Drupal.

  34. 

  35. 7. Configure nodejs at your Drupal page: Administration > Configuration > Node.js

  36. 

  37. 8. If you enabled the nodejs_config module, set the fields and save it.

  38.    or copy 'nodejs.config.js.example' to 'nodejs.config.js' (in the same

  39.    directory where server.js is located). Edit the values to taste.

  40. 

  41. 9. Run the node server with the command: node server.js

  42. 

  43. 11. ...

  44. 

  45. 12. Profit!

  46. 

  47. Useful links:

  48. 

  49.   - how to turn nodejs into a service http://kevin.vanzonneveld.net/techblog/article/run_nodejs_as_a_service_on_ubuntu_karmic/

  50. 

  51. Troubleshooting:

  52. 

  53.   - If running node server.js returns an error:

  54.     - Check your versions of Express and Connect. This module works with Connect 1.1.4 and Express 2.4.3,

  55.       which are NOT the versions npm (node package manager) installs by default.

  56.       You may need to roll these back, which can be done with npm, using these commands:

  57.         - npm install connect@1.1.4

  58.         - npm install express@2.4.3