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

Aral Balkan's avatar
Aral Balkan committed
3
![Screenshot of Indie Web Server in use](images/indie-web-server-8.0.0.jpeg)
4

5
__Indie Web Server is a secure and seamless [Small Tech](https://ar.al/2019/03/04/small-technology/) personal web server for Linux and Linux-like* operating systems.__
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

Aral Balkan's avatar
Aral Balkan committed
11
12
  - 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/). 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
13
  <ins>Note:</ins> Live deployments via startup daemons are only supported on Linux distributions with systemd.
Aral Balkan's avatar
Aral Balkan committed
14

15
16
  \* Works with Linux, macOS, and Windows Subsystem for Linux.

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

Aral Balkan's avatar
Aral Balkan committed
19
20
Copy and paste the following commands into your terminal:

21
### Native binaries
Aral Balkan's avatar
Aral Balkan committed
22

23
__Before you pipe any script into your computer, always [view the source code](https://ind.ie/web-server/install.sh) and make sure you understand what it does.__
Aral Balkan's avatar
Aral Balkan committed
24

25
```shell
26
wget -qO- https://ind.ie/web-server/install.sh | bash
Aral Balkan's avatar
Aral Balkan committed
27
28
29
30
```

### Node.js

31
```shell
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
36
37
38
39
40
41
42
## Uninstall

To uninstall the native binary (and any created artifacts, like TLS certificates, systemd services, etc.):

```shell
web-server uninstall
```

43
## Use
44

45
### Local
46

47
Start serving the current directory at https://localhost as a regular process using locally-trusted certificates:
48
49

```shell
Aral Balkan's avatar
Aral Balkan committed
50
$ web-server
51
52
```

53
54
### Proxy server (local)

Aral Balkan's avatar
Aral Balkan committed
55
You can use Indie Web Server as a development-time reverse proxy for HTTP and WebSocket connections. For example, if you use [Hugo](https://gohugo.io/) and you’re running `hugo server` on the default HTTP port 1313. You can run a HTTPS reverse proxy at https://localhost [with LiveReload support](https://source.ind.ie/hypha/tools/web-server/blob/master/bin/web-server.js#L237) using:
56
57

```shell
58
$ web-server proxy localhost:1313
59
60
```

61
62
63
64
This will create and serve the following proxies:

  * http://localhost:1313 → https://localhost
  * ws://localhost:1313 → wss://localhost
65

Aral Balkan's avatar
Aral Balkan committed
66
67
68
69
70
### Live sync to remote server

Part of local development involves deploying your changes to a live server at some point. You can use Indie Web Server to handle this for you in real-time:

```shell
Aral Balkan's avatar
Aral Balkan committed
71
$ web-server sync my-demo my-demo.site
Aral Balkan's avatar
Aral Balkan committed
72
73
```

Aral Balkan's avatar
Aral Balkan committed
74
The above command will start a local development server at _https://localhost_. Additionally, it will watch the folder _my-demo_ for changes and sync any changes to its contents via rsync over ssh to _my-demo.site_. Without any customisations, the sync command assumes that your account on your remote server has the same name as your account on your local machine and that the folder you are watching (_my-demo_, in the example above) is located at _/home/your-account/my-demo_. Also, by default, the contents of the folder will be synced, not the folder itself. You can change these defaults using optional arguments.
Aral Balkan's avatar
Aral Balkan committed
75
76

```shell
Aral Balkan's avatar
Aral Balkan committed
77
$ web-server sync my-folder --host=my-demo.site --account=a-different-account --folder=not-my-folder
Aral Balkan's avatar
Aral Balkan committed
78
79
80
81
82
83
84
```

e.g., The above command will watch the the contents of the _my-folder_ directory and sync it to _a-different-account@my-demo.site:/home/a-different-account/not-my-folder_.

You can also customise the destination folder completely but supplying a custom remote connection string using the `--to` option:

```shell
Aral Balkan's avatar
Aral Balkan committed
85
$ web-server sync my-folder --to=some-account@my-demo.site:/var/www
Aral Balkan's avatar
Aral Balkan committed
86
87
88
89
```

Like the other commands, if you do not specify a folder, the current folder will be used by default.

Aral Balkan's avatar
Aral Balkan committed
90
If you want to sync not the folder’s contents but the folder itself, use the `--sync-folder-and-contents` flag. e.g.,
Aral Balkan's avatar
Aral Balkan committed
91

Aral Balkan's avatar
Aral Balkan committed
92
93
94
95
96
97
98
```shell
$ web-server sync my-local-folder/ my.site --account=me --folder=my-remote-folder
```

The above command will result in the following directory structure on the remote server: _/home/me/my-remote-folder/my-local-folder_

If you want to carry out a one-time sync and not continue to run the web server afterwards, use the `--exit-on-sync` flag. e.g.,
99
100
101
102
103

```shell
$ web-server sync my-folder my-demo.site --exit-on-sync
```

104
105
### Global (ephemeral)

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

```shell
109
$ web-server global site
110
111
```

112
Then use, for example, [ngrok](https://ngrok.com/) (Pro+) to point a custom domain name to your temporary staging server. Make sure you set your `hostname` file (e.g., in `/etc/hostname` or via `hostnamectl set-hostname <hostname>` or the equivalent for your platform) to match your domain name. 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.
113

Aral Balkan's avatar
Aral Balkan committed
114
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.
115
116
117

### Global (persistent)

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

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

```shell
123
$ web-server enable site
124
125
```

126
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.
127

128
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.
129

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

132
  - `disable`: Stop server and remove from startup.
133
  - `logs`: Display and tail server logs.
134
  - `status`: Display detailed server information (press ‘q’ to exit).
Aral Balkan's avatar
Aral Balkan committed
135

136
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
137

138
139
## Build and test from source

Aral Balkan's avatar
Aral Balkan committed
140
141
### Global Node.js module

142
143
144
145
```shell
# Clone and install.
git clone https://source.ind.ie/hypha/tools/web-server.git
cd web-server
146
147
npm i         # Install modules and development dependencies.
npm i -g .    # Install globally for access to the binary.
148
149
150
151
152
153
154
155

# Run unit tests.
npm test

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

156
157
158
159
160
161
162
163
__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
164
165
166
167
168
169
170
171
172
173
174
### 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

175
176
# Build the native binary for your platform.
# To build for all platforms, use npm run build -- --all
Aral Balkan's avatar
Aral Balkan committed
177
178
179
npm run build

# Serve the test site (visit https://localhost to view).
180
181
# e.g., To run the version 9.2.2 Linux binary:
dist/linux/9.2.2/web-server test/site
182
183
```

184
185
186
187
188
189
### Build and install native binary locally

```shell
npm run install-locally
```

190
191
192
193
194
195
196
### Deployment

```shell
# To build binaries for both linux and macOS and also to
# copy them over to the Indie Web Site for deployment.
# (You will most likely not need to do this.)
npm run deploy
Aral Balkan's avatar
Aral Balkan committed
197
198
```

199
## Syntax
200

Aral Balkan's avatar
Aral Balkan committed
201
```shell
Aral Balkan's avatar
Aral Balkan committed
202
web-server [command] [folder|host] [host] [--options]
Aral Balkan's avatar
Aral Balkan committed
203
```
204

Aral Balkan's avatar
Aral Balkan committed
205
206
207
  * `command`: version | help | local | global | proxy | sync | enable | disable | logs | status
  * `folder|host`: Path of folder to serve (defaults to current folder) or host to proxy or sync.
  * `host`: Host to sync.
208
  * `options`: Settings that alter server characteristics.
Aral Balkan's avatar
Aral Balkan committed
209

210
211
212
213
### Commands:

  * `version`: Display version and exit.
  * `help`: Display help screen and exit.
214
215
  * `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
216
217
  * `proxy`: Start server to proxy provided HTTP URL via HTTPS. Also proxies WebSockets.
  * `sync`: Start server as regular process with locally-trusted certificates and rsync folder to host.
Aral Balkan's avatar
Aral Balkan committed
218

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

221
222
  * `enable`: Start server as daemon with globally-trusted certificates and add to startup.
  * `disable`: Stop server daemon and remove from startup.
223
  * `logs`: Display and tail server logs.
224
  * `status`: Display detailed server information.
Aral Balkan's avatar
Aral Balkan committed
225

226
If `command` is omitted, behaviour defaults to `local`.
227
228

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

Aral Balkan's avatar
Aral Balkan committed
230
231
232
233
234
235
236
237
238
239
240
241
  * `--port=N`: Port to start server on (defaults to 443).

#### For the enable command:

  * `--sync`: Ensure the server can also rsync via ssh (so you can sync your site to it from your local machine).

### For the sync command:

  * `--host`: The remote host to sync to (e.g., my-demo.site).
  * `--account`: The ssh account to use on remote server (defaults to same as on current session).
  * `--folder`:	The subfolder of home folder to sync to on remote machine (defaults to name of served folder).
  * `--proxy`: Proxy the specified host and port instead of starting a regular local server.
Aral Balkan's avatar
Aral Balkan committed
242
243
  * `--exit-on-sync`: Exit once the first sync has occurred. Useful in deployment scripts.
  * `--sync-folder-and-contents`: Sync folder and contents (default is to sync the folder’s contents only).
Aral Balkan's avatar
Aral Balkan committed
244

245
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
246

247
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.
248

249
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).
250

