Custom Headers

.github/ISSUE_TEMPLATE

@@ -0,0 +1,16 @@
+**Steps to reproduce the issue, if applicable. Include the actual command and output and/or stack trace.**
+
+<!-- Paste the command here: -->
+
+**What did you expect to happen?**
+
+<!-- Paste the error and / or stack trace here: -->
+
+**If the issue is a feature request, what is the motivation / use case for it?**
+
+**Tell us about your environment**
+- **exact http-server version:**
+- **Node version:**
+- **Platform:**
+
+**Other information (related issues, suggestions for a fix, etc):**

.github/PULL_REQUEST_TEMPLATE

@@ -0,0 +1,19 @@
+**Please ensure that your pull request fulfills these requirements:**
+- [ ] The pull request is being made against the `master` branch
+- [ ] Tests for the changes have been added (for bug fixes / features)
+
+**What is the purpose of this pull request? (bug fix, enhancement, new feature,...)**
+
+<!--
+    Link to the issue this pull request fixes here, if applicable: "Fixes #xxx" or "Resolves #xxx"
+-->
+
+**What changes did you make?**
+
+**Provide some example code that this change will affect, if applicable:**
+
+<!-- Paste the example code here: -->
+
+**Is there anything you'd like reviewers to focus on?**
+
+**Please provide testing instructions, if applicable:**

.gitignore

