OmenFusionAi_Bot Documentation

Documentation for OmenFusionAi_Bot AI Assistant

---

Project maintained by Amul-Thantharate Hosted on GitHub Pages — Theme by mattgraham

Setup Guide

Learn how to set up and deploy OmenFusionAi_Bot.

Table of Contents

1. Quick Start
   1. Prerequisites
   2. Required Environment Variables
   3. Optional API Keys
   4. Installation Steps
2. Configuration
   1. Environment Variables
      1. Required Variables
      2. Optional Variables
   2. Security Notes
3. Server Requirements
   1. Minimum Requirements
   2. Recommended Requirements
4. Deployment
   1. Local Development
   2. Production Deployment
   3. Docker Deployment
5. Maintenance
   1. Regular Tasks
   2. Troubleshooting
6. Security Best Practices
   1. API Key Management
   2. Bot Security
   3. Data Protection

---

Quick Start

Prerequisites

• Python 3.8+
• pip (Python package manager)
• Git
• A Telegram account
• A bot token from @BotFather

Required Environment Variables

Create a .env file in the root directory with these variables:

TELEGRAM_BOT_TOKEN=your_telegram_bot_token
ROOT_PASSWORD=your_admin_password
ADMIN_USER_ID=your_admin_telegram_id

Optional API Keys

Users can set these directly through the bot:

• Groq API Key (/setgroqapi) - Get from Groq
• Replicate API Key (/setreplicateapi) - Get from Replicate

Installation Steps

1. Clone the repository:

   git clone https://github.com/yourusername/OmenFusionAi_Bot.git
   cd OmenFusionAi_Bot
   

2. Install dependencies:

   pip install -r requirements.txt
   

3. Set up environment variables:

   cp .env.example .env
   # Edit .env with your actual values
   

4. Run the bot:

   python app.py
   

Configuration

Environment Variables

Required Variables

• TELEGRAM_BOT_TOKEN: Your Telegram bot token from BotFather
• ROOT_PASSWORD: Password for admin operations
• ADMIN_USER_ID: Your Telegram user ID for admin access

Optional Variables

These can be set by users through bot commands:

• Groq API Key: Set via /setgroqapi
• Replicate API Key: Set via /setreplicateapi

Security Notes

• API keys are stored in memory only
• Keys are not persisted between bot restarts
• Messages containing API keys are automatically deleted
• Admin commands are protected by user ID verification

Server Requirements

Minimum Requirements

• 1GB RAM
• Python 3.8+
• Stable internet connection
• 1GB free disk space

Recommended Requirements

• 2GB RAM
• Python 3.10+
• High-speed internet connection
• 2GB free disk space
• SSL certificate (for production)

Deployment

Local Development

1. Follow the Quick Start guide
2. Use development environment variables
3. Run with debug logging enabled

Production Deployment

1. Set up a production server
2. Configure SSL certificates
3. Use production environment variables
4. Set up logging
5. Configure automatic restarts

Docker Deployment

Coming soon!

Maintenance

Regular Tasks

• Monitor log files
• Check disk usage
• Update dependencies
• Backup configuration

Troubleshooting

• Check log files for errors
• Verify environment variables
• Ensure API keys are valid
• Check network connectivity

Security Best Practices

API Key Management

• Never share API keys
• Use bot commands to set keys
• Regularly rotate keys
• Monitor for unauthorized usage

Bot Security

• Keep Python updated
• Update dependencies regularly
• Monitor bot activity
• Use strong admin password

Data Protection

• No persistent storage of API keys
• Automatic message deletion for sensitive data
• Session data cleared on restart
• Secure environment variable handling