OpenWebUI-Discordbot/README.md

23 lines
706 B
Markdown
Raw Normal View History

2024-12-20 00:27:48 +00:00
# OpenWebUI-Discordbot
A Discord bot that interfaces with an OpenWebUI instance to provide AI-powered responses in your Discord server.
2024-12-20 01:19:06 +00:00
## Prerequisites
2024-12-20 01:19:06 +00:00
- Docker (for containerized deployment)
- Python 3.8 or higher+ (for local development)
- A Discord Bot Token ([How to create a Discord Bot Token](https://www.writebots.com/discord-bot-token/))
- Access to an OpenWebUI instance
2024-12-20 01:19:06 +00:00
## Installation
2024-12-20 01:19:06 +00:00
##### Running locally
2024-12-20 01:19:06 +00:00
1. Clone the repository
2. Copy `.env.sample` to `.env` and configure your environment variables:
```env
DISCORD_TOKEN=your_discord_bot_token
OPENAI_API_KEY=your_openwebui_api_key
OPENWEBUI_API_BASE=http://your_openwebui_instance:port/api
MODEL_NAME=your_model_name
```