No description

Find a file

Kumi bf909c5efb docs: update README with detailed features and usage Expanded the README with comprehensive details about the bot's capabilities, including its features, user and operator commands, installation steps, and usage instructions. This enhances clarity for new users and contributors on how to interact with and set up the bot effectively.		2024-08-18 19:00:44 +02:00
.forgejo/workflows	feat: add initial version of Matrix Support Bot	2024-08-18 17:33:56 +02:00
src/matrix_supportbot	feat: improve bot functionality and logging setup	2024-08-18 18:53:59 +02:00
.gitignore	chore: update .gitignore to include dist/ directory	2024-08-18 18:54:46 +02:00
config.yaml.dist	feat: add initial version of Matrix Support Bot	2024-08-18 17:33:56 +02:00
LICENSE	feat: add initial version of Matrix Support Bot	2024-08-18 17:33:56 +02:00
pyproject.toml	feat: improve bot functionality and logging setup	2024-08-18 18:53:59 +02:00
README.md	docs: update README with detailed features and usage	2024-08-18 19:00:44 +02:00

README.md

Matrix Support Bot

Matrix Support Bot is a support ticket bot for the Matrix protocol built using the matrix-nio library. The bot allows users to open support tickets and communicate with support operators in a structured manner. Operators can manage tickets and relay messages between customer-facing and operator-facing rooms.

Features

The bot's state is stored in a Matrix room, so no external database is required.
Users can invite the bot to a direct message (DM) and receive instructions on how to open a support ticket.
Users can open support tickets using the !supportbot openticket command.
The bot creates a new customer-facing room for each ticket and invites the user to it.
Operators are notified of new tickets in a shared operator room.
Operators can join operator-facing rooms for each ticket and communicate with customers.
Messages between customer-facing and operator-facing rooms are relayed by the bot.
Operators can close tickets and list open tickets using bot commands.
Supports relaying of different message types, including text and media.

Commands

User Commands

!supportbot openticket - Opens a new support ticket and creates a customer-facing room.

Operator Commands

!supportbot invite <ticket_id> - Invites an operator to the operator-facing room for the specified ticket.
!supportbot close <ticket_id> - Closes the specified ticket.
!supportbot list - Lists all open tickets.

Installation

Install from PyPI:
```
pip install matrix-supportbot
```

Create a config.yaml file with your Matrix credentials and operator room ID:

homeserver: "https://homeserver.example"
username: "your_username"
password: "your_password"
operator_room_id: "!your_operator_room_id:homeserver.example"

Usage

Run the bot with the following command:

supportbot

The bot will log in to your Matrix server, join the operator room, and start listening for commands and invites.

Contributing

Contributions are welcome! Please fork the repository and create a pull request with your changes.

License

This project is licensed under the MIT License. See the LICENSE file for details.