Aral Balkan's avatar
Aral Balkan committed
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
## Usage examples

### Develop using locally-trusted certificates:

| Goal                                      | Command                                                       |
| ----------------------------------------- | ------------------------------------------------------------- |
| Serve current folder (shorthand)          | web-server                                                    |
| Serve folder site (shorthand)             | web-server site                                               |
| Serve current folder                      | web-server local                                              |
| Serve folder site                         | web-server local site                                         |
| Serve folder site at port 666             | web-server local site --port=666                              |
| Proxy localhost:1313 to https://localhost | web-server proxy localhost:1313                               |
| Serve current folder, sync it to my.site  | web-server sync my.site                                       |
| Serve site folder, sync it to my.site     | web-server sync site my.site                                  |
| Ditto, but using the --host option        | web-server sync site --host=my.site                           |
| Ditto, but use account me on my.site      | web-server sync site --host=my.site --account=me              |
| Ditto, but sync to remote folder www      | web-server sync site --host=my.site --account=me --folder=www |
| Ditto, but using the --to option          | web-server sync site --to=me@my-site:/home/me/www             |
| Sync current folder, proxy localhost:1313 | web-server sync my.site --proxy=localhost:1313                |

### Stage and deploy using globally-trusted Let’s Encrypt certificates:

| Goal                                      | Command                                                       |
| ----------------------------------------- | ------------------------------------------------------------- |
| Serve current folder                      | web-server global                                             |
| Serve folder site                         | web-server global site                                        |
| Serve current folder as daemon            | web-server enable                                             |
| Ditto & also ensure it can rsync via ssh  | web-server enable --sync                                      |
| Get status of deamon                      | web-server status                                             |
| Display server logs                       | web-server logs                                               |
| Stop current daemon                       | web-server disable                                            |

