Go to file
Romain J b75e5b8a8e update(commands:iplocalise|Network): update fail image 2021-05-16 18:09:51 +02:00
.envs/.local feat(host): start docker addon 2021-02-11 23:18:12 +01:00
.github update(main): improve launch UI 2020-08-28 01:06:57 +02:00
.idea feat(commands:rule|Mod): feat rule command 2021-05-13 22:19:27 +02:00
compose fix(commands|Custom>alias): close TUXBOT-BOT-1A, close TUXBOT-BOT-1H, close TUXBOT-BOT-1J 2021-02-16 19:28:30 +01:00
tuxbot update(commands:iplocalise|Network): update fail image 2021-05-16 18:09:51 +02:00
.deepsource.toml fix(deepsource): remove black from deepsource conf 2020-10-21 00:02:02 +02:00
.gitignore update(commands:*|Network): speed optimisation 2021-04-22 18:11:55 +02:00
.mypy.ini fix(commands:iplocalise|Network): remove crashing regex 2021-03-26 18:41:21 +01:00
.pylintrc fix(commands:iplocalise|Network): close TUXBOT-BOT-4N 2021-05-16 17:28:49 +02:00
LICENSE fix(linting): set the not to 10/10 on pylint 2020-10-19 00:20:58 +02:00
Makefile style 2021-04-20 17:30:05 +02:00
README.rst fix(commands:getheaders|Network): prevent fails for missing [] on v6 2021-04-22 14:54:46 +02:00
dev.requirements.txt fix(commands:iplocalise|Network): remove crashing regex 2021-03-26 18:41:21 +01:00
local.yml fix(commands|Custom>alias): close TUXBOT-BOT-1A, close TUXBOT-BOT-1H, close TUXBOT-BOT-1J 2021-02-16 19:28:30 +01:00
production.yml fix(commands|Custom>alias): close TUXBOT-BOT-1A, close TUXBOT-BOT-1H, close TUXBOT-BOT-1J 2021-02-16 19:28:30 +01:00
setup.cfg feat(commands:*|Tag): feat tag system 2021-05-16 00:32:14 +02:00
setup.py update(deps): update deps versions 2021-05-13 16:45:04 +02:00

README.rst

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.10 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