# Maubot

Maubot is a plugin-based Matrix bot system that can be used to create and manage bots for Matrix rooms. It is written in Python and can be extended with custom plugins to provide additional functionality. Maubot is designed to be easy to use and configure, making it a great choice for developers and non-developers alike.

## Usage

By default, we configure Maubot’s web interface to be accessible at `https://matrix.your-server.com/_matrix/maubot`. Your log in account is set to your Matrix ID (`@user:your-server.com`) and password to the one sent on the onboarding list. Please [contact us](https://etke.cc/contacts/) if you’d like to add or modify its admin users.

To get started with Maubot, log in to the interface and follow the steps below:

1. Create one or more clients. A client is a matrix account which the bot will use to message. By default the `maubot` (`@maubot:your-server.com`) account is created. You only need to obtain an access token for it
2. Upload plugins. You can get them from the [official plugins repository](https://plugins.mau.bot/) or write your own
3. Create an instance. An instance is the actual bot. You have to specify a client which the bot instance will use and the plugin (how the bot will behave)

### Command-line Interface (advanced)

If you have SSH access to the server, you can use Maubot’s command line interface to manage your Maubot instance.

First, you need to get into the Maubot’s container by running the following command: `docker exec -it matrix-bot-maubot sh`.

Then, you can use the `mbc` command to manage your Maubot instance:

```bash
$ mbc --help
Usage: python -m maubot.cli [OPTIONS] COMMAND [ARGS]...

Options:
  --help  Show this message and exit.

Commands:
  auth    Log into a Matrix account via the Maubot server
  build   Build a maubot plugin
  init    Initialize a new maubot plugin
  login   Log in to a Maubot instance
  logs    View the logs of a server
  upload  Upload a maubot plugin
```



---
* [llms.txt](https://etke.cc/llms.txt): full site index in markdown