2020-04-01 11:09:10 +00:00
# Maubot installer
Bash installer for https://github.com/maubot/maubot/ with nginx and letsencrypt frontend.
Once installed, you will be able to run matrix bots in the wild!
2020-04-01 22:12:02 +00:00
See [this tutorial ](https://www.tmplab.org/2020/04/01/how-to-install-and-run-bots-for-the-matrix-network/ ) for details.
2020-04-01 11:38:07 +00:00
## Requirements
2020-04-01 11:09:10 +00:00
2020-04-01 11:14:26 +00:00
Debian Buster minimum as you need Python 3.6 or higher
2020-04-01 11:09:10 +00:00
## crash course
```
2020-04-01 18:05:28 +00:00
# 1. First create a subdomain which points to your server IP address
# 2.a) Then download and install
2020-04-01 14:09:21 +00:00
wget https://git.interhacker.space/alban/maubot-installer/raw/branch/master/install.sh/
2020-04-01 11:09:10 +00:00
bash install.sh
2020-04-01 18:05:28 +00:00
# 2.b) Or clone with git
git clone https://git.interhacker.space/alban/maubot-installer.git
cd maubot-installer
bash install.sh
2022-09-02 15:59:36 +00:00
# 3) Run the secure db install for security
bash secure-db-install.sh
# Optionnaly use the plugin installer if you cloned
# Edit the variables
$EDITOR plugin-install.sh
# OR use a config file
cp config.default config & & $EDITOR config
2020-04-01 18:05:28 +00:00
bash plugin-install.sh
2020-04-01 11:09:10 +00:00
```
2020-04-01 11:37:56 +00:00
The script asks you some questions before install.
2020-04-01 11:09:10 +00:00
2020-04-01 11:15:05 +00:00
* **Which domain will be used to connect to your bot (ex: maubot.example.com)?**
2020-04-01 11:09:10 +00:00
Caution, this one requires you to act BEFORE you install, or things might not work.
Maubot has a web frontend, so it is recommanded to create a subdomain to host it.
Provide the subdomain you created as a reply.
2020-04-01 11:15:05 +00:00
* **Which domain is the matrix 'Home Server' you register your bots on?**
2020-04-01 11:09:10 +00:00
If you're not sure, you probably don't run your own matrix server. It's fine. Just provide the matrix server on which you will create your bot's account.
2020-04-01 11:15:05 +00:00
* **What will be your user name in the maubot interface?**
2020-04-01 11:09:10 +00:00
Maubot is a web app with a login / password interface. What will be your login?
2020-04-01 12:06:53 +00:00
* **What will be the pass for user '$maubot_user' in the maubot interface?**
2020-04-01 11:09:10 +00:00
Maubot is a web app with a login / password interface. What will be your password?
2020-04-01 11:14:26 +00:00
* **Do you want to enable SSL via letsencrypt [Y/n]?**
2020-04-01 11:09:10 +00:00
By default, this script will get an SSL/TLS certificate for you. This is the recommended and secure way.
2020-04-01 11:14:26 +00:00
* **If the 'Home Server' is yours, what is the registration secret (ignore if you don't know what this is)?**
2020-04-01 11:09:10 +00:00
If you run your own matrix server, provide the hyper secure registration secret password. Otherwise, let it empty.
2020-04-01 11:14:26 +00:00
* **Which install dir to use (Default: /opt/maubot)?**
2020-04-01 11:09:10 +00:00
Where do you intend the maubot code to reside on your server.
2020-04-01 11:14:26 +00:00
* **Which unix user will own and execute the maubot code?**
2020-04-01 11:09:10 +00:00
Which system user will be responsible for running the server.
2020-04-01 11:14:26 +00:00
2020-04-01 18:05:28 +00:00
## Using the config file
The scripts use a `config` file to record your variables.
```
cp config.sample config
nano config # Edit
```
## Contributing
2022-09-02 15:59:36 +00:00
Feel free to post issues here on https://git.interhacker.space/alban/maubot-installer/issues
2020-04-01 18:05:28 +00:00
## Known problems
2022-09-02 15:59:36 +00:00
Some plugins might require additional pip packages, you might have to install them by hand.
