refactor: replace .env.example with .env.template in documentation

- Remove volumes/env/.env.example file
- Update all documentation references to use .env.template instead
- Update bootstrap script error message
- Update .gitignore comment
This commit is contained in:
Songbird
2025-10-27 12:20:16 +01:00
committed by tduhamel42
parent 97d8af4c52
commit 8bf5e1bb77
9 changed files with 9 additions and 49 deletions

View File

@@ -115,7 +115,7 @@ For containerized workflows, see the [Docker Installation Guide](https://docs.do
For AI-powered workflows, configure your LLM API keys:
```bash
cp volumes/env/.env.example volumes/env/.env
cp volumes/env/.env.template volumes/env/.env
# Edit volumes/env/.env and add your API keys (OpenAI, Anthropic, Google, etc.)
# Add your key to LITELLM_GEMINI_API_KEY
```
@@ -152,7 +152,7 @@ git clone https://github.com/fuzzinglabs/fuzzforge_ai.git
cd fuzzforge_ai
# 2. Copy the default LLM env config
cp volumes/env/.env.example volumes/env/.env
cp volumes/env/.env.template volumes/env/.env
# 3. Start FuzzForge with Temporal
docker compose up -d

View File

@@ -149,7 +149,7 @@ def write_lines(path: Path, lines: Iterable[str]) -> None:
def read_env_file() -> list[str]:
if not ENV_FILE_PATH.exists():
raise FileNotFoundError(
f"Expected env file at {ENV_FILE_PATH}. Copy volumes/env/.env.example first."
f"Expected env file at {ENV_FILE_PATH}. Copy volumes/env/.env.template first."
)
return read_lines(ENV_FILE_PATH)

View File

@@ -225,7 +225,7 @@ docker compose up -d # All workers start
Set up AI workflows with API keys:
```bash
cp volumes/env/.env.example volumes/env/.env
cp volumes/env/.env.template volumes/env/.env
# Edit .env and add your API keys (OpenAI, Anthropic, etc.)
```

View File

@@ -171,7 +171,7 @@ FuzzForge requires `volumes/env/.env` to start. This file contains API keys and
```bash
# Copy the example file
cp volumes/env/.env.example volumes/env/.env
cp volumes/env/.env.template volumes/env/.env
# Edit to add your API keys (if using AI features)
nano volumes/env/.env

View File

@@ -16,7 +16,7 @@ container.
## Before You Start
1. Copy `volumes/env/.env.example` to `volumes/env/.env` and set the basics:
1. Copy `volumes/env/.env.template` to `volumes/env/.env` and set the basics:
- `LITELLM_MASTER_KEY` — admin token used to manage the proxy
- `LITELLM_SALT_KEY` — random string used to encrypt provider credentials
- Provider secrets under `LITELLM_<PROVIDER>_API_KEY` (for example

View File

@@ -33,7 +33,7 @@ The required `volumes/env/.env` file is missing. Docker Compose needs this file
**How to fix:**
```bash
# Create the environment file from the template
cp volumes/env/.env.example volumes/env/.env
cp volumes/env/.env.template volumes/env/.env
# Restart Docker Compose
docker compose -f docker-compose.yml down

View File

@@ -28,7 +28,7 @@ cd fuzzforge_ai
Create the environment configuration file:
```bash
cp volumes/env/.env.example volumes/env/.env
cp volumes/env/.env.template volumes/env/.env
```
This file is required for FuzzForge to start. You can leave it with default values if you're only using basic workflows.

View File

@@ -89,7 +89,7 @@ Technical reference materials and specifications.
Before starting FuzzForge, you **must** create the environment configuration file:
```bash
cp volumes/env/.env.example volumes/env/.env
cp volumes/env/.env.template volumes/env/.env
```
Docker Compose will fail without this file. You can leave it with default values if you're only using basic workflows (no AI features).

View File

@@ -1,40 +0,0 @@
# FuzzForge Agent Configuration
# Copy this to .env and configure your API keys and proxy settings
# LiteLLM Model Configuration (default routed through the proxy)
LITELLM_MODEL=openai/gpt-5
LITELLM_PROVIDER=openai
# Leave empty to let bootstrap mirror the LiteLLM model list dynamically.
LITELLM_DEFAULT_MODELS=
# Proxy configuration
# Base URL is used by the task agent to talk to the proxy container inside Docker.
# When running everything locally without Docker networking, replace with http://localhost:10999.
FF_LLM_PROXY_BASE_URL=http://llm-proxy:4000
# Virtual key placeholder. The bootstrap job replaces this with a LiteLLM
# proxy-issued key on startup so the task agent authenticates via the gateway.
OPENAI_API_KEY=sk-proxy-default
# LiteLLM proxy configuration
LITELLM_MASTER_KEY=sk-master-key
LITELLM_SALT_KEY=choose-a-random-string
# LiteLLM UI login (defaults to admin/fuzzforge123 if not overridden)
UI_USERNAME=fuzzforge
UI_PASSWORD=fuzzforge123
# Optional: override OTEL exporter endpoint if using a remote collector
# OTEL_EXPORTER_OTLP_ENDPOINT=http://otel-collector:4317
# LITELLM_DEFAULT_KEY_BUDGET=25
# LITELLM_DEFAULT_KEY_DURATION=7d
# Upstream provider secrets (ingested by the proxy only). The bootstrapper copies
# these into volumes/env/.env.litellm so other containers never see the raw keys.
# LITELLM_OPENAI_API_KEY=
# LITELLM_ANTHROPIC_API_KEY=
# LITELLM_GEMINI_API_KEY=
# LITELLM_MISTRAL_API_KEY=
# LITELLM_OPENROUTER_API_KEY=
# Agent behaviour
# DEFAULT_TIMEOUT=120
# DEFAULT_CONTEXT_ID=default