Setup

Requirements

Create a directory (mkdir maubot) and enter it (cd maubot). Do not clone the repository. If you want to use a specific version from git rather than PyPI, use the development setup instructions.
Set up a virtual environment.
1. Create with virtualenv -p /usr/bin/python3 . (note the dot at the end)
  - You should not use a subdirectory for the virtualenv in this production setup. The pip install step places some required files at the root of the environment.
2. Activate with source ./bin/activate
Install with pip install --upgrade maubot
Copy maubot/example-config.yaml to config.yaml and update to your liking.
Create the log directory and all directories used in plugin_directories (usually mkdir plugins trash logs).
Create the database with alembic upgrade head. If you have a custom config path, use alembic -x config=/path/to/config.yaml upgrade head.
Start with python3 -m maubot.
The management interface should now be available at http://localhost:29316/_matrix/maubot or whatever you configured.

Clone the repository.
Optional, but strongly recommended: Set up a virtual environment.
1. Create with virtualenv -p /usr/bin/python3 .venv
2. Activate with source .venv/bin/activate
Install dependencies with pip install -r requirements.txt
pip install --editable . (note the dot at the end)
Build the frontend:
1. cd maubot/management/frontend
2. Install dependencies with yarn
3. Build with yarn build
Optional: Configure debug file open so that you can open files in your IDE by clicking on stack trace lines in the frontend log viewer.
Continue from step 4 of the production setup.