README.md 10.6 KB
Newer Older
Aral Balkan's avatar
Aral Balkan committed
1
# Indie Web Server
Aral Balkan's avatar
Aral Balkan committed
2

3 4
![Screenshot of Indie Web Server in use](images/indie-web-server.jpeg)

Aral Balkan's avatar
Aral Balkan committed
5
Indie Web Server is a secure and seamless [Small Tech](https://ar.al/2019/03/04/small-technology/) personal web server.
Aral Balkan's avatar
Aral Balkan committed
6

Aral Balkan's avatar
Aral Balkan committed
7 8 9 10 11
  - Zero-configuration – It Just Works 🤞™.

  - Develop and test with automatically-provisioned locally-trusted TLS thanks to [mkcert](https://github.com/FiloSottile/mkcert) via [Nodecert](https://source.ind.ie/hypha/tools/nodecert).

  - Stage and deploy with automatically-provisioned globally-trusted TLS thanks to [Let’s Encrypt](https://letsencrypt.org/) via [ACME TLS](https://source.ind.ie/hypha/tools/acme-tls) (with an A score on [SSL Labs SSL Server Test](https://www.ssllabs.com/ssltest)).
Aral Balkan's avatar
Aral Balkan committed
12

13
[Watch a short 4-minute video](https://ar.al/2019/03/14/introducing-indie-web-server-video/) demonstrating how easy Indie Web Server is to install and use.
14 15

## Install
Aral Balkan's avatar
Aral Balkan committed
16 17

```sh
Aral Balkan's avatar
Aral Balkan committed
18
npm i -g @ind.ie/web-server
Aral Balkan's avatar
Aral Balkan committed
19 20
```

21
## Use
22

23
### Command-line
Aral Balkan's avatar
Aral Balkan committed
24

25 26 27
#### Development

Start serving the current directory at https://localhost using locally-trusted certificates:
28 29

```shell
Aral Balkan's avatar
Aral Balkan committed
30
$ web-server
31 32
```

33 34 35
#### Staging

Start serving the _site_ directory at your _hostname_ using globally-trusted Let’s Encrypt certificates:
36 37

```shell
38
$ web-server --staging site
39 40
```

41 42 43 44 45 46 47 48 49 50
For example, use [ngrok](https://ngrok.com/) (Pro+) with a custom domain name that you set in your `hostname` file (e.g., in `/etc/hostname` or via `hostnamectl set-hostname <hostname>` or the equivalent for your platform). The first time you hit your staging server via your hosname it will take a little longer to load as your Let’s Encrypt certificates are being automatically provisioned by ACME TLS.

#### Live

Start serving the _site_ directory at your _hostname_ as a daemon that will run at startup and be restarted if it crashes, etc.:

```shell
$ web-server --live site
```

Aral Balkan's avatar
Aral Balkan committed
51
The `--live` option sets up your server to (re)start automatically when you server (re)starts (requires `sudo`) and/or crashes, etc.
52

Aral Balkan's avatar
Aral Balkan committed
53
For example, if you run the command on a connected server that has the ar.al domain pointing to it and `ar.al` set in _/etc/hostname_ (on Unix/Linux/macOS), you will be able to access the site at https://ar.al. The first time you hit it, it will take a little longer to load as your Let’s Encrypt certificates are being automatically provisioned by ACME TLS.
54

Aral Balkan's avatar
Aral Balkan committed
55 56 57 58 59 60 61
Once you have started your live web server daemon, you can use these commands to monitor it, etc.:

  * `--monitor`: monitor an already-running live server daemon process.
  * `--logs`: display and tail the web server logs.

The live server uses the [pm2](https://pm2.io/runtime/) process manager internally and you can make use of all pm2 functionality via the pm2 command if you need to.

62 63 64 65 66 67
## Build and test from source

```shell
# Clone and install.
git clone https://source.ind.ie/hypha/tools/web-server.git
cd web-server
68 69
npm i         # Install modules and development dependencies.
npm i -g .    # Install globally for access to the binary.
70 71 72 73 74 75 76 77

# Run unit tests.
npm test

# Serve the test site (visit https://localhost to view).
web-server test/site
```

78
## Syntax
79

Aral Balkan's avatar
Aral Balkan committed
80
```sh
Aral Balkan's avatar
Aral Balkan committed
81
web-server [folder-to-serve] [--port N] [--global] [--version]
Aral Balkan's avatar
Aral Balkan committed
82
```
83

Aral Balkan's avatar
Aral Balkan committed
84
All command-line arguments are optional. By default, Indie Web Server will serve your current working folder over port 433 with locally-trusted certificates.
85

Aral Balkan's avatar
Aral Balkan committed
86
If you specify the `--global` flag, globally-trusted Let’s Encrypt TLS certificates are automatically provisioned for you using ACME TLS the first time you hit your hostname. The hostname for the certificates is automatically set from the hostname of your system (and the _www._ subdomain is also automatically provisioned).
87

88 89 90 91
## Native 404 → 302 support for an evergreen web

What if links never died? What if we never broke the Web? What if it didn’t involve any extra work? It’s possible. And easy. Just make your 404s into 302s.

Aral Balkan's avatar
Aral Balkan committed
92
Indie Web Server has native support for [the 404 to 302 technique](https://4042302.org) to ensure an evergreen web. Just serve the old version of your site (e.g., your WordPress site, etc.) from a different subdomain and tell Indie Web Server to forward any unknown requests on your new static site to that subdomain so that all your existing links magically work.
93 94 95

To do so, create a simple file called `4042302` in the root directory of your web content and add the URL of the server that is hosting your older content. e.g.,

96
### /4042302
97
```
Aral Balkan's avatar
Aral Balkan committed
98
https://the-previous-version-of.my.site
99
```
100 101 102 103 104 105

You can chain the 404 → 302 method any number of times to ensure that none of your links ever break without expending any additional effort to migrate your content.

For more information and examples, see [4042302.org](https://4042302.org).

## Custom error pages
106

107 108
![Screenshot of the custom 404 error page included in the unit tests](images/custom-404.png)

109 110 111 112
You can specify a custom error page for 404 (not found) and 500 (internal server error) errors. To do so, create a folder with the status code you want off of the root of your web content (i.e., `/404` and/or `/500`) and place at least an `index.html` file in the folder. You can also, optionally, put any assets you want to display on your error pages into those folders and load them in via relative URLs. Your custom error pages will be served with the proper error code and at the URL that was being accessed.

If you do not create custom error pages, the built-in default error pages will be displayed for 404 and 500 errors.

113 114
When creating your own servers (see [API](#API)), you can generate the default error pages programmatically using the static methods `WebServer.default404ErrorPage()` and `WebServer.default500ErrorPage()`, passing in the missing path and the error message as the argument, respectively to get the HTML string of the error page returned.

115
## API
116

117
Indie Web Server’s `createServer` method behaves like the built-in _https_ module’s `createServer` function. Anywhere you use `require('https').createServer`, you can simply replace it with `require('@ind.ie/web-server').createServer`.
118

119

120
### createServer([options], [requestListener])
121

122
  - __options__ _(object)___:__ see [https.createServer](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener). Populates the `cert` and `key` properties from the automatically-created [nodecert](https://source.ind.ie/hypha/tools/nodecert/) or Let’s Encrypt certificates and will overwrite them if they exist in the options object you pass in. If your options has `options.global = true` set, globally-trusted TLS certificates are obtained from Let’s Encrypt using ACME TLS.
123

Aral Balkan's avatar
Aral Balkan committed
124
  - __requestListener__ _(function)___:__ see [https.createServer](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener). If you don’t pass a request listener, Indie Web Server will use its default one.
125

126
    __Returns:__ [https.Server](https://nodejs.org/api/https.html#https_class_https_server) instance, configured with either locally-trusted certificates via nodecert or globally-trusted ones from Let’s Encrypt.
127

128
#### Example
129 130

```js
Aral Balkan's avatar
Aral Balkan committed
131
const webServer = require('@ind.ie/web-server')
132 133 134 135 136
const express = require('express')

const app = express()
app.use(express.static('.'))

137
const options = {} // to use globally-trusted certificates instead, set this to {global: true}
Aral Balkan's avatar
Aral Balkan committed
138
const server = webServer.createServer(options, app).listen(443, () => {
139 140 141 142
  console.log(` 🎉 Serving on https://localhost\n`)
})
```

143
### serve([options])
144 145

Options is an optional parameter object that may contain the following properties, all optional:
146

147
  - __path__ _(string)___:__ the directory to serve using [Express](http://expressjs.com/).static.
148

149 150 151 152
  - __callback__ _(function)___:__ a function to be called when the server is ready. If you do not specify a callback, you can specify the port as the second argument.

  - __port__ _(number)___:__ the port to serve on. Defaults to 443. (On Linux, privileges to bind to the port are automatically obtained for you.)

153
  - __global__ _(boolean)___:__ if true, globally-trusted Let’s Encrypt certificates will be provisioned (if necesary) and used via ACME TLS. If false (default), locally-trusted certificates will be provisioned (if necesary) and used using nodecert.
154 155

    __Returns:__ [https.Server](https://nodejs.org/api/https.html#https_class_https_server) instance, configured with either locally or globally-trusted certificates.
156 157


158
#### Examples
159

Aral Balkan's avatar
Aral Balkan committed
160
Serve the current directory at https://localhost using locally-trusted TLS certificates:
161

162
```js
Aral Balkan's avatar
Aral Balkan committed
163 164
const webServer = require('@ind.ie/web-server')
const server = webServer.serve()
165 166
```

Aral Balkan's avatar
Aral Balkan committed
167
Serve the current directory at your hostname using globally-trusted Let’s Encrypt TLS certificates:
168 169

```js
Aral Balkan's avatar
Aral Balkan committed
170 171
const webServer = require('@ind.ie/web-server')
const server = webServer.serve({global: true})
172 173
```

174 175 176 177 178 179
## Contributing

Indie Web Server is, by design, a zero-configuration personal web server for single-tenant web applications for and by individuals. As such, as new feature requests will have to be both fit for purpose and survive a trial by fire to be considered. (That is, this is [Small Tech](https://ar.al/2019/03/04/small-technology/), with the emphasis on _small_).

Please file issues and submit pull requests on the [Indie Web Server Github Mirror](https://github.com/indie-mirror/indie-web-server).

180 181
## Help wanted

Aral Balkan's avatar
Aral Balkan committed
182 183 184
For locally-trusted certificates, all dependencies are installed automatically for you if they do not exist if you have apt, pacman, or yum (untested) on Linux or if you have [Homebrew](https://brew.sh/) or [MacPorts](https://www.macports.org/) (untested) on macOS.

I can use your help to test Indie Web Server on the following platform/package manager combinations:
185

186 187
  - Linux with yum
  - macOS with MacPorts
188

Aral Balkan's avatar
Aral Balkan committed
189
Please [let me know how/if it works](https://github.com/indie-mirror/web-server/issues). Thank you!
190

Aral Balkan's avatar
Aral Balkan committed
191
Also, automatic hostname detection has not been implemented for Windows and so globally-trusted certificates will fail on that platform. If you get to it before I do, [I would appreciate a pull request](https://github.com/indie-mirror/web-server/pulls).
192

193

194 195 196
## Thanks

  * [thagoat](https://github.com/thagoat) for confirming that [installation works on Arch Linux with Pacman](https://github.com/indie-mirror/https-server/issues/1).
197 198 199 200

  * [Tim Knip](https://github.com/timknip) for confirming that [the module works with 64-bit Windows](https://github.com/indie-mirror/https-server/issues/2) with the following behaviour: “Install pops up a windows dialog to allow adding the cert.”

  * [Run Rabbit Run](https://hackers.town/@nobody) for [the following information](https://hackers.town/@nobody/101670447262172957) on 64-bit Windows: “Win64: works with the windows cert install popup on server launch. Chrome and ie are ok with the site then. FF 65 still throws the cert warning even after restarting.”