76 lines
1.7 KiB
Markdown
76 lines
1.7 KiB
Markdown
|
|
|
|
|
|
# Installing Tuxbot
|
|
|
|
It is preferable to install the bot on a dedicated user. If you don't know how to do it, please refer to [this guide](https://www.digitalocean.com/community/tutorials/how-to-create-a-sudo-user-on-ubuntu-quickstart)
|
|
|
|
## Installing the pre-requirements
|
|
|
|
- The pre-requirements are:
|
|
- Python 3.7 or greater
|
|
- Pip
|
|
- Git
|
|
|
|
### Operating systems
|
|
|
|
-----
|
|
|
|
### Arch Linux
|
|
|
|
```shell script
|
|
sudo pacman -Syu python python-pip python-virtualenv git
|
|
```
|
|
|
|
Continue to [create the venv](#creating-the-virtual-environnement).
|
|
|
|
-----
|
|
|
|
#### Debian
|
|
|
|
```shell script
|
|
sudo apt update
|
|
sudo apt -y install python3 python3-dev python3-pip python3-venv git
|
|
```
|
|
|
|
Continue to [create the venv](#creating-the-virtual-environnement).
|
|
|
|
-----
|
|
|
|
#### Windows
|
|
|
|
*not for now and not for the future*
|
|
|
|
|
|
## Creating the Virtual Environment
|
|
|
|
To set up the virtual environment and install the bot, simply run this two commands:
|
|
|
|
```shell script
|
|
make
|
|
make install
|
|
```
|
|
|
|
Now, switch your environment to the virtual one by run this single command:
|
|
```shell script
|
|
source ~/tuxvenv/bin/activate
|
|
```
|
|
|
|
## Configuration
|
|
|
|
It's time to set up your first instance, to do this, you can simply execute this command:
|
|
|
|
```shell script
|
|
tuxbot-setup [your instance name]
|
|
```
|
|
|
|
After following the instructions, you can run your instance by executing this command:
|
|
|
|
```shell script
|
|
tuxbot [your instance name]
|
|
```
|
|
|
|
|
|
## Update
|
|
|
|
*todo* |