@@ -1,3 +1,4 @@
-node_modules/*
-!node_modules/node-static
-npm-debug.log 
+node_modules/
+npm-debug.log*
+.dir-locals.el
+.DS_Store

.travis.yml

@@ -0,0 +1,23 @@
+sudo: false
+language: node_js
+node_js:
+  - "6"
+  - "8"
+  - "10"
+  - "12"
+  - "13"
+  - "14"
+
+git:
+  autocrlf: input
+
+os:
+  - linux
+  - windows
+  - osx
+
+before_install:
+  - travis_retry npm install
+
+script:
+  - npm test

LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Nodejitsu https://github.com/nodejitsu/http-server/
+Copyright (c) 2011-2020 Charlie Robbins, Marak Squires, and the Contributors.
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
@@ -17,4 +17,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,63 +1,149 @@
+[![build status](https://img.shields.io/travis/http-party/http-server.svg?style=flat-square)](https://travis-ci.org/http-party/http-server)
+[![npm](https://img.shields.io/npm/v/http-server.svg?style=flat-square)](https://www.npmjs.com/package/http-server) [![homebrew](https://img.shields.io/homebrew/v/http-server?style=flat-square)](https://formulae.brew.sh/formula/http-server) [![npm downloads](https://img.shields.io/npm/dm/http-server?color=blue&label=npm%20downloads&style=flat-square)](https://www.npmjs.com/package/http-server)
+[![license](https://img.shields.io/github/license/http-party/http-server.svg?style=flat-square)](https://github.com/http-party/http-server)
+
 # http-server: a command-line http server
 
 `http-server` is a simple, zero-configuration command-line http server.  It is powerful enough for production usage, but it's simple and hackable enough to be used for testing, local development, and learning.
 
-![](https://github.com/nodeapps/http-server/raw/master/screenshots/public.png)
+![Example of running http-server](https://github.com/http-party/http-server/raw/master/screenshots/public.png)
 
-# Installing globally:
+## Installation:
 
-Installation via `npm`.  If you don't have `npm` yet:
+#### Globally via `npm`
 
-     curl https://npmjs.org/install.sh | sh
-
-Once you have `npm`:
+    npm install --global http-server
+
+This will install `http-server` globally so that it may be run from the command line anywhere.
+
+#### Globally via Homebrew
+
+    brew install http-server
 
-     npm install http-server -g
+#### Running on-demand:
+
+Using `npx` you can run the script without installing it first:
+
+    npx http-server [path] [options]
 
-This will install `http-server` globally so that it may be run from the command line.
+#### As a dependency in your `npm` package:
+
+    npm install http-server
 
 ## Usage:
 
      http-server [path] [options]
 
 `[path]` defaults to `./public` if the folder exists, and `./` otherwise.
 
-# Installing as a node app
+*Now you can visit http://localhost:8080 to view your server*
+
+**Note:** Caching is on by default. Add `-c-1` as an option to disable caching.
 
-     mkdir myapp
-     cd myapp/
-     jitsu install http-server
+## Available Options:
 
-*If you do not have `jitsu` installed you can install it via `npm install jitsu -g`*
+`-p` or `--port` Port to use (defaults to 8080). It will also read from `process.env.PORT`.
 
-## Usage
+`-a` Address to use (defaults to 0.0.0.0)
 
-### Starting http-server locally
+`-d` Show directory listings (defaults to `true`)
 
-     node bin/http-server
+`-i` Display autoIndex (defaults to `true`)
 
-*Now you can visit http://localhost:8080 to view your server*
+`-g` or `--gzip` When enabled (defaults to `false`) it will serve `./public/some-file.js.gz` in place of `./public/some-file.js` when a gzipped version of the file exists and the request accepts gzip encoding. If brotli is also enabled, it will try to serve brotli first.
 
-### Deploy http-server to nodejitsu
+`-b` or `--brotli` When enabled (defaults to `false`) it will serve `./public/some-file.js.br` in place of `./public/some-file.js` when a brotli compressed version of the file exists and the request accepts `br` encoding. If gzip is also enabled, it will try to serve brotli first.
 
-     jitsu deploy
+`-e` or `--ext` Default file extension if none supplied (defaults to `html`)
 
-*You will now be prompted for a `subdomain` to deploy your application on*
+`-s` or `--silent` Suppress log messages from output
 
-## Available Options:
+`--cors` Enable CORS via the `Access-Control-Allow-Origin` header
+
+`-o [path]` Open browser window after starting the server. Optionally provide a URL path to open. e.g.: -o /other/dir/
+
+`-c` Set cache time (in seconds) for cache-control max-age header, e.g. `-c10` for 10 seconds (defaults to `3600`). To disable caching, use `-c-1`.
+
+`-U` or `--utc` Use UTC time format in log messages.
+
+`--log-ip` Enable logging of the client's IP address (default: `false`).
+
+`-P` or `--proxy` Proxies all requests which can't be resolved locally to the given url. e.g.: -P http://someurl.com
+
+`--username` Username for basic authentication [none]
+
+`--password` Password for basic authentication [none]
 
-`-p` Port to listen for connections on (defaults to 8080)
+`-S` or `--ssl` Enable https.
 
-`-a` Address to bind to (defaults to '0.0.0.0')
+`-C` or `--cert` Path to ssl cert file (default: `cert.pem`).
 
-`-d` Show directory listings (defaults to 'True')
+`-K` or `--key` Path to ssl key file (default: `key.pem`).
 
-`-i` Display autoIndex (defaults to 'True')
+`-r` or `--robots` Provide a /robots.txt (whose content defaults to `User-agent: *\nDisallow: /`)
 
-`-e` or `--ext` Default file extension (defaults to 'html')
+`--no-dotfiles` Do not show dotfiles
+
+`-H` or `--header` Send the specified header with responses, e.g. `-H "Strict-Transport-Security: max-age=315360000; includeSubdomains"`.
 
-`-s` or `--silent` In silent mode, log messages aren't logged to the console.
+`-h` or `--help` Print this list and exit.
 
-`-h` or `--help` Displays a list of commands and exits.
+`-v` or `--version` Print the version and exit.
+
+## Magic Files
+
+- `index.html` will be served as the default file to any directory requests.
+- `404.html` will be served if a file is not found. This can be used for Single-Page App (SPA) hosting to serve the entry page.
+
+## Catch-all redirect
+
+To implement a catch-all redirect, use the index page itself as the proxy with:
+
+```
+http-server --proxy http://localhost:8080?
+```
+
+Note the `?` at the end of the proxy URL. Thanks to [@houston3](https://github.com/houston3) for this clever hack!
+
+## TLS/SSL
+
+First, you need to make sure that [openssl](https://github.com/openssl/openssl) is installed correctly, and you have `key.pem` and `cert.pem` files. You can generate them using this command:
+
+``` sh
+openssl req -newkey rsa:2048 -new -nodes -x509 -days 3650 -keyout key.pem -out cert.pem
+```
+
+You will be prompted with a few questions after entering the command. Use `127.0.0.1` as value for `Common name` if you want to be able to install the certificate in your OS's root certificate store or browser so that it is trusted.
+
+This generates a cert-key pair and it will be valid for 3650 days (about 10 years).
+
+Then you need to run the server with `-S` for enabling SSL and `-C` for your certificate file.
+
+``` sh
+http-server -S -C cert.pem
+```
+
+This is what should be output if successful:
+
+``` sh
+Starting up http-server, serving ./ through https
+Available on:
+  https:127.0.0.1:8080
+  https:192.168.1.101:8080
+  https:192.168.1.104:8080
+Hit CTRL-C to stop the server
+```
+
+# Development
+
+Checkout this repository locally, then:
+
+```sh
+$ npm i
+$ node bin/http-server
+```
+
+*Now you can visit http://localhost:8080 to view your server*
 
-`-c` Set cache time (in seconds) for cache-control max-age header, e.g. -c10 for 10 seconds. To disable caching, use -c-1.
+You should see the turtle image in the screenshot above hosted at that URL. See
+the `./public` folder for demo content.