283
## Native support for an Evergreen Web
284

285
286
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, with Indie Web Server, it’s easy.

Aral Balkan's avatar
Aral Balkan committed
287
### Native cascading archives support
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306

If you have a static archive of the previous version of your site, you can have Indie Web Server automatically serve it for you. For example, if your site is being served from the `my-site` folder, just put the archive of your site into a folder named `my-site-archive-1`:

```
|- my-site
|- my-site-archive-1
```

If a path cannot be found in `my-site`, it will be served from `my-site-archive-1`.

And you’re not limited to a single archive (and hence the “cascade” bit in the name of the feature). As you have multiple older versions of your site, just add them to new folders and increment the archive index in the name. e.g., `my-site-archive-2`, `my-site-archive-3`, etc.

Paths in `my-site` will override those in `my-site-archive-3` and those in `my-site-archive-3` will, similarly, override those in `my-site-archive-2` and so on.

What this means that your old links will never die but if you do replace them with never content in never versions, those will take precedence.

### Native 404 → 302 support

But what if the previous version of your site is a dynamic site and you either don’t want to lose the dynamic functionality or you simply cannot take a static backup. No worries. Just move it to a different subdomain or domain and make your 404s into 302s.
307

Aral Balkan's avatar
Aral Balkan committed
308
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.
309
310
311

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

312
### /4042302
313
```
Aral Balkan's avatar
Aral Balkan committed
314
https://the-previous-version-of.my.site
315
```
316
317
318
319
320
321

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
322

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

325
326
327
328
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.

329
330
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.

331
332
## Dynamic routes

