marcocosta10000/PsAgentAI
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

chore(config): add .env.example and overhaul README, DEPLOY, and RULES documentation

Browse Source 
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:
marcocosta10000
2026-10-26 14:25:47 -03:00
parent 9848120a1a
commit fd136db535
6 changed files with 2588 additions and 187 deletions
Download Patch File Download Diff File Expand all files Collapse all files
DEPLOY.md
+258 -95
View File
@@ -1,17 +1,38 @@
# PsAgentAI - Server Deployment
Deploy as a systemd service on Debian/Ubuntu to run 24/7 on a VPS.
Deploy PsAgentAI as a systemd service on Debian/Ubuntu to run 24/7 on a VPS.
## Table of Contents
1. [Prerequisites](#prerequisites)
2. [Copy Project to Server](#1-copy-project-to-server)
3. [Configure Environment](#2-configure-environment)
4. [Install Dependencies](#3-install-dependencies)
5. [Install systemd Service](#4-install-systemd-service)
6. [Service Management](#5-service-management)
7. [Updates](#6-updates)
8. [Multi-User Deployment](#7-multi-user-deployment)
9. [Environment Variables Reference](#8-environment-variables-reference)
10. [Backups](#9-backups)
11. [Security](#10-security)
---
## Prerequisites on the server
## Prerequisites
A fresh Debian/Ubuntu server with:
- `python3`, `python3-venv`, `python3-pip`
- `git` (if cloning from repository)
- `ffmpeg` (for voice message processing)
- `systemd-journal-remote` (optional, for persistent logs)
```bash
sudo apt update
sudo apt install -y python3 python3-venv python3-pip git ffmpeg
```
Enable journal if you want persistent logs (optional):
Optional: enable persistent journal logs:
```bash
sudo apt install -y systemd-journal-remote
@@ -19,9 +40,9 @@ sudo apt install -y systemd-journal-remote
---
## 1) Copy the project to the server
## 1) Copy Project to Server
Use git or scp/rsync. Example with git:
### Using git
```bash
cd /opt
@@ -30,77 +51,92 @@ sudo chown -R $USER:$USER /opt/psagentai
cd /opt/psagentai/app
```
Adjust the path in the systemd service to the real directory:
### Using scp/rsync
```bash
nano psagentai.service
# change /home/marco/PsAgentAI/app to /opt/psagentai/app
# From your local machine:
scp -r psagentai/ user@server:/opt/psagentai/
```
> The service uses `User=marco` by default. Create the user if it doesn't exist:
> ```bash
> sudo useradd -m -s /bin/bash marco || true
> sudo usermod -aG sudo marco
> ```
> Or edit `User=` in the `.service` to an existing user on your VPS.
Adjust paths in the systemd service file to match your actual installation directory.
---
## 2) Configure `.env`
## 2) Configure Environment
```bash
cp .env.example .env # if example exists
# If .env.example exists, copy it:
cp .env.example .env
# Otherwise create .env manually:
nano .env
```
Fill in the required fields:
### Required settings
- `TELEGRAM_BOT_TOKEN`
- `TELEGRAM_CHAT_ID`
- `AI_PROVIDER` (`openrouter`, `stepfun`, `qwencloud` or `llamacpp`)
- `DEFAULT_MODEL`
- at least the AI key corresponding to the chosen provider
| Variable | Description |
|---|---|
| `TELEGRAM_BOT_TOKEN` | Token from @BotFather |
| `TELEGRAM_CHAT_ID` | Your Telegram chat ID |
| `AI_PROVIDER` | `openrouter`, `stepfun`, `qwencloud` or `llamacpp` |
| `DEFAULT_MODEL` | Model identifier for the chosen provider |
| `OPENROUTER_API_KEY` or `STEPFUN_API_KEY` or `QWENCLOUD_API_KEY` | At least one AI provider key |
Optionally adjust:
### Optional settings
- `MIN_INTERVAL_MINUTES` / `MAX_INTERVAL_MINUTES`
- `MIN_MESSAGE_LINES`
| Variable | Default | Description |
|---|---|---|
| `MIN_INTERVAL_MINUTES` | `3` | Minimum minutes between proactive messages |
| `MAX_INTERVAL_MINUTES` | `30` | Maximum minutes between proactive messages |
| `MIN_MESSAGE_LINES` | `3` | Minimum lines per agent message |
| `WEB_SEARCH_ENABLED` | `true` | Enable automatic web search |
| `WEB_SEARCH_MAX_RESULTS` | `5` | Max web search results |
| `VISION_MODEL` | `meta-llama/llama-4-maverick-17b-128b-instruct` | Vision model |
| `VISION_PROVIDER` | auto | Vision provider |
| `AUTO_ENRICH_EVERY` | `2` | Profile auto-enrichment frequency (`0` = disabled) |
| `AUTO_IMPROVE_EVERY` | `20` | Auto-improvement frequency (`0` = disabled) |
| `UPLOAD_CONTEXT_MAX_CHARS` | `8000` | Upload context limit (`0` = unlimited) |
> Important: on Telegram, send `/start` once to the bot before turning on the service, otherwise it won't be able to send starting messages.
> **Important**: Before starting the service, send `/start` once to the bot in Telegram. This allows the bot to resolve the chat and send proactive messages later.
---
## 3) Install dependencies
## 3) Install Dependencies
```bash
# Install system dependency for voice processing
sudo apt install -y ffmpeg
```bash
# Make setup script executable and run it
chmod +x iniciar.sh
./iniciar.sh
```
This script creates the `venv`, installs dependencies and validates the `.env` variables.
The setup script will:
1. Create a Python virtual environment (`venv/`)
2. Upgrade `pip`
3. Install Python dependencies from `requirements.txt`
4. Validate `.env` configuration
5. Start the agent
If the above command doesn't install the expected `ffmpeg` version, also use:
If `ffmpeg` was not installed by the system package manager, install it separately:
```bash
sudo apt install -y ffmpeg
```
> Voice recognition uses `SpeechRecognition` + `pydub` + `ffmpeg`.
> Voice recognition requires `SpeechRecognition` + `pydub` + `ffmpeg`.
---
## 4) Install the systemd service
## 4) Install systemd Service
Create the service file:
```bash
# absolute path on your server
sudo nano /etc/systemd/system/psagentai.service
```
Minimum content:
```ini
[Unit]
Description=PsAgentAI
@@ -109,6 +145,7 @@ After=network.target
[Service]
Type=simple
User=marco
Group=marco
WorkingDirectory=/opt/psagentai/app
Environment="PATH=/opt/psagentai/app/venv/bin:/usr/local/bin:/usr/bin:/bin"
ExecStart=/opt/psagentai/app/venv/bin/python3 /opt/psagentai/app/psagentai_agent.py
@@ -121,7 +158,21 @@ StandardError=journal
WantedBy=multi-user.target
```
Enable and start:
Adjust the following to match your setup:
- `User=` and `Group=` — the user that will run the service
- `WorkingDirectory=` — absolute path to the `app/` directory
- `ExecStart=` — absolute path to the Python executable and agent script
Create the service user if needed:
```bash
sudo useradd -m -s /bin/bash marco || true
sudo usermod -aG sudo marco
```
Or change `User=` and `Group=` to an existing user on your VPS.
Reload systemd and enable the service:
```bash
sudo systemctl daemon-reload
@@ -131,25 +182,28 @@ sudo systemctl start psagentai
---
## 5) Useful commands
## 5) Service Management
```bash
# status
# Check status
sudo systemctl status psagentai
# real-time logs
# View real-time logs
sudo journalctl -u psagentai -f
# restart after update
# Stop the service
sudo systemctl stop psagentai
# Restart after changes
sudo systemctl restart psagentai
# stop
sudo systemctl stop psagentai
# Disable auto-start
sudo systemctl disable psagentai
```
---
## 6) Future updates
## 6) Updates
```bash
cd /opt/psagentai/app
@@ -160,80 +214,189 @@ sudo systemctl restart psagentai
---
## 7) Multiple users / VPSs
## 7) Multi-User Deployment
Each system instance is independent by Telegram chat ID.
Each PsAgentAI instance is independent by Telegram chat ID. To run multiple instances:
For each new user/VPS:
1. Create a separate bot via [@BotFather](https://t.me/BotFather) (`/newbot`) for each user
2. Copy the project to a separate directory for each instance, e.g.:
- `/opt/psagentai-user1/`
- `/opt/psagentai-user2/`
3. Create a dedicated `.env` for each instance with its own `TELEGRAM_BOT_TOKEN`, `TELEGRAM_CHAT_ID`, and AI keys
4. Run `./iniciar.sh` in each directory to set up the environment
5. Create a separate systemd service file for each instance:
1. Create the bot via @BotFather (`/newbot`) and get the token.
2. Copy the project to a separate directory, for example `/opt/psagentai-user2`.
3. Create your own `.env` with `TELEGRAM_BOT_TOKEN`, `TELEGRAM_CHAT_ID` and your AI keys.
4. Install dependencies with `./iniciar.sh`.
5. Create a separate systemd service, ex: `psagentai-user2.service`, pointing to that directory.
6. Enable and start.
```bash
# Example for user2
sudo nano /etc/systemd/system/psagentai-user2.service
```
Recommended names to avoid conflicts:
```ini
[Unit]
Description=PsAgentAI - User 2
After=network.target
- `/opt/psagentai-user1/`, `/opt/psagentai-user2/`
- `psagentai-user1.service`, `psagentai-user2.service`
[Service]
Type=simple
User=marco
Group=marco
WorkingDirectory=/opt/psagentai-user2/app
Environment="PATH=/opt/psagentai-user2/app/venv/bin:/usr/local/bin:/usr/bin:/bin"
ExecStart=/opt/psagentai-user2/app/venv/bin/python3 /opt/psagentai-user2/app/psagentai_agent.py
Restart=always
RestartSec=10
StandardOutput=journal
StandardError=journal
[Install]
WantedBy=multi-user.target
```
6. Enable and start each service:
```bash
sudo systemctl daemon-reload
sudo systemctl enable psagentai-user2
sudo systemctl start psagentai-user2
```
Recommended naming convention to avoid conflicts:
- Directories: `/opt/psagentai-user1/`, `/opt/psagentai-user2/`
- Services: `psagentai-user1.service`, `psagentai-user2.service`
---
## 8) `.env` variables
## 8) Environment Variables Reference
### Telegram
| Variable | Required | Description |
|---|---|---|
| `AI_PROVIDER` | no | Preferred provider: `openrouter`, `stepfun`, `qwencloud` or `llamacpp` |
| `TELEGRAM_BOT_TOKEN` | yes | Telegram bot token |
| `TELEGRAM_CHAT_ID` | yes | User chat ID |
| `DEFAULT_MODEL` | yes | Default AI model |
| `OPENROUTER_API_KEY` | 1 of the keys | OpenRouter key |
| `STEPFUN_API_KEY` | 1 of the keys | StepFun key |
| `QWENCLOUD_API_KEY` | 1 of the keys | QwenCloud key |
| `MIN_INTERVAL_MINUTES` | no | Minimum interval for proactive messages |
| `MAX_INTERVAL_MINUTES` | no | Maximum interval for proactive messages |
| `MIN_MESSAGE_LINES` | no | Minimum lines per agent message |
| `AUTO_ENRICH_EVERY` | no | Enriches profile every N messages |
| `AUTO_IMPROVE_EVERY` | no | Auto improvement every N messages |
| `UPLOAD_CONTEXT_MAX_CHARS` | no | Character limit of upload sent to AI (`0` = no limit) |
| `VISION_MODEL` | no | AI model for image analysis |
| `VISION_PROVIDER` | no | Vision model provider (`openrouter`, `stepfun`, `qwencloud`) |
| `TELEGRAM_BOT_TOKEN` | Yes | Telegram bot token from @BotFather |
| `TELEGRAM_CHAT_ID` | Yes | Target chat ID for proactive messages |
### AI Providers
| Variable | Required | Description |
|---|---|---|
| `AI_PROVIDER` | Yes | Preferred provider: `openrouter`, `stepfun`, `qwencloud` or `llamacpp` |
| `DEFAULT_MODEL` | Yes | Model identifier (provider-specific) |
| `OPENROUTER_API_KEY` | Conditional | Required for OpenRouter |
| `OPENROUTER_API_URL` | No | OpenRouter API base URL |
| `STEPFUN_API_KEY` | Conditional | Required for StepFun |
| `STEPFUN_API_URL` | No | StepFun API base URL |
| `QWENCLOUD_API_KEY` | Conditional | Required for QwenCloud |
| `QWENCLOUD_API_URL` | No | QwenCloud API base URL |
| `LLAMA_CPP_API_URL` | No | llama.cpp server URL (default: `http://localhost:8080/v1`) |
| `FALLBACK_MODELS` | No | Comma-separated fallback models |
### Behavior Tuning
| Variable | Default | Description |
|---|---|---|
| `MIN_INTERVAL_MINUTES` | `3` | Minimum minutes between proactive messages |
| `MAX_INTERVAL_MINUTES` | `30` | Maximum minutes between proactive messages |
| `MIN_MESSAGE_LINES` | `3` | Minimum lines per agent message |
| `MAX_HISTORY_LENGTH` | `50` | Max messages in conversation context |
| `UPLOAD_CONTEXT_MAX_CHARS` | `8000` | Max chars from uploads sent to AI (`0` = unlimited) |
| `WEB_SEARCH_ENABLED` | `true` | Enable automatic web search |
| `WEB_SEARCH_MAX_RESULTS` | `5` | Maximum search results returned |
| `AUTO_ENRICH_EVERY` | `2` | Auto-enrich profiles every N messages (`0` = disabled) |
| `AUTO_IMPROVE_EVERY` | `20` | Auto-improve system every N messages (`0` = disabled) |
### Vision / Image Analysis
| Variable | Default | Description |
|---|---|---|
| `VISION_MODEL` | `meta-llama/llama-4-maverick-17b-128b-instruct` | Model for image analysis |
| `VISION_PROVIDER` | auto | Provider for vision model |
### Persistence
| Variable | Default | Description |
|---|---|---|
| `USER_PROFILE_FILE` | `user_profile.json` | User profile file path |
| `AGENT_PROFILE_FILE` | `agent_profile.json` | Agent profile file path |
| `CONTEXTS_DIR` | `contexts` | Conversation context directory |
---
## Useful commands via Telegram
## 9) Backups
- `/viewai` — shows current AI provider and model
- `/configai` — interactively configures AI provider and model
- `/viewvision` — shows current vision provider and model
- `/configvision` — interactively configures vision model
- `/about` — displays system information, version, author and license
Regularly back up the data files in the `app/` directory:
---
- `user_profile.json` — user profile data
- `agent_profile.json` — agent personality and traits
- `system_improvements.json` — auto-improvement history
- `uploads_metadata.json` — uploaded files index
- `config.json` — schedule configuration
- `contexts/` — conversation history by date
- `workspace/` — created and edited files
## 9) Important backups
Regularly backup the data files inside `/app`:
- `user_profile.json`
- `agent_profile.json`
- `system_improvements.json`
- `uploads_metadata.json`
- `contexts/` folder
- `workspace/` folder
Simple daily backup example:
### Daily backup example
```bash
tar czf /root/backups/psagentai-$(date +%F).tar.gz -C /opt/psagentai/app user_profile.json agent_profile.json system_improvements.json uploads_metadata.json contexts workspace
# Create backups directory
sudo mkdir -p /root/backups
# Run daily backup
BACKUP_FILE="/root/backups/psagentai-$(date +%F).tar.gz"
tar czf "$BACKUP_FILE" -C /opt/psagentai/app \
user_profile.json \
agent_profile.json \
system_improvements.json \
uploads_metadata.json \
config.json \
contexts \
workspace
echo "Backup created: $BACKUP_FILE"
```
### Automated backup with cron
```bash
sudo crontab -e
```
Add:
```cron
0 2 * * * /usr/bin/tar czf /root/backups/psagentai-$(date +\%F).tar.gz -C /opt/psagentai/app user_profile.json agent_profile.json system_improvements.json uploads_metadata.json config.json contexts workspace
```
This creates a backup every day at 2:00 AM.
---
## 10) Security
- Never commit `.env` to the repository.
- Restrict permissions: `chmod 600 .env`.
- Use an exclusive user for each service instance.
- For greater isolation, run each instance in a separate Docker container or on distinct VMs.
- **Never commit `.env`** to version control. Add it to `.gitignore`.
- **Restrict permissions**: `chmod 600 .env` to prevent other users from reading secrets.
- **Use dedicated users**: Run each instance under its own system user for isolation.
- **Firewall**: Only expose necessary ports (typically only outbound HTTPS is needed).
- **API keys**: Rotate keys periodically and monitor usage for anomalies.
- **Path validation**: The agent validates file paths to prevent directory traversal attacks.
- **Sensitive data**: Emails and phone numbers in profiles are preserved but not exposed in logs.
---
## Useful Telegram Commands for Administration
- `/viewai` — Check current AI provider and model
- `/configai` — Change AI provider/model on the fly
- `/viewvision` — Check vision configuration
- `/configvision` — Change vision model on the fly
- `/debug` — View system debug information
- `/reload` — Reload .env without restarting the service
- `/timezone` — Check server timezone
---
## Support
- System developed by: [Syspanel.com.br](https://syspanel.com.br)
- Author: Marco A. S. Costa
- Email: contato@syspanel.com.br
- License: Proprietary for syspanel.com.br