Skip to content

Commit 8c5d21c

Browse files
authored
Update extensions.md
1 parent 9df3b71 commit 8c5d21c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

docs/extensions.md

+5-3
Original file line numberDiff line numberDiff line change
@@ -267,16 +267,18 @@ It should look like this: ExecStart=/opt/tenzir/bin/tenzir-node "--commands=web
267267
- **Control the Shuffle Tenzir node from Tenzir Cloud**: Go to [Tenzir Cloud](https://app.tenzir.com) and create a node configuration. Download the configuration file, then add the variables found in it to the following environment variables to Orborus: `TENZIR_PLUGINS__PLATFORM__API_KEY=<apikey>`, `TENZIR_PLUGINS__PLATFORM__CONTROL_ENDPOINT=<url>`, `TENZIR_PLUGINS__PLATFORM__TENANT_ID=<tenant>`
268268

269269
### Mounting the Tenzir Sigma location into Orborus
270-
TBD
270+
1. You need to mount in the folder that is going to store the sigma rules, controlled from within Shuffle
271+
2. The default location is /tmp/sigma_rules, so to mount it in, use `--volume "/tmp:/tmp"` in the Dockerfile.
272+
3. If you end up changing the storage location, use the `SHUFFLE_STORAGE_FOLDER` environment variable with the full path.
271273

272274
### Running the Tenzir Detection pipeline
273-
To run the detection pipeline,
275+
- [Sigma Pipelines with Tenzir](https://docs.tenzir.com/tql2/operators/sigma)
274276

275277
### Running a sample Detection
276278
TBD
277279

278280
### Storing Tenzir logs in Opensearch
279-
TBD
281+
- [Tenzir -> Opensearch documentation](https://docs.tenzir.com/integrations/opensearch)
280282

281283
## KMS
282284
Shuffle by default allows you to store authentication tokens within Shuffle itself, which are encrypted in the database. Since February 2024, we additionally support the use of external KMS systems to handle authentication, which is based on [Native Actions](https://shuffler.io/docs/extensions#native-actions) and [Schemaless](https://github.com/frikky/schemaless). Native Actions run in the background to perform the "Get KMS key" action, and the run of the app is NOT stored.

0 commit comments

Comments
 (0)