chore(config): add .env.example and overhaul README, DEPLOY, and RULES documentation
Introduce a complete `.env.example` covering Telegram, AI provider, proactive messaging, web search, and vision settings so new users can bootstrap configuration without reading the source. Rework README.md with a feature list, project structure, and variable reference tables; restructure DEPLOY.md with a table of contents, prerequisites, and env var tables; update RULES.md to declare English as the interface and documentation language and to document the `iniciar.sh` entry script. Also add docstrings to schedule and web search helpers and rename `schedule_data` to `schedule_answers` for consistency with the other wizard state variables.
This commit is contained in:
+106
@@ -0,0 +1,106 @@
|
||||
# =============================================================================
|
||||
# PsAgentAI - Environment Configuration Example
|
||||
# =============================================================================
|
||||
# Copy this file to .env and fill in your actual values:
|
||||
# cp .env.example .env
|
||||
# =============================================================================
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Telegram Configuration
|
||||
# -----------------------------------------------------------------------------
|
||||
# Get your bot token from @BotFather (https://t.me/BotFather)
|
||||
TELEGRAM_BOT_TOKEN=your_bot_token_here
|
||||
|
||||
# Your Telegram chat ID (the bot will send proactive messages to this chat)
|
||||
TELEGRAM_CHAT_ID=your_chat_id_here
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# AI Provider Configuration
|
||||
# -----------------------------------------------------------------------------
|
||||
# Provider: openrouter, stepfun, qwencloud or llamacpp
|
||||
AI_PROVIDER=openrouter
|
||||
|
||||
# Default model identifier (depends on the chosen provider)
|
||||
DEFAULT_MODEL=poolside/laguna-s-2.1:free
|
||||
|
||||
# Comma-separated fallback models if the primary fails
|
||||
FALLBACK_MODELS=poolside/laguna-s-2.1:free,google/gemini-2.0-flash-lite-preview-02-05:free
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# OpenRouter Configuration (https://openrouter.ai)
|
||||
# -----------------------------------------------------------------------------
|
||||
OPENROUTER_API_KEY=your_openrouter_key_here
|
||||
OPENROUTER_API_URL=https://openrouter.ai/api/v1
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# StepFun Configuration (https://platform.stepfun.com)
|
||||
# -----------------------------------------------------------------------------
|
||||
STEPFUN_API_KEY=your_stepfun_key_here
|
||||
STEPFUN_API_URL=https://api.stepfun.com/v1
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# QwenCloud Configuration (https://dashscope.aliyun.com)
|
||||
# -----------------------------------------------------------------------------
|
||||
QWENCLOUD_API_KEY=your_qwencloud_key_here
|
||||
QWENCLOUD_API_URL=https://dashscope.aliyuncs.com/compatible-mode/v1
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# llama.cpp Configuration (local server)
|
||||
# -----------------------------------------------------------------------------
|
||||
# URL of your local llama.cpp server (OpenAI-compatible endpoint)
|
||||
LLAMA_CPP_API_URL=http://localhost:8080/v1
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Proactive Messaging
|
||||
# -----------------------------------------------------------------------------
|
||||
# Minimum and maximum interval between proactive messages (minutes)
|
||||
MIN_INTERVAL_MINUTES=3
|
||||
MAX_INTERVAL_MINUTES=30
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Context and History
|
||||
# -----------------------------------------------------------------------------
|
||||
# Maximum number of messages kept in conversation context
|
||||
MAX_HISTORY_LENGTH=50
|
||||
|
||||
# Maximum characters from uploaded files sent to AI (0 = no truncation)
|
||||
UPLOAD_CONTEXT_MAX_CHARS=8000
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Web Search
|
||||
# -----------------------------------------------------------------------------
|
||||
# Enable automatic web search when the agent detects an information need
|
||||
WEB_SEARCH_ENABLED=true
|
||||
|
||||
# Maximum number of search results to include in context
|
||||
WEB_SEARCH_MAX_RESULTS=5
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Vision / Image Analysis
|
||||
# -----------------------------------------------------------------------------
|
||||
# Model used for image analysis
|
||||
VISION_MODEL=meta-llama/llama-4-maverick-17b-128b-instruct
|
||||
|
||||
# Provider for the vision model (leave empty to auto-detect from model)
|
||||
VISION_PROVIDER=
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Agent Behavior
|
||||
# -----------------------------------------------------------------------------
|
||||
# Minimum number of lines per agent message
|
||||
MIN_MESSAGE_LINES=3
|
||||
|
||||
# Auto-enrich user/agent profiles every N messages (0 = disabled)
|
||||
AUTO_ENRICH_EVERY=2
|
||||
|
||||
# Auto-improve system every N messages (0 = disabled)
|
||||
AUTO_IMPROVE_ENABLED=true
|
||||
AUTO_IMPROVE_EVERY=20
|
||||
|
||||
# -----------------------------------------------------------------------------
|
||||
# Persistence
|
||||
# -----------------------------------------------------------------------------
|
||||
# File paths for profiles and contexts (relative to app directory)
|
||||
USER_PROFILE_FILE=user_profile.json
|
||||
AGENT_PROFILE_FILE=agent_profile.json
|
||||
CONTEXTS_DIR=contexts
|
||||
Reference in New Issue
Block a user