From 8dcd9be67d821e03546e41876fcd69b0b798d0f2 Mon Sep 17 00:00:00 2001 From: Maarten de Kruijf Date: Fri, 2 Aug 2024 10:16:54 +0200 Subject: [PATCH] Updated docs with new config option --- docs/content/en/docs/core-components/log.md | 3 --- .../content/en/docs/getting-started/_index.md | 21 +++++++++++++++++++ 2 files changed, 21 insertions(+), 3 deletions(-) diff --git a/docs/content/en/docs/core-components/log.md b/docs/content/en/docs/core-components/log.md index 728dff02..2e93e4e5 100644 --- a/docs/content/en/docs/core-components/log.md +++ b/docs/content/en/docs/core-components/log.md @@ -72,9 +72,6 @@ To change logging for your SOARCA instance you can use the following environment |LOG_MODE |development \| production |If production is chosen the `LOG_GLOBAL_LEVEL` is used for all modules defaults to `production` |LOG_FILE_PATH |filepath |Path to the logfile you want to use for all logging. Defaults to `""` (empty string) |LOG_FORMAT |text \| json |The logging can be in plain text format or in JSON format. Defaults to `json` -|MQTT_BROKER | dns name or ip | The broker address for SOARCA to connect to, for communication with fins default is `localhost` -|MQTT_PORT | port | The broker address for SOARCA to connect to, for communication with fins default is `1883` -|ENABLE_FINS| true \| false | Enable fins in SOARCA defaults to `false` diff --git a/docs/content/en/docs/getting-started/_index.md b/docs/content/en/docs/getting-started/_index.md index 0629e48b..82a01ada 100644 --- a/docs/content/en/docs/getting-started/_index.md +++ b/docs/content/en/docs/getting-started/_index.md @@ -98,6 +98,7 @@ LOG_FORMAT: "json" ENABLE_FINS: false MQTT_BROKER: "localhost" MQTT_PORT: 1883 +VALIDATION_SCHEMA_URL: "" {{< /tab >}} {{< /tabpane >}} @@ -113,3 +114,23 @@ make build cp .env.example .env ./build/soarca ``` + +### Configuring SOARCA + +|variable |content |description +|---|---|---| +|PORT |port |Set the exposed port of SOARCA the default is `8080` +|DATABASE |true \| false | Set if you want to run with external database default is `false` +|MONGODB_URI |uri |Set the Mongo DB uri default is `mongodb://localhost:27017` +|DATABASE_NAME |name |Set the Mongo DB database name when using docker default is `soarca` +|DB_USERNAME |user |Set the Mongo DB database user when using docker default is `root` +|DB_PASSWORD |password |Set the Mongo DB database users password when using docker default is `rootpassword`. IT IS RECOMMENDED TO CHANGE THIS IN PRODUCTION! +|MAX_REPORTERS |number |Set the maximum number of downstream reporters default is `5` +|LOG_GLOBAL_LEVEL |[Log levels] |One of the specified log levels. Defaults to `info` +|LOG_MODE |development \| production |If production is chosen the `LOG_GLOBAL_LEVEL` is used for all modules defaults to `production` +|LOG_FILE_PATH |filepath |Path to the logfile you want to use for all logging. Defaults to `""` (empty string) +|LOG_FORMAT |text \| json |The logging can be in plain text format or in JSON format. Defaults to `json` +|MQTT_BROKER | dns name or ip | The broker address for SOARCA to connect to, for communication with fins default is `localhost` +|MQTT_PORT | port | The broker address for SOARCA to connect to, for communication with fins default is `1883` +|ENABLE_FINS| true \| false | Enable fins in SOARCA defaults to `false` +|VALIDATION_SCHEMA_URL|url| Set a custom validation schema to be used to validate playbooks defaul is `""` to use internal. NOTE: changing this heavily impacts performance.