docs: add worker startup instructions to quickstart and tutorial

This commit is contained in:
tduhamel42
2025-10-17 11:46:40 +02:00
parent a72a0072df
commit f200cb6fb7
2 changed files with 22 additions and 2 deletions

View File

@@ -154,12 +154,17 @@ cp volumes/env/.env.example volumes/env/.env
# 3. Start FuzzForge with Temporal
docker compose up -d
# 4. Start the Python worker (needed for security_assessment workflow)
docker compose up -d worker-python
```
> The first launch can take 2-3 minutes for services to initialize ☕
>
> Workers don't auto-start by default (saves RAM). Start the worker you need before running workflows.
```bash
# 3. Run your first workflow (files are automatically uploaded)
# 5. Run your first workflow (files are automatically uploaded)
cd test_projects/vulnerable_app/
fuzzforge init # Initialize FuzzForge project
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
```
**What's running:**
- **Temporal**: Workflow orchestration (UI at http://localhost:8233)
- **Temporal**: Workflow orchestration (UI at http://localhost:8080)
- **MinIO**: File storage for targets (Console at http://localhost:9001)
- **Vertical Workers**: Pre-built workers with security toolchains
- **Backend API**: FuzzForge REST API (http://localhost:8000)

View File

@@ -89,6 +89,21 @@ curl http://localhost:8000/health
# Should return: {"status":"healthy"}
```
### Start the Python Worker
Workers don't auto-start by default (saves RAM). Start the Python worker for your first workflow:
```bash
# Start the Python worker
docker compose up -d worker-python
# Verify it's running
docker compose ps worker-python
# Should show: Up (healthy)
```
**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.
## Step 4: Install the CLI (Optional but Recommended)
Install the FuzzForge CLI for easier workflow management: