Update 'README.md'

This commit is contained in:
alban 2020-04-01 18:05:28 +00:00
parent 8e08c2d1f2
commit 04a3b67178
1 changed files with 30 additions and 4 deletions

View File

@ -11,10 +11,21 @@ Debian Buster minimum as you need Python 3.6 or higher
## crash course
```
# First create a subdomain which points to your server IP address
# Then download and install
# 1. First create a subdomain which points to your server IP address
# 2.a) Then download and install
wget https://git.interhacker.space/alban/maubot-installer/raw/branch/master/install.sh/
bash install.sh
# 2.b) Or clone with git
git clone https://git.interhacker.space/alban/maubot-installer.git
cd maubot-installer
bash install.sh
# Optionaly use the plugin installer if you cloned
$EDITOR plugin-install.sh # Edit the variables
bash plugin-install.sh
```
The script asks you some questions before install.
@ -55,6 +66,21 @@ The script asks you some questions before install.
Which system user will be responsible for running the server.
## config
You can optionally copy the config.sample as config to skip answering questions.
## Using the config file
The scripts use a `config` file to record your variables.
```
cp config.sample config
nano config # Edit
```
## Contributing
Feel free to post issues here o
## Known problems
Some plugins might require additional pip packages, you might have to install them by hand.