melod1n/tg-chat-bot
1
0
Fork 0
Code Issues Actions Packages Projects Releases Wiki Activity

update .env.example and README with additional bot configuration options

Browse Source
This commit is contained in:
difome
2026-01-28 04:48:22 +02:00
parent ab670a553d
commit c93da69281
2 changed files with 40 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files
.env.example
+35 -4
View File
@@ -2,25 +2,56 @@
# TELEGRAM BOT CONFIGURATION # TELEGRAM BOT CONFIGURATION
# ============================================ # ============================================
# Telegram Bot Token (Required) # Telegram Bot Token
# Get it from BotFather: https://t.me/botfather # Get it from BotFather: https://t.me/botfather
BOT_TOKEN=your_bot_token_here BOT_TOKEN=your_bot_token_here
# Creator ID (Required) # Creator ID
# Your Telegram user ID - the bot will recognize you as creator # Your Telegram user ID - the bot will recognize you as creator
CREATOR_ID=your_user_id_here CREATOR_ID=your_user_id_here
# ============================================ # ============================================
# OPTIONAL: AI MODELS # BOT SETTINGS (Optional)
# ============================================
# Bot Prefix for commands
BOT_PREFIX=
# Whitelist of chat IDs (comma-separated)
# Example: 123456789,987654321
CHAT_IDS_WHITELIST=
# Test environment mode
TEST_ENVIRONMENT=false
# Docker deployment
IS_DOCKER=false
# Only creator can use bot
ONLY_FOR_CREATOR_MODE=false
# Use user names in AI prompts
USE_NAMES_IN_PROMPT=true
# Maximum photo size in pixels
MAX_PHOTO_SIZE=1280
# ============================================
# AI MODELS CONFIGURATION (Optional)
# ============================================ # ============================================
# Google Gemini # Google Gemini
GEMINI_API_KEY= GEMINI_API_KEY=
GEMINI_MODEL=gemini-2.5-flash
# Mistral AI # Mistral AI
MISTRAL_API_KEY= MISTRAL_API_KEY=
MISTRAL_MODEL=mistral-small-latest
# Ollama (Local) # Ollama (Local AI Model)
OLLAMA_ADDRESS= OLLAMA_ADDRESS=
OLLAMA_MODEL= OLLAMA_MODEL=
OLLAMA_API_KEY=
# Custom system prompt for AI
SYSTEM_PROMPT= SYSTEM_PROMPT=
README.md
+4 -1
View File
@@ -1,11 +1,12 @@
# Telegram Chat Bot # Telegram Chat Bot
Bot for Telegram with a lot of commands and AI (Ollama/Gemini/Mistral) written in TypeScript + NodeJS/Bun runtime + Drizzle ORM (SQLite DB)
## Quick Start ## Quick Start
```bash ```bash
cp .env.example .env cp .env.example .env
# Edit .env: add BOT_TOKEN and CREATOR_ID or # Edit .env: add BOT_TOKEN, CREATOR_ID and configure optional AI models (GEMINI_API_KEY, MISTRAL_API_KEY, OLLAMA_ADDRESS)
``` ```
**With Bun (Recommended):** **With Bun (Recommended):**
@@ -24,12 +25,14 @@ npm run build && npm start
**With Docker:** **With Docker:**
```bash ```bash
# Set IS_DOCKER=true in .env
docker build -f Dockerfile -t tg-bot . docker build -f Dockerfile -t tg-bot .
docker run -d --env-file .env -v $(pwd)/data:/config/data tg-bot docker run -d --env-file .env -v $(pwd)/data:/config/data tg-bot
``` ```
**With Docker (Bun):** **With Docker (Bun):**
```bash ```bash
# Set IS_DOCKER=true in .env
docker build -f Dockerfile-bun -t tg-bot-bun . docker build -f Dockerfile-bun -t tg-bot-bun .
docker run -d --env-file .env -v $(pwd)/data:/config/data tg-bot-bun docker run -d --env-file .env -v $(pwd)/data:/config/data tg-bot-bun
``` ```