Skip to content

Conversation

@mpboom
Copy link
Collaborator

@mpboom mpboom commented Jan 12, 2025

Fixes #308

@mpboom mpboom self-assigned this Jan 12, 2025
@mpboom
Copy link
Collaborator Author

mpboom commented Jan 12, 2025

@github-actions
Copy link

github-actions bot commented Jan 12, 2025

Sigrid maintainability feedback

💭️ You did not change any files that are measured by Sigrid


View this system in Sigrid

@MrDurion MrDurion force-pushed the feature/caldera-docker branch from 983f827 to 7b2fce4 Compare January 15, 2025 14:51
@MaartendeKruijf MaartendeKruijf self-requested a review January 23, 2025 12:32
{{< /tab >}}
{{< tab header="Docker Compose" lang="sh" >}}
cd docker/soarca && sudo docker compose up -d
cd docker/soarca && docker compose up -d
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please don't remove this as many users don't have sudoless docker

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I removed it. Still think this is bad practice though. Adding yourself to the docker group post-install is easy, documented in official installation instructions and mitigates security issues by not invoking the Docker client as root - and therefore should be encouraged.

Comment on lines 75 to 98
### Caldera setup

SOARCA optionally comes packaged together with Caldera. To use the
[Caldera capability](/docs/soarca-extensions/native-capabilities#caldera-capability), simply make
sure you use the right Compose file when running:

```diff
- cd docker/soarca && docker compose up -d
+ cd docker/soarca && docker compose --profile caldera up -d
```

{{% alert title="Warning" %}}
This only works when using Docker Compose to run SOARCA. When building SOARCA from scratch,
you should supply your own Caldera instance and [configure](#configuration) its URL manually.
{{% /alert %}}

{{% alert title="Warning" %}}
Note that Caldera in this mode operates with default credentials and settings. This is dangerous
for a public-facing setup and therefore not production-ready out of the box. You probably want
to consult the
[Caldera documentation on configuration](https://caldera.readthedocs.io/en/latest/Server-Configuration.html#configuration-file)
before deploying to production.
{{% /alert %}}

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We introduced the advanced installation & configuration I think we should put this there.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done, moved

THEHIVE_API_BASE_URL: http://localhost:9000/api/v1/
CALDERA_HOST: "calera"
CALDERA_PORT: "8888"
CALDERA_API_KEY: "ADMIN123"
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe choose a bit longer password as this is easily crackable (I know someone needs to pick it them self) but make it harder to guess

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is actually not a password I/we chose. It's the default password Caldera ships with. Therefore, to enable plug-and-play with the Docker container, we'd need to set it like this. This password is publicly available in the repository anyway.

@mpboom mpboom force-pushed the feature/caldera-docker branch from 9e9fe49 to 216381f Compare January 31, 2025 22:13
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Docker setup for Caldera

3 participants