CalvinBackup/shannon
1
0
Fork 0
mirror of https://github.com/KeygraphHQ/shannon.git synced 2026-02-12 17:22:50 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: mount repos and configs directories into worker container (#107)

Browse Source 
* feat: use static repos/ folder mount instead of dynamic TARGET_REPO

Replace dynamic per-run TARGET_REPO bind mount with a static ./repos:/repos
mount. Users place target repositories under ./repos/ and reference them by
folder name. This fixes stale mounts when switching targets and enables
running multiple scans concurrently against different repos.

* feat: mount configs directory into worker container

* docs: add instructions for repos and configs directory setup
This commit is contained in:
ezl-keygraph
2026-02-10 00:05:41 +05:30
committed by GitHub
parent 9bfbf1c3ec
commit b05c505e75
7 changed files with 40 additions and 32 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
README.md
View File

@@ -128,7 +128,7 @@ CLAUDE_CODE_MAX_OUTPUT_TOKENS=64000
EOF
# 3. Run a pentest
./shannon start URL=https://your-app.com REPO=/path/to/your/repo
./shannon start URL=https://your-app.com REPO=your-repo
```
Shannon will build the containers, start the workflow, and return a workflow ID. The pentest runs in the background.
@@ -160,33 +160,34 @@ open http://localhost:8233
```bash
# Basic pentest
./shannon start URL=https://example.com REPO=/path/to/repo
./shannon start URL=https://example.com REPO=repo-name
# With a configuration file
./shannon start URL=https://example.com REPO=/path/to/repo CONFIG=./configs/my-config.yaml
./shannon start URL=https://example.com REPO=repo-name CONFIG=./configs/my-config.yaml
# Custom output directory
./shannon start URL=https://example.com REPO=/path/to/repo OUTPUT=./my-reports
./shannon start URL=https://example.com REPO=repo-name OUTPUT=./my-reports
```
### Prepare Your Repository
Shannon is designed for **web application security testing** and expects all application code to be available in a single directory structure. This works well for:
Shannon expects target repositories to be placed under the `./repos/` directory at the project root. The `REPO` flag refers to a folder name inside `./repos/`. Copy the repository you want to scan into `./repos/`, or clone it directly there:
- **Monorepos** - Single repository containing all components
- **Consolidated setups** - Multiple repositories organized in a shared folder
```bash
git clone https://github.com/your-org/your-repo.git ./repos/your-repo
```
**For monorepos:**
```bash
git clone https://github.com/your-org/your-monorepo.git /path/to/your-app
git clone https://github.com/your-org/your-monorepo.git ./repos/your-monorepo
```
**For multi-repository applications** (e.g., separate frontend/backend):
```bash
mkdir /path/to/your-app
cd /path/to/your-app
mkdir ./repos/your-app
cd ./repos/your-app
git clone https://github.com/your-org/frontend.git
git clone https://github.com/your-org/backend.git
git clone https://github.com/your-org/api.git
@@ -207,12 +208,12 @@ Works out of the box with Docker Desktop installed.
Docker containers cannot reach `localhost` on your host machine. Use `host.docker.internal` in place of `localhost`:
```bash
./shannon start URL=http://host.docker.internal:3000 REPO=/path/to/repo
./shannon start URL=http://host.docker.internal:3000 REPO=repo-name
```
### Configuration (Optional)
While you can run without a config file, creating one enables authenticated testing and customized analysis.
While you can run without a config file, creating one enables authenticated testing and customized analysis. Place your configuration files inside the `./configs/` directory — this folder is mounted into the Docker container automatically.
#### Create Configuration File
@@ -281,7 +282,7 @@ ROUTER_DEFAULT=openai,gpt-5.2 # provider,model format
2. Run with `ROUTER=true`:
```bash
./shannon start URL=https://example.com REPO=/path/to/repo ROUTER=true
./shannon start URL=https://example.com REPO=repo-name ROUTER=true
```
#### Experimental Models