6b903cff5e
* fix: name in job * add: auto create config.json on missing * update: readme goals * add: clarify instructions on fail chat * update: reduced redundancy in package file
31 lines
2.7 KiB
Markdown
31 lines
2.7 KiB
Markdown
# Discord Ollama Integration [](https://creativecommons.org/licenses/by-nc/4.0/) [](https://github.com/kevinthedang/discord-ollama/releases/latest)
|
|
Ollama is an AI model management tool that allows users to install and use custom large language models locally. The goal is to create a discord bot that will utilize Ollama and chat with it on a Discord server! Also, allow others to create their own models personalized for their own servers!
|
|
|
|
## Environment Setup
|
|
* Clone this repo using `git clone https://github.com/kevinthedang/discord-ollama.git` or just use [GitHub Desktop](https://desktop.github.com/) to clone the repo.
|
|
* You will need a `.env` file in the root of the project directory with the bot's token. There is a `.env.sample` is provided for you as a reference for what environment variables.
|
|
* For example, `CLIENT_TOKEN = [Bot Token]`
|
|
* Please refer to the docs for bot setup. **NOTE**: These guides assume you already know how to setup a bot account for discord.
|
|
* [Local Machine Setup](./docs/setup-local.md)
|
|
* [Docker Setup for Servers and Local Machines](./docs/setup-docker.md)
|
|
* Local use is not recommended.
|
|
|
|
## Resources
|
|
* [NodeJS](https://nodejs.org/en)
|
|
* This project uses `v20.10.0+` (npm `10.2.5`). Consider using [nvm](https://github.com/nvm-sh/nvm) for multiple NodeJS versions.
|
|
* To run dev in `ts-node`, using `v18.18.2` is recommended. **CAUTION**: `v18.19.0` or `lts/hydrogen` will not run properly.
|
|
* To run dev with `tsx`, you can use `v20.10.0` or earlier.
|
|
* This project supports any NodeJS version above `16.x.x` to only allow ESModules.
|
|
* [Ollama](https://ollama.ai/)
|
|
* [Ollama Docker Image](https://hub.docker.com/r/ollama/ollama)
|
|
* **IMPORTANT**: For Nvidia GPU setup, **install** `nvidia container toolkit/runtime` then **configure** it with Docker to utilize Nvidia driver.
|
|
* [Discord Developer Portal](https://discord.com/developers/docs/intro)
|
|
* [Discord.js Docs](https://discord.js.org/docs/packages/discord.js/main)
|
|
* [Setting up Docker (Ubuntu 20.04)](https://www.digitalocean.com/community/tutorials/how-to-install-and-use-docker-on-ubuntu-20-04)
|
|
* [Setting up Nvidia Container Toolkit](https://docs.nvidia.com/datacenter/cloud-native/container-toolkit/latest/install-guide.html)
|
|
|
|
## Acknowledgement
|
|
* [Kevin Dang](https://github.com/kevinthedang)
|
|
* [Jonathan Smoley](https://github.com/JT2M0L3Y)
|
|
|
|
[discord-ollama](https://github.com/kevinthedang/discord-ollama) © 2023 by [Kevin Dang](https://github.com/kevinthedang) is licensed under [CC BY-NC 4.0](https://creativecommons.org/licenses/by-nc/4.0/?ref=chooser-v1) |