README.md 563 Bytes
Newer Older
Aral Balkan's avatar
Aral Balkan committed
1 2
# https-server

Aral Balkan's avatar
Aral Balkan committed
3
__Work in progress:__ Please do not use yet.
Aral Balkan's avatar
Aral Balkan committed
4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22

An HTTPS server that uses [nodecert](https://source.ind.ie/hypha/tools/nodecert).

## Design goals

  * __Command-line use:__ https-server _directory_
  * Easy integration into Express

## Installation

```sh
npm i -g @ind.ie/https-server
```

(On macOS, you must [manually install the dependency](#macos-dependency) for now.)

## Usage

### Commandline
Aral Balkan's avatar
Aral Balkan committed
23

Aral Balkan's avatar
Aral Balkan committed
24
```sh
Aral Balkan's avatar
Aral Balkan committed
25
https-server <folder-to-serve>
Aral Balkan's avatar
Aral Balkan committed
26 27 28
```

If you do not already have TLS certificates, they will be created for you automatically using nodecert.