README.md 30 KB
Newer Older
Aral Balkan's avatar
Aral Balkan committed
1
# Site.js
Aral Balkan's avatar
Aral Balkan committed
2

Aral Balkan's avatar
Aral Balkan committed
3
[![Screenshot of the Site.js web site header](images/site.js.jpeg)](https://sitejs.org)
4

Aral Balkan's avatar
Aral Balkan committed
5
6
7
## Develop, test, and deploy your secure static or dynamic personal web site with zero configuration.

__Site.js is an integrated [Small Tech](https://ar.al/2019/03/04/small-technology/) personal web tool for Linux and Linux-like* operating systems.__
Aral Balkan's avatar
Aral Balkan committed
8

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

Aral Balkan's avatar
Aral Balkan committed
11
  - 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
12

Aral Balkan's avatar
Aral Balkan committed
13
14
15
  - Stage and deploy production servers 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).

  - Create static web sites, extend them with dynamic JavaScript routes, or extend Site.js in Node.js to create fully-dynamic personal web applications.
Aral Balkan's avatar
Aral Balkan committed
16

Aral Balkan's avatar
Aral Balkan committed
17
  <ins>Note:</ins> Live deployments via startup daemons are only supported on Linux distributions with systemd.
Aral Balkan's avatar
Aral Balkan committed
18

19
20
  \* Works with Linux, macOS, and Windows Subsystem for Linux.

21
## Install
Aral Balkan's avatar
Aral Balkan committed
22

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

25
### Native binaries
Aral Balkan's avatar
Aral Balkan committed
26

Aral Balkan's avatar
Aral Balkan committed
27
__Before you pipe any script into your computer, always [view the source code](https://site.js/install) and make sure you understand what it does.__
Aral Balkan's avatar
Aral Balkan committed
28

29
```shell
Aral Balkan's avatar
Aral Balkan committed
30
wget -qO- https://sitejs.org/install | bash
Aral Balkan's avatar
Aral Balkan committed
31
32
33
34
```

### Node.js

35
```shell
Aral Balkan's avatar
Aral Balkan committed
36
npm i -g @small-tech/site.js
Aral Balkan's avatar
Aral Balkan committed
37
38
```

39
40
41
42
43
44
45
46
47
48
49
## Dependencies

Site.js is tries to install the dependencies it needs seamlessly while running. That said, there are certain basic components it expects on a Linux-like system. These are:

  - `sudo`
  - `libcap2-bin` (we use `setcap` to escalate privileges on the binary as necessary)

If it turns out that any of these are a widespread reason for first-run breakage, we can look into having them installed automatically in the future. Please open an issue if any of these is an issue in your deployments or everyday usage.

Of course, you will need `wget` (or `curl`) installed to download the install script. You can install `wget` via your distribution’s package manager (e.g., `sudo apt install wget` on Ubuntu-like systems).

50
51
52
53
54
## Uninstall

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

```shell
Aral Balkan's avatar
Aral Balkan committed
55
site uninstall
56
57
```

58
## Use
59

60
61
62
### Development (servers @localhost)

#### Regular server
63

64
Start serving the current directory at https://localhost as a regular process using locally-trusted certificates:
65
66

```shell
Aral Balkan's avatar
Aral Balkan committed
67
$ site
68
69
```

70
#### Proxy server
71

Aral Balkan's avatar
Aral Balkan committed
72
You can use Site.js 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:
73
74

```shell
Aral Balkan's avatar
Aral Balkan committed
75
$ site :1313
76
77
```

78
79
80
81
This will create and serve the following proxies:

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

83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
### Testing (servers @hostname)

#### Regular server

Start serving the _my-site_ directory at your _hostname_ as a regular process using globally-trusted Let’s Encrypt certificates:

```shell
$ site my-site @hostname
```

#### Proxy server

Start serving `http://localhost:1313` and `ws://localhost:1313` at your _hostname_:

```shell
$ site :1313 @hostname
```

#### Making your server public

Use a service like [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.
Aral Balkan's avatar
Aral Balkan committed
104

105
106
107
108
109
When you start your server, 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.

### Deployment (live and one-time sync)

Site.js can also help you when you want to deploy your site to your live server with its sync feature. You can even have Site.js watch for changes and sync them to your server in real-time (e.g., if you want to live blog something or want to keep a page updated with local data you’re collecting from a sensor):
Aral Balkan's avatar
Aral Balkan committed
110
111

```shell
Aral Balkan's avatar
Aral Balkan committed
112
$ site my-demo --sync-to=my-demo.site
Aral Balkan's avatar
Aral Balkan committed
113
114
```

Aral Balkan's avatar
Aral Balkan committed
115
116
117
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 the host _my-demo.site_.

If don’t want Site.js to start a server and you want to perform just a one-time sync, use the `--exit-on-sync` flag.
Aral Balkan's avatar
Aral Balkan committed
118
119

```shell
Aral Balkan's avatar
Aral Balkan committed
120
$ site my-demo --sync-to=my-demo.site --exit-on-sync
Aral Balkan's avatar
Aral Balkan committed
121
122
```

Aral Balkan's avatar
Aral Balkan committed
123
Without any customisations, the sync feature 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_ on the remote server. Also, by default, the contents of the folder will be synced, not the folder itself. You can change these defaults by specifying a full-qualified remote connection string as the `--sync-to` value.
Aral Balkan's avatar
Aral Balkan committed
124

Aral Balkan's avatar
Aral Balkan committed
125
The remote connection string has the format:
Aral Balkan's avatar
Aral Balkan committed
126

Aral Balkan's avatar
Aral Balkan committed
127
128
```
remoteAccount@host:/absolute/path/to/remoteFolder
Aral Balkan's avatar
Aral Balkan committed
129
130
```

Aral Balkan's avatar
Aral Balkan committed
131
For example:
Aral Balkan's avatar
Aral Balkan committed
132

Aral Balkan's avatar
Aral Balkan committed
133
134
135
136
137
```shell
$ site my-folder --sync-to=someOtherAccount@my-demo.site:/var/www
```

If you want to sync a different folder to the one you’re serving or if you’re running a proxy server (or if you just want to be as explicit as possible about your intent) you can use the `--sync-from` option to specify the folder to sync:
Aral Balkan's avatar
Aral Balkan committed
138

Aral Balkan's avatar
Aral Balkan committed
139
```shell
Aral Balkan's avatar
Aral Balkan committed
140
$ site :1313 --sync-from=public --sync-to=my-demo.site
Aral Balkan's avatar
Aral Balkan committed
141
142
```

Aral Balkan's avatar
Aral Balkan committed
143
(The above command will start a proxy server that forwards requests to and responses from http://localhost to https://localhost and sync the folder called `public` to the host `my-demo.site`.)
Aral Balkan's avatar
Aral Balkan committed
144

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

```shell
Aral Balkan's avatar
Aral Balkan committed
148
$ site my-local-folder --sync-to=me@my.site:my-remote-folder --sync-folder-and-contents
149
150
```

Aral Balkan's avatar
Aral Balkan committed
151
152
The above command will result in the following directory structure on the remote server: _/home/me/my-remote-folder/my-local-folder_. It also demonstrates that if you specify a relative folder, Site.js assumes you mean the folder exists in the home directory of the account on the remote server.

153
### Production
154

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

157
On your live, public server, you can start serving the _my-site_ directory at your _hostname_ as a daemon that is automatically run at system startup and restarted if it crashes with:
158
159

```shell
Aral Balkan's avatar
Aral Balkan committed
160
$ site enable my-site
161
162
```

163
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.
164

165
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. (Yes, of course, [ar.al](https://ar.al) runs on Site.js.) The first time you hit your live site, it will take a little longer to load as your Let’s Encrypt certificates are being automatically provisioned by ACME TLS.
166

167
168
The automatic TLS certificate provisioning will get certificates for the naked domain and the _www_ subdomain. There is currently no option to add other subdomains. Also, please ensure that both the naked domain and the _www_ subdomain are pointing to your server before you enable your server and hit it to ensure that the provisioning works. This is especially important if you are migrating an existing site.

169
When the server is enabled, you can also use the following commands:
Aral Balkan's avatar
Aral Balkan committed
170

171
  - `disable`: Stop server and remove from startup.
172
  - `logs`: Display and tail server logs.
173
  - `status`: Display detailed server information (press ‘q’ to exit).
Aral Balkan's avatar
Aral Balkan committed
174

175
Site.js uses the [systemd](https://freedesktop.org/wiki/Software/systemd/) to start and manage the daemon. Beyond the commands listed above that Site.js supports natively (and proxies to systemd), you can make use of all systemd functionality via the [systemctl](https://www.freedesktop.org/software/systemd/man/systemctl.html) and [journalctl](https://www.freedesktop.org/software/systemd/man/journalctl.html) commands.
Aral Balkan's avatar
Aral Balkan committed
176

177
178
## Build and test from source

Aral Balkan's avatar
Aral Balkan committed
179
### Install the source and run tests
Aral Balkan's avatar
Aral Balkan committed
180

181
182
```shell
# Clone and install.
Aral Balkan's avatar
Aral Balkan committed
183
184
185
186
mkdir site.js && cd site.js
git clone https://source.ind.ie/site.js/app.git
cd app
./install
187
188
189

# Run unit tests.
npm test
Aral Balkan's avatar
Aral Balkan committed
190
```
191

Aral Balkan's avatar
Aral Balkan committed
192
193
194
195
196
197
198
199
200
201
### Install as global Node.js module

After you install the source and run tests:

```shell
# Install the binary as a global module
npm i -g

# Serve the test site locally (visit https://localhost to view).
site test/site
202
203
```

Aral Balkan's avatar
Aral Balkan committed
204
__Note:__ for commands that require root privileges (i.e., `enable` and `disable`), Site.js 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:
205
206
207
208
209
210
211

```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
212
213
### Native binaries

Aral Balkan's avatar
Aral Balkan committed
214
After you install the source and run tests:
Aral Balkan's avatar
Aral Balkan committed
215

Aral Balkan's avatar
Aral Balkan committed
216
```shell
217
218
# Build the native binary for your platform.
# To build for all platforms, use npm run build -- --all
Aral Balkan's avatar
Aral Balkan committed
219
220
221
npm run build

# Serve the test site (visit https://localhost to view).
222
223
# e.g., To run the version 12.0.0 Linux binary:
dist/linux/12.0.0/web-server test/site
224
225
```

226
227
### Build and install native binary locally

Aral Balkan's avatar
Aral Balkan committed
228
229
After you install the source and run tests:

230
231
232
233
```shell
npm run install-locally
```

234
235
236
237
### Deployment

```shell
# To build binaries for both linux and macOS and also to
238
# copy them over to the Site.js web Site for deployment.
239
240
# (You will most likely not need to do this.)
npm run deploy
Aral Balkan's avatar
Aral Balkan committed
241
242
```

243
## Syntax
244

Aral Balkan's avatar
Aral Balkan committed
245
```shell
246
site [command] [folder|:port] [@host[:port]] [--options]
Aral Balkan's avatar
Aral Balkan committed
247
```
248

249
250
251
252
253
254
  - `command`: version | help | serve | enable | disable | logs | status
  - `folder|:port`: Path of folder to serve (defaults to current folder) or port on localhost to proxy.
  - `@host[:port]`: Host (and, optionally port) to sync. Valid hosts are @localhost and @hostname.
  - `--options`: Settings that alter command behaviour.

__Key:__ `[]` = optional &nbsp;&nbsp;`|` = or
Aral Balkan's avatar
Aral Balkan committed
255

256
257
### Commands:

258
259
260
261
262
263
264
265
266
267
268
269
  - `serve`: Serve specified folder (or proxy specified `:port`) on specified `@host` (at `:port`, if given). The order of arguments is:

    1. what to serve,
    2. where to serve it at. e.g.,

    ```site serve my-folder @localhost```

    If a port (e.g., `:1313`) is specified instead of my-folder, start an HTTP/WebSocket proxy.

  - `version`: Display version and exit.
  - `help`: Display help screen and exit.
  - `uninstall`: Uninstall Site.js.
Aral Balkan's avatar
Aral Balkan committed
270

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

273
274
275
276
277
  - `enable`: Start server as daemon with globally-trusted certificates and add to startup.

  - `disable`: Stop server daemon and remove from startup.

  - `logs`: Display and tail server logs.
Aral Balkan's avatar
Aral Balkan committed
278

279
280
281
  - `status`: Display detailed server information.

If `command` is omitted, behaviour defaults to `serve`.
282
283

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

Aral Balkan's avatar
Aral Balkan committed
285
286
287
288
#### For both the `serve` and `enable` commands:

  - `--aliases`: Comma-separated list of additional domains to obtain TLS certificates for and respond to.

289
#### For the `serve` command:
Aral Balkan's avatar
Aral Balkan committed
290

291
  - `--sync-to`: The host to sync to.
Aral Balkan's avatar
Aral Balkan committed
292

293
  - `--sync-from`: The folder to sync from (only relevant if `--sync-to` is specified).
Aral Balkan's avatar
Aral Balkan committed
294

295
  - `--exit-on-sync`: Exit once the first sync has occurred (only relevant if `--sync-to` is specified). Useful in deployment scripts.
Aral Balkan's avatar
Aral Balkan committed
296

297
  - `--sync-folder-and-contents`: Sync folder and contents (default is to sync the folder’s contents only).
Aral Balkan's avatar
Aral Balkan committed
298

299
300
301
#### For the `enable` command:

  - `--ensure-can-sync`: Ensure server can rsync via ssh.
Aral Balkan's avatar
Aral Balkan committed
302

303
All command-line arguments are optional. By default, Site.js will serve your current working folder over port 443 with locally-trusted certificates.
304

305
When you `serve` a site at `@hostname` or use the `enable` command, 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).
306

Aral Balkan's avatar
Aral Balkan committed
307
308
## Usage examples

309
### Develop using locally-trusted TLS certificates
Aral Balkan's avatar
Aral Balkan committed
310
311
312

| Goal                                      | Command                                                       |
| ----------------------------------------- | ------------------------------------------------------------- |
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
| Serve current folder*                     | site                                                          |
|                                           | site serve                                                    |
|                                           | site serve .                                                  |
|                                           | site serve . @localhost                                       |
|                                           | site serve . @localhost:443                                   |
| Serve folder demo (shorthand)             | site demo                                                     |
| Serve folder demo on port 666             | site serve demo @localhost:666                                |
| Proxy localhost:1313 to https://localhost*| site :1313                                                    |
|                                           | site serve :1313 @localhost:443                               |
| Serve current folder, sync it to my.site* | site --sync-to=my.site                                        |
|                                           | site serve . @localhost:443 --sync-to=my.site                 |
| Serve demo folder, sync it to my.site     | site serve demo --sync-to=my.site                             |
| Ditto, but use account me on my.site      | site serve demo --sync-to=me@my.site                          |
| Ditto, but sync to remote folder ~/www    | site serve demo --sync-to=me@my.site:www                      |
| Ditto, but specify absolute path          | site serve demo --sync-to=me@my.site:/home/me/www             |
| Sync current folder, proxy localhost:1313 | site serve :1313 --sync-from=. --sync-to=my.site              |
| Sync current folder to my.site and exit   | site --sync-to=my.site --exit-on-sync                         |
| Sync demo folder to my.site and exit*     | site demo --sync-to=my.site --exit-on-sync                    |
|                                           | site --sync-from=demo --sync-to=my.site --exit-on-sync        |

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

#### Regular process:
Aral Balkan's avatar
Aral Balkan committed
336
337
338

| Goal                                      | Command                                                       |
| ----------------------------------------- | ------------------------------------------------------------- |
339
| Serve current folder                      | site @hostname                                                |
Aral Balkan's avatar
Aral Balkan committed
340
| Serve current folder also at aliases	    | site @hostname --aliases=other.site,www.other.site            |
341
342
343
344
345
346
| Serve folder demo*                        | site demo @hostname                                           |
|                                           | site serve demo @hostname                                     |
| Proxy localhost:1313 to https://hostname  | site serve :1313 @hostname                                    |

#### Start-up daemon:

347
348
| Goal                                      | Command                                                       |
| ----------------------------------------- | ------------------------------------------------------------- |
Aral Balkan's avatar
Aral Balkan committed
349
| Serve current folder as daemon            | site enable                                                   |
350
| Ditto & also ensure it can rsync via ssh  | site enable --ensure-can-sync                                 |
Aral Balkan's avatar
Aral Balkan committed
351
352
353
| Get status of daemon                      | site status                                                   |
| Display server logs                       | site logs                                                     |
| Stop current daemon                       | site disable                                                  |
Aral Balkan's avatar
Aral Balkan committed
354

355
\* _Alternative, equivalent forms listed (some commands have shorthands)._
356

357
## Native support for an Evergreen Web
358

Aral Balkan's avatar
Aral Balkan committed
359
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 Site.js, it’s effortless.
360

Aral Balkan's avatar
Aral Balkan committed
361
### Native cascading archives support
362

Aral Balkan's avatar
Aral Balkan committed
363
If you have a static archive of the previous version of your site, you can have Site.js 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`:
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380

```
|- 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.
381

Aral Balkan's avatar
Aral Balkan committed
382
Site.js 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 Site.js to forward any unknown requests on your new static site to that subdomain so that all your existing links magically work.
383
384
385

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

386
### /4042302
387
```
Aral Balkan's avatar
Aral Balkan committed
388
https://the-previous-version-of.my.site
389
```
390
391
392
393
394
395

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
396

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

399
400
401
402
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.

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

405
406
## Dynamic routes

407
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).
408

409
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:
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427

```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
```

Aral Balkan's avatar
Aral Balkan committed
428
Site.js 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.
429

430
431
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.

432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
__Note:__ You could also have named your route _.dynamic/server-stats/index.js_ and still hit it from _https://localhost/server-stats_. It’s best to keep to one or other convention (either using file names as route names or directory names as route names). Using both in the same app will probably confuse you (see [Precedence](#Precendence), below).

### Precedence

#### Between dynamic route and static route

If a dynamic route and a static route have the same name, the dynamic route will take precedence. So, for example, if you’re serving the following site:

```
site/
  ├ index.html
  └ .dynamic/
        └ index.js
```

When you hit `https://localhost`, you will get the dynamic route defined in _index.js_.

#### Between two dynamic routes (TL; DR: do not rely on this)

In the following scenario:

```
site/
  └ .dynamic/
        ├ fun.html
        └ fun/
           └ index.js
```

The behaviour observed under Linux at the time of writing is that _fun/index.js_ will have precendence and mask _fun.html_. __Do not rely on this behaviour.__ The order of dynamic routes is based on a directory crawl and is not guaranteed to be the same in all future versions. For your peace of mind, please do not mix file-name-based and directory-name-based routing.

463
464
### Directories

Aral Balkan's avatar
Aral Balkan committed
465
Your dynamic web routes are running within Site.js, which is a Node application compiled into a native binary.
466

Aral Balkan's avatar
Aral Balkan committed
467
  - `os.homedir()`: __(writable)__ This is the home folder of the account running Site.js. You can write to it to store persistent objects (e.g., save data).
468
469
470
471
472

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

473
  - `__dirname`: __(writeable)__ Path to the `.dynamic` folder.
474

Aral Balkan's avatar
Aral Balkan committed
475
  - `/`: __(read-only)__ Path to the `/usr` folder (Site.js is installed in `/usr/local/site`). You should not have any reason to use this.
476

Aral Balkan's avatar
Aral Balkan committed
477
If you want to access the directory of Site.js itself (e.g., to load in the `package.json` to read the app’s version), you can use the following code:
478
479

```js
Aral Balkan's avatar
Aral Balkan committed
480
const appPath = require.main.filename.replace('bin/site.js', '')
481
482
```

483
484
485
486
487
488
### 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

Aral Balkan's avatar
Aral Balkan committed
489
You shouldn’t use this functionality to create your latest amazing web app. For that, include Site.js 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 Site.js using Node.js.
490

491
## API
492

493
Site.js’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:
494

495
496
497
498
```js
const Site = require('@small-tech/site.js')
new Site().createServer
```
499

500
### createServer([options], [requestListener])
501

502
  - __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.
503

Aral Balkan's avatar
Aral Balkan committed
504
  - __requestListener__ _(function)_: see [https.createServer](https://nodejs.org/api/https.html#https_https_createserver_options_requestlistener). If you don’t pass a request listener, Site.js will use its default one.
505

506
    __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.
507

508
#### Example
509
510

```js
511
const Site = require('@small-tech/site.js')
512
513
514
515
516
const express = require('express')

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

517
const options = {} // to use globally-trusted certificates instead, set this to {global: true}
518
const server = new Site().createServer(options, app).listen(443, () => {
519
520
521
522
  console.log(` 🎉 Serving on https://localhost\n`)
})
```

523
### constructor (options)
524
525

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

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

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

Aral Balkan's avatar
Aral Balkan committed
531
  - __global__ _(boolean)_: if true, globally-trusted Let’s Encrypt certificates will be provisioned (if necessary) and used via ACME TLS. If false (default), locally-trusted certificates will be provisioned (if necessary) and used using _nodecert_.
532

533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
  - __proxyPort__ _(number)_: if provided, a proxy server will be created for the port (and `path` will be ignored).

    __Returns:__ Site instance.

__Note:__ if you want to run the site on a port < 1024 on Linux, ensure your process has the necessary privileges to bind to such ports. E.g., use:

```js
require('lib/ensure').weCanBindToPort(port, () => {
  // You can safely bind to a ‘privileged’ port on Linux now.
})
```

### serve(callback)

  - __callback__ _(function)_: a function to be called when the server is ready. This parameter is optional. Default callbacks are provided for both regular and proxy servers.

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


552
#### Examples
553

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

556
```js
557
558
const Site = require('@small-tech/site.js')
const server = new Site().serve()
559
560
```

Aral Balkan's avatar
Aral Balkan committed
561
Serve the current directory at your hostname using globally-trusted Let’s Encrypt TLS certificates:
562
563

```js
564
565
const Site = require('@small-tech/site.js')
const server = new Site().serve({global: true})
566
567
```

568
569
570
571
572
573
574
575
Start a proxy server to proxy local port 1313 at your hostname:

```js
const Site = require('@small-tech/site.js')
const server = new Site().serve({proxyPort: 1313, global: true})
```


576
577
## Contributing

Aral Balkan's avatar
Aral Balkan committed
578
Site.js is [Small Technology](https://ar.al/2019/03/04/small-technology/). The emphasis is on _small_. It is, by design, a zero-configuration tool for creating and hosting single-tenant web applications. It is for humans, by humans. It is non-commercial. (It is not for enterprises, it is not for “startups”, and it is definitely not for unicorns.) As such, any new feature requests will have to be both fit for purpose and survive a trial by fire to be considered.
579

Aral Balkan's avatar
Aral Balkan committed
580
Please file issues and submit pull requests on the [Site.js Github Mirror](https://github.com/small-tech/site.js).
581

582
583
## Help wanted

Aral Balkan's avatar
Aral Balkan committed
584
585
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.

Aral Balkan's avatar
Aral Balkan committed
586
I can use your help to test Site.js on the following platform/package manager combinations:
587

588
589
  - Linux with yum
  - macOS with MacPorts
590

Aral Balkan's avatar
Aral Balkan committed
591
Please [let me know how/if it works](https://github.com/small-tech/site.js/issues). Thank you!
592
593
594
595

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

Aral Balkan's avatar
Aral Balkan committed
597
  * [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: Site.js is not supported on Windows. Please use Windows Subsystem for Linux.__
598

Aral Balkan's avatar
Aral Balkan committed
599
  * [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: Site.js is not supported on Windows. Please use Windows Subsystem for Linux.__