333
You can include very basic dynamic routes by including JavaScript files that export middleware-style functions in a special _.dynamic_ folder in the root folder of your web content. The syntax and conventions are [detailed here](https://source.ind.ie/hypha/tools/web-routes-from-files).
334

335
So, for example, if you wanted to have a dynamic route that showed the server CPU load and free memory, you could create a file called _.dynamic/server-stats.js_ in your web folder with the following content:
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355

```js
const os = require('os')

function serverStats (request, response, next) {

  const loadAverages = `<p> ${os.loadavg().reduce((a, c, i) => `${a}\n<li><strong>CPU ${i+1}:</strong> ${c}</li>`, '<ul>') + '</ul>'}</p>`

  const freeMemory = `<p>${os.freemem()} bytes</p>`

  const page = `<html><head><title>Server statistics</title><style>body {font-family: sans-serif;}</style></head><body><h1>Server statistics</h1><h2>Load averages</h2>${loadAverages}<h2>Free memory</h2>${freeMemory}</body></html>`

  response.end(page)
}

module.exports = serverStats
```

Indie Web Server will load your dynamic route at startup and you can test it by hitting _https://localhost/server-stats_ using a local web server. Each time you refresh, you should get the latest dynamic content.

356
357
If you need to use custom Node modules, initialise your _.dynamic_ folder using `npm init` and use `npm install` as usual. And modules you require from your routes will be properly loaded and used.

358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
### Directories

Your dynamic web routes are running within Indie Web Server, which is a Node application compiled into a native binary.

  - `os.homedir()`: __(writable)__ This is the home folder of the account running Indie Web Server. You can write to it to store persistent objects (e.g., save data).

  - `os.tmpdir()`: __(writable)__ Path to the system temporary folder. Use for content you can afford to lose and can recreate (e.g., cache API calls).

  - `.`: __(writable)__ Path to the root of your web content. Since you can write here, you can, if you want to, create content dynamically that will then automatically be served by the static web server.

  - `__dirname`: __(writeable) Path to the `.routes` folder.

  - `/`: __(read-only)__ Path to the `/usr` folder (Indie Web Server is installed in `/usr/local/web-server`). You should not have any reason to use this.

### Security

The code within your JavaScript routes is executed on the server. Exercise the same caution as you would when creating any Node.js app (sanitise input, etc.)

### Intended usage

378
You shouldn’t use this functionality to create your latest amazing web app. For that, include Indie Web Server as a node module in your project and extend it that way. This is to add tiny bits of dynamic functionality. There is currently only support for `get` routes. Again, if you need custom modules, extend Indie Web Server using Node.js.
379

380
## API
381

382
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`.
383

384

385
### createServer([options], [requestListener])
386

387
  - __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.
388

389
  - __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.
390

391
    __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.
392

393
#### Example
394
395

```js
Aral Balkan's avatar
Aral Balkan committed
396
const webServer = require('@ind.ie/web-server')
397
398
399
400
401
const express = require('express')

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

402
const options = {} // to use globally-trusted certificates instead, set this to {global: true}
Aral Balkan's avatar
Aral Balkan committed
403
const server = webServer.createServer(options, app).listen(443, () => {
404
405
406
407
  console.log(` 🎉 Serving on https://localhost\n`)
})
```

408
### serve([options])
409
410

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

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

414
  - __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.
415

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

418
  - __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.
419
420

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


423
#### Examples
424

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

427
```js
Aral Balkan's avatar
Aral Balkan committed
428
429
const webServer = require('@ind.ie/web-server')
const server = webServer.serve()
430
431
```

Aral Balkan's avatar
Aral Balkan committed
432
Serve the current directory at your hostname using globally-trusted Let’s Encrypt TLS certificates:
433
434

```js
Aral Balkan's avatar
Aral Balkan committed
435
436
const webServer = require('@ind.ie/web-server')
const server = webServer.serve({global: true})
437
438
```

439
440
## Contributing

Aral Balkan's avatar
Aral Balkan committed
441
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_).
442
443
444

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

445
446
## Help wanted

Aral Balkan's avatar
Aral Balkan committed
447
448
449
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:
450

451
452
  - Linux with yum
  - macOS with MacPorts
453

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

## 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).
459

460
  * [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.” __Note: Indie Web Server is not supported on Windows. Please use Windows Subsystem for Linux.__
461

462
  * [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.” __Note: Indie Web Server is not supported on Windows. Please use Windows Subsystem for Linux.__