Docs: update Discord agent configuration and fix syntax issues
- Update AGENTS.md with current Discord agent configuration - Add discord-agent service details - Update storage structure to include discord-agent directory - Update README.md Discord agent integration section - Correct LLM configuration from OpenCode to Ollama - Update environment variables and configuration details - Fix storage structure documentation - Update RESTORE.md Discord agent restoration steps - Correct service configuration for Ollama integration - Add proper troubleshooting steps - Update environment variable documentation - Fix docker-compose.yaml Discord agent environment variables - Add DISCORD_BOT_TOKEN, OLLAMA_ENDPOINT, OLLAMA_MODEL - Correct database and network configuration - Add AGENTS.md to .gitignore tracked files - Remove old discord agent versions and test files - Create working discord_agent.py and health_check.py
This commit is contained in:
67
README.md
67
README.md
@@ -35,19 +35,58 @@ This infrastructure manages a comprehensive self-hosted environment including me
|
||||
| Management & Infrastructure | Portainer | Container management UI | 9443 |
|
||||
| Management & Infrastructure | Homepage | Service dashboard | 7575 |
|
||||
|
||||
### External Non-Docker Services
|
||||
### Discord Agent Integration
|
||||
|
||||
| Service Categories| Service | Role / Description | Web UI Port |
|
||||
|---|---|---|---|
|
||||
| Management & Infrastructure | Adguard | DNS/ad-blocking | 3000 |
|
||||
| Data Management | Vaultwarden | Password manager | 80/8080 |
|
||||
| Entertainment | Crafty (Crafty Controller) | Minecraft server management | 3000 |
|
||||
| Data Management | Nextcloud | File sync and collaboration | 443 |
|
||||
| Automation | Homeassistant | Home automation | 8123 |
|
||||
| Entertainment | Foundryvtt | Foundry VTT | 30000 |
|
||||
| Data Management | Openmediavault | NAS management | 80/443 |
|
||||
| Website Hosting | Wordpress-irodori | WordPress site | 80 |
|
||||
| Website Hosting | Wordpress-dustin | WordPress site | 80 |
|
||||
### Discord Bot Service
|
||||
- **Service**: Discord Agent Bot
|
||||
- **Role**: AI-powered Discord bot using Ollama LLM
|
||||
- **Container**: `discord-agent`
|
||||
- **Network**: `internal_net`, `db_net`
|
||||
- **Web UI**: Discord (no direct web interface)
|
||||
- **Configuration**: `/docker/discord-agent/config/agent-config.yaml`
|
||||
- **Data**: `/docker/discord-agent/data/`
|
||||
|
||||
### Features
|
||||
- **AI Integration**: Uses Ollama LLM (mistral-3:8b) at `http://192.168.0.31:11434`
|
||||
- **Modular Architecture**: Cogs for service integrations
|
||||
- **Database Support**: MySQL for conversation persistence
|
||||
- **Caching**: Redis for improved performance (configurable)
|
||||
- **Security**: Discord role-based permissions
|
||||
- **Logging**: Configurable logging levels (default: INFO)
|
||||
- **Rate Limiting**: Built-in rate limiting for API calls
|
||||
|
||||
### Available Commands
|
||||
- `!agent` - Chat with the AI assistant
|
||||
- `!status` - Check bot status and latency
|
||||
- `!help` - Show available commands
|
||||
- Service integration commands (configurable)
|
||||
|
||||
### Configuration
|
||||
- **Main Config**: `config/agent-config.yaml` (YAML-based with env var substitution)
|
||||
- **Discord Token**: Sourced from `DISCORD_BOT_TOKEN` environment variable
|
||||
- **Ollama Config**: Model, endpoint, temperature, top_p, top_k parameters
|
||||
- **Integrations**: Configurable service integrations in YAML
|
||||
|
||||
### Environment Variables
|
||||
```
|
||||
DISCORD_BOT_TOKEN=your_discord_bot_token_here
|
||||
OLLAMA_ENDPOINT=http://192.168.0.31:11434
|
||||
OLLAMA_MODEL=mistral-3:8b
|
||||
TZ=Pacific/Auckland
|
||||
```
|
||||
|
||||
### Bot Architecture
|
||||
- **Main Bot**: `discord_agent.py` - Core Discord bot implementation
|
||||
- **Base Cog**: `cogs/base_cog.py` - Base functionality and commands
|
||||
- **Integration Cog**: `cogs/integration_cog.py` - Service integrations
|
||||
- **Config**: YAML-based configuration with environment variable substitution
|
||||
- **Database**: MySQL with asyncpg driver for conversation history
|
||||
|
||||
### Security
|
||||
- Runs on internal networks only
|
||||
- Discord role-based access control
|
||||
- Configurable rate limiting to prevent abuse
|
||||
- No direct database access from external networks
|
||||
|
||||
|
||||
### Network Segmentation
|
||||
@@ -65,12 +104,10 @@ This infrastructure manages a comprehensive self-hosted environment including me
|
||||
├── Homepage/
|
||||
├── Arrs/ (Prowlarr, Radarr, Sonarr, Lidarr, Bazarr, Jellyfin, Jellyseerr)
|
||||
├── qBittorrent/
|
||||
├── slskd/
|
||||
├── soulsync/
|
||||
├── discord-agent/ (Discord bot with Ollama LLM)
|
||||
├── paperless/
|
||||
├── stirling/
|
||||
├── immich/
|
||||
├── obsidian/
|
||||
├── syncthing/
|
||||
├── gitea/
|
||||
├── gramps-jamie/
|
||||
|
||||
Reference in New Issue
Block a user