diff --git a/README.md b/README.md index abc2c14..4eb2028 100644 --- a/README.md +++ b/README.md @@ -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 diff --git a/docker/scripts/bootstrap_llm_proxy.py b/docker/scripts/bootstrap_llm_proxy.py index feb7d21..68f6745 100644 --- a/docker/scripts/bootstrap_llm_proxy.py +++ b/docker/scripts/bootstrap_llm_proxy.py @@ -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) diff --git a/docs/blog/2025-01-16-v0.7.0-temporal-workers-release.md b/docs/blog/2025-01-16-v0.7.0-temporal-workers-release.md index ef8a641..329ca7a 100644 --- a/docs/blog/2025-01-16-v0.7.0-temporal-workers-release.md +++ b/docs/blog/2025-01-16-v0.7.0-temporal-workers-release.md @@ -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.) ``` diff --git a/docs/docs/how-to/docker-setup.md b/docs/docs/how-to/docker-setup.md index 39c0de9..471f945 100644 --- a/docs/docs/how-to/docker-setup.md +++ b/docs/docs/how-to/docker-setup.md @@ -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 diff --git a/docs/docs/how-to/llm-proxy.md b/docs/docs/how-to/llm-proxy.md index 0892569..4d6a0db 100644 --- a/docs/docs/how-to/llm-proxy.md +++ b/docs/docs/how-to/llm-proxy.md @@ -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__API_KEY` (for example diff --git a/docs/docs/how-to/troubleshooting.md b/docs/docs/how-to/troubleshooting.md index 8784ef3..7554eda 100644 --- a/docs/docs/how-to/troubleshooting.md +++ b/docs/docs/how-to/troubleshooting.md @@ -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 diff --git a/docs/docs/tutorial/getting-started.md b/docs/docs/tutorial/getting-started.md index 2049963..473ab55 100644 --- a/docs/docs/tutorial/getting-started.md +++ b/docs/docs/tutorial/getting-started.md @@ -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. diff --git a/docs/index.md b/docs/index.md index dc0a13e..7d2cd85 100644 --- a/docs/index.md +++ b/docs/index.md @@ -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). diff --git a/volumes/env/.env.example b/volumes/env/.env.example deleted file mode 100644 index ad5f1ed..0000000 --- a/volumes/env/.env.example +++ /dev/null @@ -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