Giter Club home page Giter Club logo

nodeserver's Introduction

nodeserver

Production webserver for Node.js applications, php websites, statics websites, etc.

nodeserver logo

Nodeserver is a production webserver Node.js applications. It allows you to keep applications alive forever, to reload them, start webistes on php or html, reverse proxy.

If you have ideas or questions, open a new issue with your ideas.

Version npmNPM DownloadsTravis Build Status

How install

Install nodeserver script via npm:

$ sudo npm install nodeserver -g

Install daemon on the system. Currently only support CentOS.

$ sudo nodeserver install centos

Configuration

By default nodeserver read configuration in /etc/nodeserver/nodeserver.config

You can use other path using the command:

$ nodeserver start /path/to/config

or use loop nodeserver with

$ nodeserver start-loop /path/to/config

Basic configuration

The basic configuration file are json with format:

{
  "nodeserver": {
    "admin": {
      "active": "true|false - active the admin web interface",
      "port": "admin listen port. We recommend use port 10000",
      "user": "user for admin access, we recommend not use admin, root or similars",
      "password": "hash password. See generate password section"
    }
  },
  "sites": []
}

The admin interface is a web page where administrator can start, stop process, view logs, etc. If active is false, the other options not mandatory.

Site configuration

Sites is a array of sites. The site has the next format:

{
  "name": "Site name, identify in administrator cli or web",
  "type": "Site type use supported workers: cdn, cgi, php, node, python",
  "bindings": ["array of string with domain (or ip) and port. By default use domain and port 80: example.com:80"],
  "port": "use only in node site. Start the node site in theese port",
  "script": "absolute path of script server in node sites or document root in php, cgi o cdn sites",
  "security": {
    "certs": {
      "key": "absolute path for certificate key",
      "cert": "absolute path for certificate",
      "ca": ["array of certificate ca"]
    },
    "bindings": [
      "similar to bindings option but uses only for SSL connection. By default use domain with port 443, example.com:443"
    ]
  }
}

The port option is only mandatory for nodejs sites.

Use the security option only if you use a SSL in sites.

Reference site configuration

In config file you can use a string for any site where determine the relative path for configuration site. If use /etc/nodeserver for configuration you can create a "sites" folder inside and save a example.config for save json configuration for this site.

A simple configuration nodeserver.config is:

{
  "nodeserver": {
    "admin": {
      "active": false
    }
  },
  "sites": [
    "sites/example.com"
  ]
}

The site / example.com.config file are:

{
  "name": "Example site",
  "type": "cdn",
  "bindings": [
    "example.com:80"
  ],
  "script": "/var/web/example.com"
}

Servers operations

Start server

  $ sudo nodeserver start

Check status and show a list of active webites

  $ nodeserver status

nodeserver status

Stop the server

  $ nodeserver stop

Reload server configuration if nodeserver.config change without stop the server

  $ nodeserver reload

Generate a hash password for use in config file

  $ nodeserver password mypasswordtohash

Thanks

NodeServer is a free and open source community-driven project.

Thanks to the following companies and projects whose work we have used or taken inspiration from in the making of NodeServer:

License

(The MIT License)

Copyright (c) 2014-2017 Juan Benavides

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

nodeserver's People

Contributors

jbalde avatar

Watchers

James Cloos avatar JRichardsz avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.