armistace/steward_mirror
1
0
Fork 0
Code Issues Pull Requests 1 Actions Packages Projects Releases Wiki Activity

docs: simplify .env.example to show only required settings

Browse Source 
Only include the 4 required environment variables:
- STEWARD__TELEGRAM__BOT_TOKEN
- STEWARD__OPENAI__API_KEY
- STEWARD__TELEGRAM__ALLOWED_USER_IDS
- STEWARD__TELEGRAM__GROUP_IDS

All other settings have sensible defaults in config_schema.yaml and can be
overridden if needed. This keeps the example file clean and focused.
This commit is contained in:
Daniel Wagner 2026-07-26 12:39:11 +10:00
parent d5eac108f8
commit d0ccc96507
1 changed files with 22 additions and 32 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

54
.env.example
View File

@ -2,41 +2,31 @@
# Never commit .env to version control. # Never commit .env to version control.
# Telegram bot token from @BotFather # Telegram bot token from @BotFather
STEWARD__TELEGRAM__BOT_TOKEN= TELEGRAM_BOT_TOKEN=
# List of user IDs allowed to interact via DM (JSON format, empty = all users) # Comma-separated Telegram user IDs allowed to talk to Steward.
STEWARD__TELEGRAM__ALLOWED_USER_IDS='[1234567890]' # Leave empty to allow everyone (not recommended for production).
TELEGRAM_ALLOWED_USER_IDS=
# List of group/channel IDs where bot operates (JSON format, empty = all groups) # OpenAI (or compatible) credentials
STEWARD__TELEGRAM__GROUP_IDS='[-1005308306472]' OPENAI_API_KEY=
OPENAI_BASE_URL=https://api.openai.com/v1
OPENAI_MODEL=gpt-4o
# OpenAI API key # Optional: override the default system prompt
STEWARD__OPENAI__API_KEY= # OPENAI_SYSTEM_PROMPT=
# OpenAI API base URL (can use any OpenAI-compatible provider) # Daily analysis target (optional)
STEWARD__OPENAI__BASE_URL=https://api.openai.com/v1 # ANALYSIS_TARGET_URL=https://your-internal-api/endpoint
# ANALYSIS_TARGET_API_KEY=
# ANALYSIS_CRON_HOUR=8
# ANALYSIS_CRON_MINUTE=0
# Model to use # Thread memory store path (JSON file for persisted thread summaries)
STEWARD__OPENAI__MODEL=gpt-4o # THREAD_MEMORY_PATH=thread_memory.json
# Optional: Custom system prompt for the LLM # MCP / OpenAPI tool server (open-webui/openapi-servers compatible)
# STEWARD__OPENAI__SYSTEM_PROMPT="You are Steward..." # Point to any OpenAPI-spec tool server to enable LLM tool calling.
# The service fetches /openapi.json from MCP_SERVER_URL to discover tools.
# Optional: Target URL for API analysis # MCP_SERVER_URL=http://localhost:8000
STEWARD__ANALYSIS__TARGET_URL= # MCP_SERVER_API_KEY=
# Optional: API key for analysis target
STEWARD__ANALYSIS__TARGET_API_KEY=
# Cron schedule for automatic analysis
STEWARD__ANALYSIS__CRON_HOUR=8
STEWARD__ANALYSIS__CRON_MINUTE=0
# Path to thread memory storage (use absolute path in containers)
STEWARD__MEMORY__THREAD_MEMORY_PATH=/data/thread_memory.json
# Optional: MCP/OpenAPI tool server URL
STEWARD__TOOLS__MCP_SERVER_URL=
# Optional: API key for MCP server
STEWARD__TOOLS__MCP_SERVER_API_KEY=