Updated README.md for better clarity and installation instructions
Ravenmoray
parent
6502c0fecb
commit
1a3592bc1b
80
README.md
80
README.md
|
|
@ -1,42 +1,76 @@
|
|||
|
||||
# discollama
|
||||
|
||||
`discollama` is a Discord bot powered by a local large language model backed by [Ollama](https://github.com/jmorganca/ollama).
|
||||
`discollama` is an innovative Discord bot that leverages a local large language model to interact in Discord channels. It's powered by [Ollama](https://github.com/jmorganca/ollama), making it a powerful and customizable tool for Discord server administrators and enthusiasts.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Docker and Docker Compose
|
||||
Before you begin, ensure you have the following installed:
|
||||
- Docker
|
||||
- Docker Compose
|
||||
|
||||
## Run `discollama.py`
|
||||
### Installing Docker
|
||||
|
||||
#### Linux
|
||||
- Install Docker using your package manager or follow the instructions here: [Install Docker on Linux](https://docs.docker.com/engine/install/).
|
||||
|
||||
#### Mac
|
||||
- Download and install Docker Desktop for Mac from [Docker Hub](https://hub.docker.com/editions/community/docker-ce-desktop-mac/).
|
||||
|
||||
#### Windows
|
||||
- Download and install Docker Desktop for Windows from [Docker Hub](https://hub.docker.com/editions/community/docker-ce-desktop-windows/).
|
||||
|
||||
### Installing Docker Compose
|
||||
- Docker Compose is included in Docker Desktop for Mac and Windows.
|
||||
- For Linux, follow the instructions here: [Install Docker Compose on Linux](https://docs.docker.com/compose/install/).
|
||||
|
||||
## Setting Up a Discord Bot
|
||||
|
||||
To use `discollama`, you'll need a Discord bot token. Follow these steps to set one up:
|
||||
|
||||
1. **Create a Discord account**: If you don’t already have a Discord account, create one at [Discord's registration page](https://discord.com/register).
|
||||
2. **Create a new application**: Visit the [Discord Developer Portal](https://discord.com/developers/applications), click on "New Application", and give it a name.
|
||||
3. **Create a Bot User**: In your application, navigate to the “Bot” tab and click "Add Bot".
|
||||
4. **Get your Bot Token**: Under the bot section, find the “Token” and click "Copy". This is your `DISCORD_TOKEN` which you'll use later. Keep this token private!
|
||||
5. **Invite Bot to Server**: In the “OAuth2” tab, under “Scopes”, select “bot”. Choose the permissions your bot needs and use the generated URL to invite your bot to your Discord server.
|
||||
|
||||
## Installation and Running `discollama`
|
||||
|
||||
1. **Clone the Repository**: First, clone the `discollama` repository from GitHub.
|
||||
```
|
||||
DISCORD_TOKEN=xxxxx docker compose up
|
||||
git clone https://github.com/mxyng/discollama.git
|
||||
cd discollama
|
||||
```
|
||||
|
||||
> Note: You must setup a [Discord Bot](https://discord.com/developers/applications) and set environment variable `DISCORD_TOKEN` before `discollama.py` can access Discord.
|
||||
|
||||
`discollama.py` requires an [Ollama](https://github.com/jmorganca/ollama) server. Follow the steps in [jmorganca/ollama](https://github.com/jmorganca/ollama) repository to setup Ollama.
|
||||
|
||||
By default, it uses `127.0.0.1:11434` which can be overwritten with `OLLAMA_HOST`.
|
||||
|
||||
> Note: Deploying this on Linux requires updating network configurations and `OLLAMA_HOST`.
|
||||
|
||||
## Customize `discollama.py`
|
||||
|
||||
The default LLM is `mike/discollama`. A custom personality can be added by changing the `SYSTEM` instruction in the Modelfile and running `ollama create`:
|
||||
|
||||
2. **Setup Environment Variables**: Create a `.env` file in the root directory and add your Discord token.
|
||||
```
|
||||
ollama create mymodel -f Modelfile
|
||||
echo DISCORD_TOKEN=your_discord_bot_token > .env
|
||||
```
|
||||
|
||||
This can be changed in `compose.yaml`:
|
||||
|
||||
3. **Running the Bot**: Use Docker Compose to build and run the bot.
|
||||
```
|
||||
environment:
|
||||
- OLLAMA_MODEL=mymodel
|
||||
docker compose up
|
||||
```
|
||||
> This command builds the Docker image and starts the `discollama` bot in a Docker container.
|
||||
|
||||
See [jmorganca/ollama](https://github.com/jmorganca/ollama/blob/main/docs/modelfile.md) for more details.
|
||||
> **Note**: Ensure your `OLLAMA_HOST` is set correctly in the `compose.yaml` if you are deploying on a network other than localhost.
|
||||
|
||||
## Activating the Bot
|
||||
|
||||
Discord users can interact with the bot by mentioning it in a message to start a new conversation or in a reply to a previous response to continue an ongoing conversation.
|
||||
Once `discollama` is running, you can interact with it in your Discord server. Just mention the bot in a message to start a new conversation, or reply to its messages to continue an ongoing conversation.
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
[Common issues and solutions]
|
||||
|
||||
## Contributing
|
||||
|
||||
[Information on how others can contribute to the project]
|
||||
|
||||
## Contact
|
||||
|
||||
[Provide contact information or methods for support and feedback]
|
||||
|
||||
## License
|
||||
|
||||
`discollama` is open-source software licensed under the MIT License. [See the full license here](./LICENSE).
|
||||
|
|
|
|||
Loading…
Reference in New Issue