Skip to content
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

Feature/fix doc and pimp dockerfile #3

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,9 @@ To update the project, follow these steps:
```

## Docker

You can alternatively run it in Docker, following those steps :

1. Build the image
```bash
docker compose build
Expand All @@ -89,13 +92,13 @@ To update the project, follow these steps:
```bash
# Create a docker override file and add the host as extra_hosts
tee docker-compose.override.yml > /dev/null <<EOF
services:
skillaegis-dashboard:
extra_hosts:
- "host.docker.internal:host-gateway"
EOF
```
services:
skillaegis-dashboard:
extra_hosts:
- "host.docker.internal:host-gateway"
EOF
```

4. Run the application
```bash
docker compose up
Expand Down Expand Up @@ -191,7 +194,6 @@ We welcome contributions from the community. To contribute:
git push origin feature/your-feature-name
```
5. Open a pull request.
.

# License
This software is licensed under GNU Affero General Public License version 3
Expand Down
8 changes: 8 additions & 0 deletions docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
volumes:
skillaegis_main_storage:
skillaegis_dashboard_storage:
skillaegis_editor_storage:

services:
skillaegis-main:
build:
Expand All @@ -11,6 +16,7 @@ services:
- SKILLAEGIS_DASHBOARD_URL=http://localhost:4001
- SKILLAEGIS_EDITOR_URL=http://localhost:4002
volumes:
- skillaegis_main_storage:/app/
- ./scenarios:/app/scenarios
ports:
- "4000:4000"
Expand All @@ -29,6 +35,7 @@ services:
- SKILLAEGIS_MISP_APIKEY=${SKILLAEGIS_MISP_APIKEY:-FI4gCRghRZvLVjlLPLTFZ852x2njkkgPSz0zQ3E0}
- SKILLAEGIS_MISP_SKIPSSL=${SKILLAEGIS_MISP_SKIPSSL:-1}
volumes:
- skillaegis_dashboard_storage:/app/
- ./scenarios:/app/scenarios
ports:
- "4001:4001"
Expand All @@ -44,6 +51,7 @@ services:
- SKILLAEGIS_PORT=4002
- SKILLAEGIS_EXERCISE_FOLDER=scenarios
volumes:
- skillaegis_editor_storage:/app/
- ./scenarios:/app/scenarios
ports:
- "4002:4002"