README.md 13.5 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
  - Zero-configuration – It Just Works 🤞™.

Aral Balkan's avatar
Aral Balkan committed
9
  - Develop with automatically-provisioned locally-trusted TLS courtesy of [mkcert](https://github.com/FiloSottile/mkcert) seamlessly integrated via [Nodecert](https://source.ind.ie/hypha/tools/nodecert).
Aral Balkan's avatar
Aral Balkan committed
10

11
  - Test and deploy with automatically-provisioned globally-trusted TLS courtesy of [Let’s Encrypt](https://letsencrypt.org/) seamlessly integrated via [ACME TLS](https://source.ind.ie/hypha/tools/acme-tls) and [systemd](https://freedesktop.org/wiki/Software/systemd/). Live deployments via startup daemons are only supported on Linux distributions with systemd. Your server will score an A on the [SSL Labs SSL Server Test](https://www.ssllabs.com/ssltest).
Aral Balkan's avatar
Aral Balkan committed
12

13
## Install
Aral Balkan's avatar
Aral Balkan committed
14

Aral Balkan's avatar
Aral Balkan committed
15
16
17
18
19
Copy and paste the following commands into your terminal:

### Linux

```
20
wget https://ind.ie/web-server/linux/8.0.0.zip && unzip 8.0.0.zip && chmod +x web-server && sudo mv web-server /usr/local/bin/
Aral Balkan's avatar
Aral Balkan committed
21
22
23
24
25
```

### macOS

```
26
wget https://ind.ie/web-server/macos/8.0.0.zip && unzip 8.0.0.zip && chmod +x web-server && sudo mv web-server /usr/local/bin/
Aral Balkan's avatar
Aral Balkan committed
27
28
29
30
```

### Node.js

Aral Balkan's avatar
Aral Balkan committed
31
```sh
Aral Balkan's avatar
Aral Balkan committed
32
npm i -g @ind.ie/web-server
Aral Balkan's avatar
Aral Balkan committed
33
34
```

35
## Use
36

37
### Local
38

39
Start serving the current directory at https://localhost as a regular process using locally-trusted certificates:
40
41

```shell
Aral Balkan's avatar
Aral Balkan committed
42
$ web-server
43
44
```

45
46
47
### Global (ephemeral)

__Available on Linux and macOS only*__
48

Aral Balkan's avatar
Aral Balkan committed
49
Start serving the _site_ directory at your _hostname_ as a regular process using globally-trusted Let’s Encrypt certificates:
50
51

```shell
52
$ web-server global site
53
54
```

Aral Balkan's avatar
Aral Balkan committed
55
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 server via your hostname it will take a little longer to load as your Let’s Encrypt certificates are being automatically provisioned by ACME TLS.
56

Aral Balkan's avatar
Aral Balkan committed
57
When you start your server using the `global` command, it will run as a regular process. It will not be restarted if it crashes or if you exit the foreground process or restart the computer.
58
59

\* Automatic hostname detection has not been implemented for Windows and so globally-trusted certificates will fail on that platform.
60

61
62
### Global (persistent)

63
__Available on Linux distributions with systemd (most Linux distributions, but [not these ones](https://sysdfree.wordpress.com/2019/03/09/135/) or on macOS/Windows).__
64

Aral Balkan's avatar
Aral Balkan committed
65
Start serving the _site_ directory at your _hostname_ as a daemon that is automatically run at system startup and restarted if it crashes:
66
67

```shell
68
$ sudo web-server enable site
69
70
```

71
The `enable` command sets up your server to start automatically when your server starts and restart automatically if it crashes. Requires superuser privileges on first run to set up the launch item.
72

73
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_, 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.
74

75
When the server is enabled, you can also use:
Aral Balkan's avatar
Aral Balkan committed
76

77
  - `disable`: Stop server and remove from startup.
78
  - `logs`: Display and tail server logs.
79
  - `status`: Display detailed server information (press ‘q’ to exit).
Aral Balkan's avatar
Aral Balkan committed
80

81
Indie Web Server uses the [systemd](https://freedesktop.org/wiki/Software/systemd/) to start and manage the daemon. Beyond the commands listed above that Indie Web Server supports natively (and proxies to systemd), you can make use of all systemd functionality via the `systemctl` and `journalctl` commands.
Aral Balkan's avatar
Aral Balkan committed
82

83
84
## Build and test from source

Aral Balkan's avatar
Aral Balkan committed
85
86
### Global Node.js module

87
88
89
90
```shell
# Clone and install.
git clone https://source.ind.ie/hypha/tools/web-server.git
cd web-server
91
92
npm i         # Install modules and development dependencies.
npm i -g .    # Install globally for access to the binary.
93
94
95
96
97
98
99
100

# Run unit tests.
npm test

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

101
102
103
104
105
106
107
108
__Note:__ for commands that require root privileges (i.e., `enable` and `disable`), Indie Web Server will automatically restart itself using sudo and Node must be available for the root account. If you’re using [nvm](https://github.com/creationix/nvm), you can enable this via:

```shell
# Replace v10.15.3 with the version of node you want to make available globally.
sudo ln -s "$NVM_DIR/versions/node/v10.15.3/bin/node" "/usr/local/bin/node"
sudo ln -s "$NVM_DIR/versions/node/v10.15.3/bin/npm" "/usr/local/bin/npm"
```

Aral Balkan's avatar
Aral Balkan committed
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
### Native binaries

```shell
# Clone and install.
git clone https://source.ind.ie/hypha/tools/web-server.git
cd web-server
npm i         # Install modules and development dependencies.

# Run unit tests.
npm test

# Build the native binaries
npm run build

# Serve the test site (visit https://localhost to view).
124
125
# e.g., To run the version 8.0.0 Linux binary:
dist/linux/8.0.0/web-server test/site
Aral Balkan's avatar
Aral Balkan committed
126
127
```

128
## Syntax
129

Aral Balkan's avatar
Aral Balkan committed
130
```shell
131
web-server [command] [folder] [options]
Aral Balkan's avatar
Aral Balkan committed
132
```
133

134
  * `command`: version | help | dev | test | enable | disable | logs | status
135
136
  * `folder`: Path of folder to serve (defaults to current folder).
  * `options`: Settings that alter server characteristics.
Aral Balkan's avatar
Aral Balkan committed
137

138
139
140
141
### Commands:

  * `version`: Display version and exit.
  * `help`: Display help screen and exit.
142
143
  * `local`: Start server as regular process with locally-trusted certificates.
  * `global`: Start server as regular process with globally-trusted certificates.
Aral Balkan's avatar
Aral Balkan committed
144

145
On Linux distributions with systemd, you can also use:
Aral Balkan's avatar
Aral Balkan committed
146

147
148
  * `enable`: Start server as daemon with globally-trusted certificates and add to startup.
  * `disable`: Stop server daemon and remove from startup.
149
  * `logs`: Display and tail server logs.
150
  * `status`: Display detailed server information.
Aral Balkan's avatar
Aral Balkan committed
151

152
If `command` is omitted, behaviour defaults to `local`.
153
154

### Options:
Aral Balkan's avatar
Aral Balkan committed
155

156
  * `--port=N`: Port to start the server on (defaults to 443).
Aral Balkan's avatar
Aral Balkan committed
157

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

160
If you want to serve a directory that has the same name as a command, you can specify the command in _options_ format. e.g., `web-server --enable logs` will start Indie Web Server as a startup daemon to serve the _logs_ folder.
161

162
When you use the `global` or `enable` commands, 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).
163

164
165
166
167
## 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
168
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.
169
170
171

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.,

172
### /4042302
173
```
Aral Balkan's avatar
Aral Balkan committed
174
https://the-previous-version-of.my.site
175
```
176
177
178
179
180
181

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
182

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

185
186
187
188
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.

189
190
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.

191
## API
192

193
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`.
194

195

196
### createServer([options], [requestListener])
197

198
  - __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.
199

200
  - __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.
201

202
    __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.
203

204
#### Example
205
206

```js
Aral Balkan's avatar
Aral Balkan committed
207
const webServer = require('@ind.ie/web-server')
208
209
210
211
212
const express = require('express')

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

213
const options = {} // to use globally-trusted certificates instead, set this to {global: true}
Aral Balkan's avatar
Aral Balkan committed
214
const server = webServer.createServer(options, app).listen(443, () => {
215
216
217
218
  console.log(` 🎉 Serving on https://localhost\n`)
})
```

219
### serve([options])
220
221

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

223
  - __path__ _(string)_: the directory to serve using [Express](http://expressjs.com/).static.
224

225
  - __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.
226

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

229
  - __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.
230
231

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


234
#### Examples
235

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

238
```js
Aral Balkan's avatar
Aral Balkan committed
239
240
const webServer = require('@ind.ie/web-server')
const server = webServer.serve()
241
242
```

Aral Balkan's avatar
Aral Balkan committed
243
Serve the current directory at your hostname using globally-trusted Let’s Encrypt TLS certificates:
244
245

```js
Aral Balkan's avatar
Aral Balkan committed
246
247
const webServer = require('@ind.ie/web-server')
const server = webServer.serve({global: true})
248
249
```

250
251
## Contributing

Aral Balkan's avatar
Aral Balkan committed
252
Indie Web Server is, by design, a zero-configuration personal web server for single-tenant web applications for and by individuals. As such, any 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_).
253
254
255

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

256
257
## Help wanted

Aral Balkan's avatar
Aral Balkan committed
258
259
260
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:
261

262
263
  - Linux with yum
  - macOS with MacPorts
264

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

## 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).
270
271
272
273

  * [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.”