https://github.com/kathan/js-cgi

Javascript CGI process manager.
https://github.com/kathan/js-cgi

javascript js-cgi middleware nginx nodejs workers

Last synced: about 1 month ago
JSON representation

Javascript CGI process manager.

• Host: GitHub
• URL: https://github.com/kathan/js-cgi
• Owner: kathan
• License: mit
• Created: 2015-05-12T16:10:23.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2018-10-30T21:52:12.000Z (about 6 years ago)
• Last Synced: 2024-10-09T11:22:35.120Z (about 1 month ago)
• Topics: javascript, js-cgi, middleware, nginx, nodejs, workers
• Language: JavaScript
• Homepage:
• Size: 66.4 KB
• Stars: 0
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.txt

Awesome Lists containing this project

README

        
# js-cgi  - Javascript CGI process manager

js-cgi is a javascript CGI process manager, similar to php-fpm, for executing node.js scripts behind NGINX or Apache. Comes in handy if you want to run PHP along side node.js or if you don't want to write your own web server into your node.js application.

### Dependencies:

* express.js

### Configuration:

On startup, js-cgi will look for a config file called `js-cgi.config` in the same folder as the js-cgi.js file. If it's not found it will use the defaults.

Example:

```js

module.exports = {

   port:3000,

   localhostOnly:true,

   workers:2

};

```

* port - Indicates which TCP port to listen on. default=3000

* localhostOnly - Prevents remote agents from invoking scripts. default=true

* workers - Number of worker processes. default=the number of processors on the local machine.

### Usage:

Add a directive to your `nginx.conf` file. Using an "njs" extension on the server javascript files instead of a "js" extension will enable NGINX to distinguish server scripts from browser javascript files.

```

location ~ [^/]\.njs(/|$) {

   proxy_pass   http://localhost:3000;

   proxy_set_header X-Real-IP $remote_addr;

   proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

   proxy_set_header Host $http_host;

   proxy_set_header X-NginX-Proxy true;

   proxy_set_header path_translated $document_root$fastcgi_path_info;

}

```

### Middleware

If you want to use express.js middleware, create a "use.js" file and save it to the same folder as the js-cgi app like so:

```js

var bodyParser = require('body-parser'),

    cookieParser = require('cookie-parser'),

    fileUpload = require('express-fileupload');

module.exports = function(app){

  app.use(fileUpload());//for uploading files

  app.use(bodyParser.json()); // for parsing application/json

  app.use(bodyParser.urlencoded({ extended: true })); // for parsing application/x-www-form-urlencoded

  app.use(cookieParser());// for parsing cookies

}

```

Once you configure and restart NGINX, you can start js-cgi.

```sh

node js-cgi.js

```