Master publish

Author: Manbearpixel

.gitignore

@@ -0,0 +1 @@
+node_modules

README.md

@@ -1,2 +1,106 @@
 # ExpressVirtualHostExample
-A simple example of a virtual host setup using NodeJS and Express
+
+A simple example of a virtual host setup using NodeJS and Express applications.
+
+## Getting Started
+
+Virtual Hosts allow you to handle multiple domain names through a single server instance compared to having to run a separate server per host configuration. This will share **all system resources** such as memory, processor cycles, and storage across all your applications.
+
+[ExpressJS](https://expressjs.com/) is a minimal and flexible web application framework that runs ontop of [Node.js](https://nodejs.org/en/). Express allows for both dynamic and static website hosting and is ideal for this scenario.
+
+### Prerequisites
+
+1 -- Install [Node.js and npm](https://nodejs.org/en/download/) if they are not already installed on your machine.
+> Verify that you are running at least node 6.9.x and npm 3.x.x by running `node -v` and `npm -v` in a terminal/console window. Older versions produce errors, but newer versions are fine.
+
+2 -- Optionally, install `Git` if you do not have it already installed on your machine. If you do not install Git, you will have to download this repository separately as a zipped folder and unzip it later.
+
+3 -- Have ownership over a website(s) and ability to modify the DNS/Network configuration for each host.
+
+4 -- Create `A` DNS records for each host you want your server instance to manage and have it set to the IP Address of your sever.
+
+### Installing
+
+1 -- Clone this repository onto your server instance using `Git`. If you do not have Git installed, you will need to download this repository as a folder and unzip it.
+
+```sh
+git clone https://github.com/Manbearpixel/ExpressVirtualHostExample.git
+```
+
+2 -- In your terminal/console window install the dependencies this project requires.
+
+```sh
+# switch to the downloaded repository
+cd ExpressVirtualHostExample
+
+# install dependencies
+npm install
+```
+
+3 -- If you are going to use the example express application sub directories (admin, dash, and proto) install their dependencies as well.
+
+```sh
+# install sub-folder dependencies (this includes: admin/, dash/, proto/
+npm init
+```
+
+4 -- You will need to edit `boot.js` properly by pointing your domain names (example.com) or subdomain names (sub.example.com) to the respective folder. You can use the current example folders to play with for now (admin, dash, proto).
+
+```js
+// This function creates a virtual host for a specified "domainName"
+// and will send traffic to the "directoryPath"
+function createVirtualHost(domainName, directoryPath)
+...
+
+// This creates an instance of a virtual host and will route traffic
+// that hits "dash.example.com" to the folder "dash/"
+let dashboardHost = createVirtualHost('dash.loki.chat', 'dash');
+...
+
+// This tells the primary Express App to use the virtual host instance
+// created earlier
+app.use(dashboardHost);
+```
+
+### Running
+
+To run the Express VirtualHost server, simply run the command `npm run start`. This will listen to traffic hitting your server (default port = :80). Assuming you have the proper DNS settings for your websites and matching domains set in `boot.js` then traffic will flow properly. You can turn off your server by stopping this process.
+
+If you want to run your server indefinitvely (until you stop it later) and have this server process run in the background, you can install `forever` via npm and execute the `boot.js` file.
+
+```
+# install foreverjs globally
+npm install forever -g
+
+# execute boot.js "forever" ...until you manually stop it
+forever start boot.js
+
+# lists all processes managed by foreverjs
+forever list
+
+# stop a specific forever process, replace 0 with the proper number
+forever stop 0
+```
+
+## Built With
+
+* [Node.js](https://nodejs.org/en/) - The JavaScript runtime engine
+* [Express](https://expressjs.com/) - Web application framework
+* [Vhost](https://github.com/expressjs/vhost) - VirtualHost middleware for Express
+
+## Contributing
+
+No contributions at this time.
+
+## Versioning
+
+Using [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/your/project/tags). 
+
+## Authors
+
+* **Manbearpixel** - *Initial work* - [Manbearpixel](https://github.com/Manbearpixel)
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details
+

admin/app.js

@@ -0,0 +1,41 @@
+var createError = require('http-errors');
+var express = require('express');
+var path = require('path');
+var cookieParser = require('cookie-parser');
+var logger = require('morgan');
+
+var indexRouter = require('./routes/index');
+var usersRouter = require('./routes/users');
+
+var app = express();
+
+// view engine setup
+app.set('views', path.join(__dirname, 'views'));
+app.set('view engine', 'ejs');
+
+app.use(logger('dev'));
+app.use(express.json());
+app.use(express.urlencoded({ extended: false }));
+app.use(cookieParser());
+app.use(express.static(path.join(__dirname, 'public')));
+
+app.use('/', indexRouter);
+app.use('/users', usersRouter);
+
+// catch 404 and forward to error handler
+app.use(function(req, res, next) {
+  next(createError(404));
+});
+
+// error handler
+app.use(function(err, req, res, next) {
+  // set locals, only providing error in development
+  res.locals.message = err.message;
+  res.locals.error = req.app.get('env') === 'development' ? err : {};
+
+  // render the error page
+  res.status(err.status || 500);
+  res.render('error');
+});
+
+module.exports = app;

admin/bin/www

@@ -0,0 +1,90 @@
+#!/usr/bin/env node
+
+/**
+ * Module dependencies.
+ */
+
+var app = require('../app');
+var debug = require('debug')('admin:server');
+var http = require('http');
+
+/**
+ * Get port from environment and store in Express.
+ */
+
+var port = normalizePort(process.env.PORT || '3000');
+app.set('port', port);
+
+/**
+ * Create HTTP server.
+ */
+
+var server = http.createServer(app);
+
+/**
+ * Listen on provided port, on all network interfaces.
+ */
+
+server.listen(port);
+server.on('error', onError);
+server.on('listening', onListening);
+
+/**
+ * Normalize a port into a number, string, or false.
+ */
+
+function normalizePort(val) {
+  var port = parseInt(val, 10);
+
+  if (isNaN(port)) {
+    // named pipe
+    return val;
+  }
+
+  if (port >= 0) {
+    // port number
+    return port;
+  }
+
+  return false;
+}
+
+/**
+ * Event listener for HTTP server "error" event.
+ */
+
+function onError(error) {
+  if (error.syscall !== 'listen') {
+    throw error;
+  }
+
+  var bind = typeof port === 'string'
+    ? 'Pipe ' + port
+    : 'Port ' + port;
+
+  // handle specific listen errors with friendly messages
+  switch (error.code) {
+    case 'EACCES':
+      console.error(bind + ' requires elevated privileges');
+      process.exit(1);
+      break;
+    case 'EADDRINUSE':
+      console.error(bind + ' is already in use');
+      process.exit(1);
+      break;
+    default:
+      throw error;
+  }
+}
+
+/**
+ * Event listener for HTTP server "listening" event.
+ */
+
+function onListening() {
+  var addr = server.address();
+  var bind = typeof addr === 'string'
+    ? 'pipe ' + addr
+    : 'port ' + addr.port;
+  debug('Listening on ' + bind);
+}