Updated README
This commit is contained in:
parent
b104a7f09e
commit
ac865efa95
1 changed files with 17 additions and 1 deletions
18
README.md
18
README.md
|
@ -1 +1,17 @@
|
||||||
# Placeholder
|
# website-serve Docker Image
|
||||||
|
|
||||||
|
This is a simple `node:lts` based Docker Image with the `serve` fork of `@warren-bank` already preinstalled.
|
||||||
|
It can be used to serve static files like websites.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
To use the `serve` process, run the following `CMD` at the end of your own docker image:
|
||||||
|
|
||||||
|
```dockerfile
|
||||||
|
CMD [ "serve", DIRECTORY, "-p", PORT ]
|
||||||
|
```
|
||||||
|
|
||||||
|
Replace the values for `DIRECTORY` and `PORT` accordingly.
|
||||||
|
|
||||||
|
It is recommended to include a `serve.json` file inside the `DIRECTORY`. <br/>
|
||||||
|
The syntax for this can be found [here](https://github.com/warren-bank/node-serve/tree/master/lib/serve-handler)
|
||||||
|
|
Loading…
Reference in a new issue