chore: add dockerignore

Author: johanbook

.dockerignore

@@ -0,0 +1,5 @@
+.git
+.github
+build
+node_modules
+*.md

CONTRIBUTING.md

@@ -1,16 +1,39 @@
 # Contributing
 
-## Technological stack
+This outlines all practices for contributing to this project.
+
+## Technologies
 
 The project uses the Nodejs runtime environment but aims to use minimal
 dependencies in order to create small bundle sizes.
 
-## Git methodology
+The software is shipped in Docker images.
+
+## Security
+
+The software is intended to be run on
+[Nodejs 16.18.0 LTS](https://nodejs.org/en/) and all released versions have 0
+vulnerabilities in NPM audits. This check is carried out as part of the release
+procedure.
+
+The software relies on the
+[Nodejs HTTP module](https://nodejs.org/api/http.html) and will be vulnerable to
+any vulnerabilities in that module.
+
+The software has been tested for
+[LFI](https://www.johanbook.com/docs/security/vulnerabilities/lfi)
+vulnerabilities.
+
+## Development practices
 
-This project uses `main` as development branch. New features are committed
-through feature branches and merged into main through pull requests.
+### Git methodology
 
-## Release management
+This project uses
+[main as development branch](https://unixsheikh.com/tutorials/a-simple-git-workflow-using-main-as-the-development-branch.html)
+to allow bleeding edge on main. New features are committed through feature
+branches and merged into main through pull requests.
+
+### Release management
 
 This project uses [semver](https://semver.org/), handled by the NPM package
 [standard-version](https://www.npmjs.com/package/standard-version). For creating
@@ -20,3 +43,10 @@ a new release, run the following commands:
 npm run release
 git push --follow-tags origin main
 ```
+
+Before creating a new release, confirm that there are no known vulnerabilities
+in the project dependencies by running
+
+```sh
+npm audit
+```

Dockerfile

@@ -10,6 +10,6 @@ RUN npm ci
 
 USER node
 
-CMD ["node", "server.js"]
+CMD ["node", "src"]
 
 EXPOSE 8080

README.md

@@ -7,7 +7,11 @@ in a production environment_
 different folders depending on the HTTP `Host` header. It is mainly intended to
 run an internal network with its own DNS server.
 
-## Configuration
+## Get started
+
+The server can be run either via a Nodejs runtime or through Docker.
+
+### Folder structure
 
 Create an asset folder, named `build` by default. In this folder create one
 folder for each domain that should be served. These folders should contain the
@@ -29,18 +33,10 @@ build/mycat.com/index.html
 build/mycat.com/script.js
 ```
 
-### Environmental variables
-
-The following can be configured as environment variables:
-
-- **DEFAULT_INDEX_FILE** name of file served on paths ending with a trailing
-  slash (default `index.html`).
-- **PORT** the port the server should listen on (default 8080).
-- **ROOT_FILE_PATH** root directory of served file tree (default `build`).
-
-## Docker
+### Using Docker
 
-The server can be run through Docker
+The server can be run through Docker by mounting in the served directory as a
+volume. To the serve the `build` folder in the current directory, run
 
 ```sh
 docker run \
@@ -51,6 +47,22 @@ docker run \
 	johanbook/file-domain-server:latest
 ```
 
+The Docker images are available for multiple architectures, including armv7.
+
+## Configuration
+
+The following can be configured as environment variables:
+
+- **DEFAULT_INDEX_FILE** name of file served on paths ending with a trailing
+  slash (default `index.html`).
+- **PORT** the port the server should listen on (default 8080).
+- **ROOT_FILE_PATH** root directory of served file tree (default `build`).
+
+## Documentation
+
+For documentation on technologies, security aspect and similar, see the
+[contributions file](./CONTRIBUTING.md).
+
 ## Contributing
 
 For contributions and development procedures, see the

package.json

@@ -1,13 +1,14 @@
 {
   "name": "domain-file-server",
   "version": "1.0.1",
-  "description": "",
+  "description": "a simplistic file server for multiple domains",
   "main": "index.js",
   "scripts": {
-    "release": "standard-version"
+    "release": "standard-version",
+    "serve": "node src"
   },
   "keywords": [],
-  "author": "",
+  "author": "Johan Book",
   "license": "ISC",
   "devDependencies": {
     "prettier": "^2.7.1",