-
Notifications
You must be signed in to change notification settings - Fork 14
Add a Caldera service to the Docker setup #313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: development
Are you sure you want to change the base?
Conversation
Sigrid maintainability feedback💭️ You did not change any files that are measured by Sigrid |
983f827 to
7b2fce4
Compare
7b2fce4 to
53a963a
Compare
| {{< /tab >}} | ||
| {{< tab header="Docker Compose" lang="sh" >}} | ||
| cd docker/soarca && sudo docker compose up -d | ||
| cd docker/soarca && docker compose up -d |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
| ### 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 %}} | ||
|
|
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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" |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
53a963a to
9e9fe49
Compare
9e9fe49 to
216381f
Compare
Fixes #308