Go to file
2021-01-27 15:54:21 +01:00
.github update(main): improve launch UI 2020-08-28 01:06:57 +02:00
.idea feat(commands|Network>dig): feat dig command 2021-01-26 17:11:30 +01:00
tuxbot fix(import): add missing file 2021-01-27 15:52:13 +01:00
.deepsource.toml fix(deepsource): remove black from deepsource conf 2020-10-21 00:02:02 +02:00
.gitignore fix(linting): set the not to 10/10 on pylint 2020-10-19 00:20:58 +02:00
.pylintrc fix(commands|Utils>source): stupid of me, the +3 was 'cause of a diff in local and github 2020-11-11 01:29:53 +01:00
dev.requirements.txt feat(core|logs>sentry): feat sentry error handler 2021-01-27 15:14:05 +01:00
LICENSE fix(linting): set the not to 10/10 on pylint 2020-10-19 00:20:58 +02:00
Makefile feat(commands|Polls>propose): feat poll proposition + acceptation 2021-01-22 10:22:39 +01:00
README.rst feat(doc): add missing instructions about postgresql 2021-01-27 15:51:10 +01:00
setup.cfg fix(import): add missing requirement 2021-01-27 15:54:21 +01:00
setup.py feat(commands|Utils>info): feat cpu usage 2021-01-25 14:52:30 +01:00

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.


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.

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 [your instance name]

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

tuxbot [your instance name]

Update

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

$ make update