diff --git a/README.md b/README.md index 021f359..30953e9 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,9 @@ Requires docker and docker-compose * Download the provided [docker-compose.yml file](https://github.com/kaythomas0/noisedash/blob/main/docker-compose.yml) * In the same directory as the docker-compose file, created a folder called `config`, and inside it, put the provided [config file](https://github.com/kaythomas0/noisedash/blob/main/config/default.json) + * `maxSampleSize` is in bytes - 10GB by default + * Keep `tls` as `false` if using an external web server like nginx + * `production.json` exists in the source code and is left empty intentionally for the reason outlined here: https://github.com/node-config/node-config/wiki/Strict-Mode#node_env-value-of-node_env-did-not-match-any-deployment-config-file-names= * Edit the config file to your preference * Bring the container up: @@ -53,7 +56,7 @@ ingress.networking.k8s.io/noisedashingress created ## From Source -Requires node 16 and npm +Requires node 20 and npm * Clone the repo: diff --git a/config/default.json b/config/default.json index 4516aee..48c7198 100644 --- a/config/default.json +++ b/config/default.json @@ -3,9 +3,9 @@ "listeningPort": 1432, "sessionFileStorePath": "sessions", "sampleUploadPath": "samples", - "maxSampleSize": 10737418240, // In bytes, 10GB by default + "maxSampleSize": 10737418240, "logFile": "log/noisedash.log", - "tls": false, // Keep this as false if using an external web server like nginx + "tls": false, "tlsKey": "certs/key.pem", "tlsCert": "certs/cert.pem" } diff --git a/config/production.json b/config/production.json index b4b884a..9e26dfe 100644 --- a/config/production.json +++ b/config/production.json @@ -1 +1 @@ -{} // Left empty intentionally: https://github.com/node-config/node-config/wiki/Strict-Mode#node_env-value-of-node_env-did-not-match-any-deployment-config-file-names= \ No newline at end of file +{} \ No newline at end of file