CI-Docker-Images/website-serve
CI-Docker-Images/website-serve
2
0
Fork 0
Code Issues Pull requests Projects Releases 5 Packages 1 Wiki Activity Actions

Updated README

Browse source
This commit is contained in:
Firq 2023-12-29 13:05:18 +01:00
parent b104a7f09e
commit ac865efa95
Signed by: Firq
GPG key ID: 4DE1059A4666E89F
1 changed files with 17 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -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)