Skip to content
Merged
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
10 changes: 7 additions & 3 deletions .dockerignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@
.pytest_cache
.ruff_cache
.vscode
dist/
docs/
examples/
figures/
logs/
mlruns/
notebooks/
NetSecGameAgents/
tests/
trajectories/
NetSecGameAgents/
notebooks/
readme_images/
tests/
*trajectories*.json
README.md
README.md
mkdocs.yml
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -120,15 +120,15 @@ When running in the Docker container, the NetSecGame can be started with:
docker run -it --rm \
-v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \
-v $(pwd)/logs:/aidojo/logs \
-p 9000:9000 stratosphereips/netsecgame:lastest
-p 9000:9000 stratosphereips/netsecgame
```
optionally, you can set the logging level with `--debug_level=["DEBUG", "INFO", "WARNING", "CRITICAL"]` (defaul=`"INFO"`):

```bash
docker run -it --rm \
-v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \
-v $(pwd)/logs:/aidojo/logs \
-p 9000:9000 aidojo-local-test:latest \
-p 9000:9000 stratosphereips/netsecgame \
--debug_level="WARNING"
```

Expand Down
18 changes: 13 additions & 5 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@ conda create --name aidojo python==3.12.10
```bash
conda activate aidojo
```

After the virtual environment is activated, install using pip:
```bash
pip install -e .
Expand All @@ -33,9 +32,9 @@ The NetSecGame can be run in a Docker container. You can build the image locally
```bash
docker build -t aidojo-nsg-coordinator:latest .
```
or use the availabe image from [Dockerhub](https://hub.docker.com/r/lukasond/aidojo-coordinator).
or use the available image from [Dockerhub](https://hub.docker.com/r/stratosphereips/netsecgame).
```bash
docker pull lukasond/aidojo-coordinator:1.0.2
docker pull stratosphereips/netsecgame
```
## Quick Start
A task configuration needs to be specified to start the NetSecGame (see [Configuration](configuration.md)). For the first step, the example task configuration is recommended:
Expand Down Expand Up @@ -112,9 +111,18 @@ Upon which the game server is created on `localhost:9000` to which the agents ca
When running in the Docker container, the NetSecGame can be started with:
```bash
docker run -it --rm \
-v $(pwd)/examples/example_config.yaml:/aidojo/netsecenv_conf.yaml \
-v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \
-v $(pwd)/logs:/aidojo/logs \
-p 9000:9000 lukasond/aidojo-coordinator:1.0.2
-p 9000:9000 stratosphereips/netsecgame
```
optionally, you can set the logging level with `--debug_level=["DEBUG", "INFO", "WARNING", "CRITICAL"]` (defaul=`"INFO"`):

```bash
docker run -it --rm \
-v $(pwd)/examples/example_task_configuration.yaml:/aidojo/netsecenv_conf.yaml \
-v $(pwd)/logs:/aidojo/logs \
-p 9000:9000 stratosphereips/netsecgame \
--debug_level="WARNING"
```

## Documentation
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ dependencies = [
"tenacity==8.5.0",
"typing-inspect==0.9.0",
"typing_extensions==4.12.2",
"cyst-core @ git+https://github.com/AI-Dojo-Public/cyst-core.git@master"
"cyst-core>=0.5.0"
]
requires-python = ">=3.12"

Expand Down
37 changes: 0 additions & 37 deletions requirements.txt

This file was deleted.