Skip to content

Commit d1861bb

Browse files
committed
docs: add badges to readme
1 parent 8177807 commit d1861bb

File tree

2 files changed

+20
-5
lines changed

2 files changed

+20
-5
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,14 @@ The software is shipped in Docker images.
1212
## Security
1313

1414
The software is intended to be run on
15-
[Nodejs 16.18.0 LTS](https://nodejs.org/en/) and all released versions have 0
16-
vulnerabilities in NPM audits. This check is carried out as part of the release
17-
procedure.
18-
19-
The software relies on the
15+
[Nodejs 16.18.0 LTS](https://nodejs.org/en/). The software relies on the
2016
[Nodejs HTTP module](https://nodejs.org/api/http.html) and will be vulnerable to
2117
any vulnerabilities in that module.
2218

19+
All released versions have 0 vulnerabilities in NPM audits. This check is
20+
carried out as part of the release process. The repository is also scanned
21+
weekly with [Snyk](snyk.io) for vulnerabilities.
22+
2323
The software has been tested for
2424
[LFI](https://www.johanbook.com/docs/security/vulnerabilities/lfi)
2525
vulnerabilities.

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,15 @@
11
# file-domain-server
22

3+
![version](https://img.shields.io/github/v/tag/johanbook/file-domain-server)
4+
![docker pulls](https://img.shields.io/docker/pulls/johanbook/file-domain-server)
5+
![vulnerabilities](https://img.shields.io/snyk/vulnerabilities/github/johanbook/file-domain-server)
6+
37
**file-domain-server** is a simplistic Nodejs HTTP file server that serves
48
different folders depending on the HTTP `Host` header. It is mainly intended to
59
run on an internal network with its own DNS server.
610

11+
The project aims to be minimal production dependency.
12+
713
## Get started
814

915
The server can be run either via a Nodejs runtime or through Docker.
@@ -30,6 +36,15 @@ build/mycat.com/index.html
3036
build/mycat.com/script.js
3137
```
3238

39+
### Using Nodejs
40+
41+
Install and run the server using
42+
43+
```sh
44+
npm ci --production
45+
ROOT_FILE_PATH=/path/to/folder node src
46+
```
47+
3348
### Using Docker
3449

3550
The server can be run through Docker by mounting in the served directory as a

0 commit comments

Comments
 (0)