Skip to content

Commit 8c51c41

Browse files
author
Bas Alberts
committed
Include release docs
1 parent 93eec0a commit 8c51c41

File tree

2 files changed

+36
-0
lines changed

2 files changed

+36
-0
lines changed

release.txt

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
# release tooling
66
./release.txt
7+
./release_tools/HOWTO.md
78
./release_tools/copy_files.py
89
./release_tools/publish_docker.py
910

release_tools/HOWTO.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
# How to release the Agent and its Docker image
2+
3+
To release an updated version of the Agent perform the following steps:
4+
5+
1. Add any newly created files or dependencies to `release.txt`.
6+
7+
2. Release an updated Docker image:
8+
9+
```sh
10+
docker login ghcr.io -u YOUR_GITHUB_USERNAME
11+
python release_tools/publish_docker.py release.txt main.py ghcr.io/githubsecuritylab/seclab-taskflow-agent latest
12+
```
13+
14+
Note: your login password is a GitHub PAT with packages write/read/delete scope enabled.
15+
16+
# Notes on our Docker image configuration
17+
18+
For simplicity we use a single Dockerfile that contains all the dependencies required for both our Agent and our various MCP servers.
19+
20+
Since we provide a mount path for the main agent that is configurable via an environment variable, you can provide custom data to the included stdio MCP servers without any Docker image requirements. By setting a path in the `MY_DATA` environment variable, that data will be available in `/app/my_data` to the Agent and its included MCP servers.
21+
22+
Likewise you can mount custom taskflows (`MY_TASKFLOWS`), personalities (`MY_PERSONALITIES`), and prompts (`MY_PROMPTS`) into the Docker image to make them available for use by the Agent.
23+
24+
See `docker/run.sh` for details on how to leverage those configurations. We do also provide the host Docker socket to the image such that 3rd party Docker MCP server images, such as the GitHub MCP server, work as expected.
25+
26+
The default entry point for our Agent Docker image is `/app/main.py`. If you'd like to deploy one of our MCP servers as a standalone server via the Docker image, use `--entrypoint` to set the appropriate entry point.
27+
28+
For example, a configuration to run the echo MCP server via Docker image instead, would look like:
29+
30+
```yaml
31+
server_params:
32+
kind: stdio
33+
command: docker
34+
args: ["run", "--entrypoint", "python" "-i", "--rm", "ghcr.io/githubsecuritylab/seclab-taskflow-agent", "toolboxes/mcp_servers/echo/echo.py"]
35+
```

0 commit comments

Comments
 (0)