Skip to content

Commit f200cb6

Browse files
committed
docs: add worker startup instructions to quickstart and tutorial
1 parent a72a007 commit f200cb6

File tree

2 files changed

+22
-2
lines changed

2 files changed

+22
-2
lines changed

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -154,12 +154,17 @@ cp volumes/env/.env.example volumes/env/.env
154154

155155
# 3. Start FuzzForge with Temporal
156156
docker compose up -d
157+
158+
# 4. Start the Python worker (needed for security_assessment workflow)
159+
docker compose up -d worker-python
157160
```
158161

159162
> The first launch can take 2-3 minutes for services to initialize ☕
163+
>
164+
> Workers don't auto-start by default (saves RAM). Start the worker you need before running workflows.
160165
161166
```bash
162-
# 3. Run your first workflow (files are automatically uploaded)
167+
# 5. Run your first workflow (files are automatically uploaded)
163168
cd test_projects/vulnerable_app/
164169
fuzzforge init # Initialize FuzzForge project
165170
ff workflow run security_assessment . # Start workflow - CLI uploads files automatically!
@@ -172,7 +177,7 @@ ff workflow run security_assessment . # Start workflow - CLI uploads files au
172177
```
173178

174179
**What's running:**
175-
- **Temporal**: Workflow orchestration (UI at http://localhost:8233)
180+
- **Temporal**: Workflow orchestration (UI at http://localhost:8080)
176181
- **MinIO**: File storage for targets (Console at http://localhost:9001)
177182
- **Vertical Workers**: Pre-built workers with security toolchains
178183
- **Backend API**: FuzzForge REST API (http://localhost:8000)

docs/docs/tutorial/getting-started.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -89,6 +89,21 @@ curl http://localhost:8000/health
8989
# Should return: {"status":"healthy"}
9090
```
9191

92+
### Start the Python Worker
93+
94+
Workers don't auto-start by default (saves RAM). Start the Python worker for your first workflow:
95+
96+
```bash
97+
# Start the Python worker
98+
docker compose up -d worker-python
99+
100+
# Verify it's running
101+
docker compose ps worker-python
102+
# Should show: Up (healthy)
103+
```
104+
105+
**Note:** Workers use Docker Compose profiles and only start when needed. For your first workflow run, it's safer to start the worker manually. Later, the CLI can auto-start workers on demand.
106+
92107
## Step 4: Install the CLI (Optional but Recommended)
93108

94109
Install the FuzzForge CLI for easier workflow management:

0 commit comments

Comments
 (0)