Fix comments in json file

This commit is contained in:
Kevin Thomas
2025-08-12 19:56:33 -04:00
parent cba9cd6e85
commit 9f376ae56f
3 changed files with 7 additions and 4 deletions

View File

@@ -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) * 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) * 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 * Edit the config file to your preference
* Bring the container up: * Bring the container up:
@@ -53,7 +56,7 @@ ingress.networking.k8s.io/noisedashingress created
## From Source ## From Source
Requires node 16 and npm Requires node 20 and npm
* Clone the repo: * Clone the repo:

View File

@@ -3,9 +3,9 @@
"listeningPort": 1432, "listeningPort": 1432,
"sessionFileStorePath": "sessions", "sessionFileStorePath": "sessions",
"sampleUploadPath": "samples", "sampleUploadPath": "samples",
"maxSampleSize": 10737418240, // In bytes, 10GB by default "maxSampleSize": 10737418240,
"logFile": "log/noisedash.log", "logFile": "log/noisedash.log",
"tls": false, // Keep this as false if using an external web server like nginx "tls": false,
"tlsKey": "certs/key.pem", "tlsKey": "certs/key.pem",
"tlsCert": "certs/cert.pem" "tlsCert": "certs/cert.pem"
} }

View File

@@ -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= {}