Ferrisbot

What is this?

Ferrisbot is a Rust based moderator chat bot, designed to used with the Telegram messenger.

Setup LLM

Install Ollama

Download and install Ollama

Download URL

setup LLM modell

examples:

Llama3.2

ollama run llama3.2:latest

or

mistral-nemo 12B

ollama run mistral-nemo:12b

Remember: The models must have tool support and if it works well or not depends on the model of your choice!

Setup Telegram bot token & parameters

examples:

export TELEGRAM_TOKEN = <MY_TELEGRAM_BOT_TOKEN>
export OLLAMA_HOST_ADDR = "http:localhost"
export OLLAMA_PORT = 11434
export LLM_MODEL = "llama3.2:latest"
export BOT_NAME = "<Name of the bot>"
export BOT_USERNAME = "<Telegram username of the bot>"
export FILE_DB_PATH = "<Path to store bot memory state file>"

Define Bot Task

Create or adjust the bot role definitions (natural language) in the prompt template role_definition.md

Template Placeholder

Following placeholders must be used in your role definition prompt template

Botname

The name of your bot which has been defined as the environment variable:

{name}

No action flag

This internal flag is important if you define a situation in the template where the bot should not response to a message:

 {NO_ACTION}

External Dependencies

This application requires OpenSSL and pkg-config:

• On Linux: pkg-config libssl-dev
• On Mac: nothing to do!

Setup local development

Build the project

cargo build

Run

cargo run

Run unit tests with logs

export RUST_LOG="debug"
cargo test -- --nocapture

Notes

• For the Telegram api framework, I'm using my own fork version of mobot, where the missing telegram api capabilities are implemented: Restriction of chat members, forum message support, retrieve chat full information, ban/unban users and get administrator member list. When the features are fully tested and the time allows me, I will create a PR to contribute back if they want.