Merge pull request #398 from stratosphereips/ondra-fix-docker-documentation

Ondra fix docker documentation

Author: ondrej-lukas

.dockerignore

@@ -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

README.md

@@ -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"
 ```
 

docs/index.md

@@ -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 .
@@ -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:
@@ -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

pyproject.toml

@@ -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"