-
Notifications
You must be signed in to change notification settings - Fork 10
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
Add a Caldera service to the Docker setup #313
base: development
Are you sure you want to change the base?
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -30,7 +30,7 @@ make build && ./build/soarca | |
wget https://github.com/COSSAS/SOARCA/releases/download/SOARCA_1.0.0/SOARCA_1.0.0_linux_amd64.tar.gz && tar -xvf SOARCA* && ./SOARCA | ||
{{< /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 commentThe 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 |
||
{{< /tab >}} | ||
{{< /tabpane >}} | ||
|
||
|
@@ -72,6 +72,30 @@ curl -X POST -H "Content-Type: application/json" -d @./example/openc2-playbook.j | |
{{< /tab >}} | ||
{{< /tabpane >}} | ||
|
||
### 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 %}} | ||
|
||
Comment on lines
+75
to
+98
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. |
||
## Configuration | ||
|
||
SOARCA reads its configuration from the environment variables or a `.env` file. An example of a `.env` is given below: | ||
|
@@ -98,17 +122,31 @@ ENABLE_FINS: false | |
MQTT_BROKER: "localhost" | ||
MQTT_PORT: 1883 | ||
|
||
CALDERA_HOST: "http://caldera.mydomain.com" | ||
CALDERA_PORT: "8888" | ||
CALDERA_API_KEY: "ADMIN123" | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
||
|
||
HTTP_SKIP_CERT_VALIDATION: false | ||
{{< /tab >}} | ||
{{< /tabpane >}} | ||
|
||
|
||
For more custom and advanced deployment instructions go [here](/docs/installation-configuration/_index.md). | ||
### Docker hub | ||
|
||
`docker pull cossas/soarca` | ||
## Obtaining | ||
|
||
There are several ways to obtain a copy of the SOARCA software. | ||
|
||
### Docker Hub | ||
|
||
A prebuilt image can be pulled from the | ||
[Docker Hub](https://hub.docker.com/r/cossas/soarca): | ||
|
||
```bash | ||
docker pull cossas/soarca | ||
``` | ||
|
||
### Building from Source | ||
### Building from source | ||
|
||
```bash | ||
git clone https://github.com/COSSAS/SOARCA.git | ||
|
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