Merge branch 'main' of github.com:SpecterOps/Nemesis

docker-compose.yml

@@ -13,6 +13,7 @@ x-secrestore-variables: &secrestore-variables
     - HASURA_ADMIN_SECRET=${HASURA_ADMIN_SECRET:-pass456}
     - GRAFANA_ADMIN_USER=${GRAFANA_ADMIN_USER:?}
     - GRAFANA_ADMIN_PASSWORD=${GRAFANA_ADMIN_PASSWORD:?}
+    - NEMESIS_PORT=${NEMESIS_PORT:-7443}
 
 volumes:
   postgres_data:
@@ -852,8 +853,9 @@ services:
       # Default username and pass are both the letter 'n'. User generate_start_command.sh otherwise.
       - "traefik.http.middlewares.auth.basicauth.users=${BASIC_AUTH_USERS:-n:$$apr1$$RbnOjtKr$$S706SPJ3KzCKIref.gRFT.}"
       - "traefik.http.routers.dashboard.tls=true"
+    <<: *secrestore-variables # common ENV variables for the secretstore
     ports:
-      - "7443:443"
+      - "${NEMESIS_PORT:-7443}:443"
       # - "8080:8080"
     volumes:
       - "/var/run/docker.sock:/var/run/docker.sock:ro"

docs/performance.md

@@ -0,0 +1,20 @@
+# Performance Tuning
+
+Nemesis may perform differently depending on the system architecture and resources, specifically RAM and the number of CPUs.
+
+If workflows begin to fail, or you are experiencing major performance issues (as diagnosed by the [Troubleshooting](troubleshooting.md) document) there are a few tunable parameters that can help. Alternatively, if your performance is fine and you want to potentially increase performance, you can increase these values. Most/all of these values involve altering behaviors for the `file-enrichment` service.
+
+
+### UVICORN_WORKERS
+
+For production (non-dev) deployments, multiple UVICORN_WORKERS are used for the `file-enrichment` service. The default value is 2 and is defined in the `file-enrichment` section in [docker-compose.prod.yml](https://github.com/SpecterOps/Nemesis/blob/main/docker-compose.prod.yml). This value can be set to 1 for troubleshooting, or increased to 4+ for potential performance gains.
+
+
+### MAX_PARALLEL_WORKFLOWS
+
+The `file-enrichment` container runs a number of file-enrichment workflows in parallel, defaulting to 5. You can modify this value by defining the `export MAX_PARALLEL_WORKFLOWS=3` environment variable before launching Nemesis.
+
+
+### MAX_PARALLEL_ENRICHMENT_MODULES
+
+For each file enrichment workflow, the `file-enrichment` container runs multiple file enrichment modules in parallel, defaulting to 5. You can modify this value by defining the `export MAX_PARALLEL_ENRICHMENT_MODULES=3` environment variable before launching Nemesis.

docs/quickstart.md

@@ -45,6 +45,15 @@ export APPRISE_URLS=slack://Nemesis@T...6x/#nemesis-testing,slack://Nemesis@T...
 
 **NOTE:** for APPRISE_URLs, to route user feedback to a specific channel use `?tag=feedback` as shown above. Otherwise stock alerts will go to the first URL listed. See the [Alerting](./usage_guide.md#alerting) section of the Usage Guide for more information.
 
+#### Changing the Nemesis Port
+
+To change the port that Nemesis is hosted on, set a new port with `export NEMESIS_PORT=1234` before running Nemesis ensure the `NEMESIS_URL` ENV variable reflects the correct port.
+
+#### Using Other SSL Certficiates
+
+To use your own SSL certificates, simply replace the `server.crt` and `server.key` files at ../infra/traefik/certs/ before launching Nemesis.
+
+
 ### Step 3: Build and start Nemesis.
 
 #### For Development Deployments

mkdocs.yml

@@ -19,6 +19,7 @@ nav:
     - usage_guide.md
     - cli.md
     - troubleshooting.md
+    - performance.md
     - yara.md
 
   - Services: