Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .env.example
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
# Application configuration
HOST_URL=http://localhost:4322 # The host URL and port number where the app is running.
AGENT_HOST_URL=http://localhost:4322 # The host URL and port number where the app is running.
APP_API_KEY=my_api_key # The API key to access the bot.
DATA_FOLDER_PATH=data # The path to the folder that will store the allocation data.

Expand Down
15 changes: 9 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The easiest way to run the Allocator Bot is using Docker:

```bash
docker run --rm -it --name allocator-bot \
-e HOST_URL=http://localhost:4322 \
-e AGENT_HOST_URL=http://localhost:4322 \
-e APP_API_KEY=your_api_key \
-e OPENROUTER_API_KEY=your_openrouter_key \
-e FMP_API_KEY=your_fmp_key \
Expand All @@ -57,16 +57,19 @@ docker run --rm -it --name allocator-bot \

**Required Environment Variables:**

- `HOST_URL`: The host URL where the app is running (e.g., `http://localhost:4322`)
- `AGENT_HOST_URL`: The host URL where the app is running (e.g., `http://localhost:4322`)
- `APP_API_KEY`: Your API key to access the bot
- `OPENROUTER_API_KEY`: Your OpenRouter API key for LLM access
- `FMP_API_KEY`: Your Financial Modeling Prep API key for market data

**Optional Environment Variables:**
**Storage Configuration (choose one):**

- `DATA_FOLDER_PATH`: Local storage path (default: `data`)
- `S3_ENABLED`: Enable S3 storage (default: `false`)
- `S3_ENDPOINT`, `S3_ACCESS_KEY`, `S3_SECRET_KEY`, `S3_BUCKET_NAME`: S3 configuration (if enabled)
When S3 is disabled (default), local storage is required:
- `DATA_FOLDER_PATH`: Local storage path for allocation data (required when `S3_ENABLED=false`)

When S3 is enabled:
- `S3_ENABLED`: Set to `true` to enable S3 storage
- `S3_ENDPOINT`, `S3_ACCESS_KEY`, `S3_SECRET_KEY`, `S3_BUCKET_NAME`: S3 configuration (all required when S3 enabled)

### Alternative Installation Methods

Expand Down