Browse Source

Change webroot path, update README.

pull/5/head
Muthu Kumar 7 years ago
parent
commit
4bbd6ab789
  1. 19
      README.md
  2. 3
      index.js
  3. 2
      package-lock.json
  4. 2
      utils/nginxPath.js

19
README.md

@ -30,21 +30,18 @@ Install `up` from npm:
## Commands ## Commands
`up static <domain>` - Create new static server at current folder. Format: `up command <required> [optional]`
`up proxy <domain> <port>` - Create new proxy server listening at said port. - `up static <domain> [outbound port]` - Create new static server at current folder.
- `up proxy <domain> <inbound port> [outbound port]` - Create new proxy server listening at said port.
`up list` - List currently available servers. (Doesn't work yet) - `up list` - List currently available servers. (Doesn't work yet)
- `up kill <domain>` - Kill the server for this domain.
`up kill <domain>` - Kill the server for this domain.
## Examples ## Examples
`up static example.com` will serve a static website from current folder. - `up static example.com` will serve a static website from current folder.
- `up proxy example.com 8081` will create a reverse proxy listening at port 8081.
`up proxy example.com 8081` will create a reverse proxy listening at port 8081. - `up kill example.com`
`up kill example.com`
## Contributors, Collaborators, and Guides ## Contributors, Collaborators, and Guides

3
index.js

@ -13,7 +13,8 @@ var createProxyServer = require('./actions/createProxyServer');
var createStaticServer = require('./actions/createStaticServer'); var createStaticServer = require('./actions/createStaticServer');
var killServer = require('./actions/killServer'); var killServer = require('./actions/killServer');
// Check for requirements such as OS version and nginx install. Throw and exit if requirements not found. #Roadmap: Add ability to satisfy any possible requirements. // Check for requirements such as OS version and nginx install. Throw and exit if requirements not found.
// #Roadmap: Add ability to satisfy any possible requirements.
requirements(); // Comment in development and uncomment this line in production. This should check whether the OS is compatible with this version of `up` requirements(); // Comment in development and uncomment this line in production. This should check whether the OS is compatible with this version of `up`
program program

2
package-lock.json

@ -1,6 +1,6 @@
{ {
"name": "up-serve", "name": "up-serve",
"version": "0.1.3", "version": "0.1.5",
"lockfileVersion": 1, "lockfileVersion": 1,
"requires": true, "requires": true,
"dependencies": { "dependencies": {

2
utils/nginxPath.js

@ -2,7 +2,7 @@
var available = "/etc/nginx/sites-available/"; var available = "/etc/nginx/sites-available/";
var enabled = "/etc/nginx/sites-enabled/"; var enabled = "/etc/nginx/sites-enabled/";
var wwwRoot = "/var/www/"; var wwwRoot = "/etc/up-serve/static/";
function availableSites() { function availableSites() {
return available; return available;

Loading…
Cancel
Save