From 63751f7c5c0139db2b208da84db51ba827e1e4bd Mon Sep 17 00:00:00 2001 From: aserrador Date: Fri, 3 Apr 2026 12:55:26 -0500 Subject: [PATCH] Update documentation: fix env syntax, add bot and MCP services, add ports table --- .env.example | 6 +++--- README.md | 31 ++++++++++++++++++++++++++++++- 2 files changed, 33 insertions(+), 4 deletions(-) diff --git a/.env.example b/.env.example index 3949054..7a2fbb7 100644 --- a/.env.example +++ b/.env.example @@ -1,7 +1,7 @@ # Naliia Images -NALIIA = "gitea.onecluster.org/oneteam/naliia:1.0.0_pro" -NALIIA_BOT = "gitea.onecluster.org/oneteam/naliia_bot:v1.0.0_pro" -NALIIA_TRYTON_MCP = "gitea.onecluster.org/oneteam/naliia_tryton_mcp:v1.0.0_pro" +NALIIA="gitea.onecluster.org/oneteam/naliia:1.0.0_pro" +NALIIA_BOT="gitea.onecluster.org/oneteam/naliia_bot:v1.0.0_pro" +NALIIA_TRYTON_MCP="gitea.onecluster.org/oneteam/naliia_tryton_mcp:v1.0.0_pro" # Tryton EMAIL="admin@admin.org" diff --git a/README.md b/README.md index 93b21ae..d760e0f 100644 --- a/README.md +++ b/README.md @@ -42,6 +42,14 @@ The application consists of multiple Docker services: ┌─────────────┐ │ Cron │ Scheduled tasks └─────────────┘ + +┌─────────────┐ +│ Bot │ AI Bot service (Port 8010) +└─────────────┘ + +┌─────────────┐ +│tryton_mcp │ Tryton MCP server (Port 3001) +└─────────────┘ ``` ### Services @@ -51,6 +59,8 @@ The application consists of multiple Docker services: - **worker**: Background worker for async tasks - **cron**: Scheduled task runner - **nginx**: Reverse proxy handling external requests +- **bot**: AI Bot service with LLM integration +- **tryton_mcp**: Tryton MCP server for AI integration ## Project Structure @@ -77,7 +87,9 @@ Copy `.env.example` to `.env` and configure the following variables: | Variable | Description | Default | |----------|-------------|---------| -| `NALIIA_IMAGE` | Docker image for Tryton | `gitea.onecluster.org/oneteam/naliia:1.0.0_pro` | +| `NALIIA` | Docker image for Tryton | `gitea.onecluster.org/oneteam/naliia:1.0.0_pro` | +| `NALIIA_BOT` | Docker image for Bot | `gitea.onecluster.org/oneteam/naliia_bot:v1.0.0_pro` | +| `NALIIA_TRYTON_MCP` | Docker image for Tryton MCP | `gitea.onecluster.org/oneteam/naliia_tryton_mcp:v1.0.0_pro` | | `DB_HOSTNAME` | Database hostname | `db` | | `POSTGRES_DB` | Database name | `database` | | `POSTGRES_USER` | Database user | `postgres` | @@ -87,8 +99,25 @@ Copy `.env.example` to `.env` and configure the following variables: | `TRYTON_PORT` | Tryton server port | `8000` | | `SERVER_NAME` | Domain name for Nginx | `tryton.domain.com` | | `NGINX_PORT` | Nginx listening port | `10000` | +| `DEEPSEEK_API_KEY` | DeepSeek API key for Bot | `sk-...` | +| `ANTHROPIC_API_KEY` | Anthropic API key for Bot | `sk-...` | +| `LLM_MODEL` | LLM model to use | `deepseek` | +| `TRYTON_HOSTNAME` | Tryton hostname for MCP | `tryton` | +| `TRYTON_DATABASE` | Tryton database for MCP | `naliia` | +| `TRYTON_USERNAME` | Tryton username for MCP | `admin` | +| `TRYTON_PASSWORD` | Tryton password for MCP | `S0p0rt3f1n4l*` | +| `MCP_PORT` | MCP server port | `3001` | | `SMTP_*` | SMTP configuration for email | See `.env.example` | +### Ports + +| Service | Port | Description | +|---------|------|-------------| +| Nginx | 10000 | Reverse proxy (configurable) | +| Tryton | 8000 | Tryton server | +| Bot | 8010 | AI Bot service | +| MCP | 3001 | Tryton MCP server | + ### SMTP Configuration Configure SMTP settings for email notifications: