tuxbot-bot/README.rst

3.0 KiB

image0 image1 image2 image3

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

Installing the pre-requirements

  • The pre-requirements are:
    • Python 3.8 or greater
    • Pip
    • Git

Operating systems

Arch Linux

$ sudo pacman -Syu python python-pip python-virtualenv git make gcc postgresql

Continue to configure postgresql.


Debian

$ sudo apt update
$ sudo apt -y install python3 python3-dev python3-pip python3-venv git make gcc postgresql postgresql-client

Continue to configure postgresql.


RHEL and derivatives (CentOS, Fedora...)

$ sudo dnf update
$ sudo dnf install python3 python3-devel python3-pip python3-virtualenv git make gcc postgresql-server postgresql-contrib

Continue to configure postgresql.


Windows

not for now and not for the future


Configure PostgreSQL

Now, you need to setup PostgreSQL

Operating systems

Arch Linux

https://wiki.archlinux.org/index.php/PostgreSQL

Continue to create the venv.


Debian

https://wiki.debian.org/PostgreSql

Continue to create the venv.


RHEL and derivatives (CentOS, Fedora...)

https://fedoraproject.org/wiki/PostgreSQL

Continue to create the venv.


Creating the Virtual Environment

To set up the virtual environment and install the bot, simply run this two commands:

$ make
$ make install

Now, switch your environment to the virtual one by run this single command: source ~/venv/bin/activate

Configuration

It's time to set up your first instance, to do this, you can simply execute this command:

tuxbot-setup

After following the instructions, you can run your instance by executing this command:

tuxbot

Update

To update the whole bot after a git pull, just execute

$ make update