Docker

Preamble

So using Docker can save you some installation hassle, especially if you're NOT a PHP/SQL expert it will save you huge time ... but beware that understanding Docker also requires some practice of its own !

Generally, you could consider Docker is no less than amazing if you'd run only one (or very few) bot(s), same if you'd want a very quick discovery on Bebot's functions. In such case Docker is unbeatable on many aspects :

With very few actions from you, thanks to Docker's automations based on simple lightweight textfiles, you would configure then install and quickly run some sort of isolated "VMs" bringing your bot(s) and DataBase to life.

But beyond, eg if you wanted to optimizely run multiple bots from an unique PHP-code installation with all pointing towards same Database or needing some proxy (eg Aocp), it'd possibly not be the best choice as each instance would then weight full Docker image(s)/container(s) in RAM/CPU.

For such more complicated cases we'd rather point you at the classical way explained with details within both Bebot README and http://wiki.bebot.link/index.php/Installation

Now you're aware of this all, and if you feel ready for it, let's proceed into Docker below.

Install

Before anything else, you'll need to have Docker installed properly - depending on system hosting your bot(s) :

Windows => https://docs.docker.com/desktop/install/windows-install/

Linux => https://docs.docker.com/desktop/install/linux-install/

Mac => https://docs.docker.com/desktop/install/mac-install/

Just make sure you're properly installed then continue to next section.

DB prep

Now we have to determine how to manage our DataBase. For the SQL there are 3 possibilites :

1: you already have an external server ; just make sure it's reachable (eg : ping its ip) from your host, and check if its facial port (usually 3306) is correctly opened.

2: you opted for a local service on host ; so you'd usually go for usual SQL port (3306) but instead of 127.0.0.1 default ip we'd advice you default docker0 network ip 172.17.0.1

3: you're about to run a container for that ; you can skip this part fully as we'll explain you how to set this up correctly later in "build" section, it's the simplest in fact !

Here some command or documentation to verify elements for cases 1/2 :

- IP/Network on Linux/Mac (try from a console : ip a) and Windows (also in console : ipconfig)

- Ports/Services on Linux/Mac https://vitux.com/find-open-ports-on-debian and Windows https://www.geeksforgeeks.org/how-to-check-open-tcp-ip-ports-in-windows

- also find SQL config (usually .cnf) file(s) and check that your parameter "bind-address" is correct, otherwise change it and restart service

! ATTENTION ! in upper cases 1/2 you will have to :

- CREATE a DATABASE dedicated for the bot (you can name it as you like but remember it)

- make an USER with PASSWORD and expected source (eg : @'%' to accept external requests)

- also GRANT that USER all PRIVILEGES on the DATABASE you created upper

If needed, you may have to read some SQL doc, as https://dev.mysql.com/doc/ and adapt it to you context.

But for generic example it will usually look like the following :

mysql (enters prompt, optional parameters are --user --password + for distant server --host)

> CREATE DATABASE bebotdbname;

> CREATE USER 'bebotuzr'@'%' IDENTIFIED BY 'botpass';

> GRANT ALL PRIVILEGES ON bebotdb.* TO 'bebotuzr'@'%';

If you ain't sure, you can verify you work is fine by doing :

> SHOW DATABASES; (should show the DB you created upper among list)

> SELECT User, Host FROM mysql.user; (should show your upper user among list)

> SHOW GRANTS FOR 'bebotuzr'@'%'; (should show the upper GRANT among list)

If all here is done (or if you're in upper case 3) let's move on forward.

Build

Once the software is installed, you first have to build runnable images from Bebot Docker preset configs :

Get them from https://github.com/bitnykk/DockerBeBot/ (download the .zip or use git clone)

Then in command line, enter wanted folder ("botonly" in upper cases 1/2, "botplusdb" in upper case 3).

You could edit Dockerfile and change PHP version for whatever you'd like ; more details on the modules and config at https://www.php.net/docs.php

In upper case 3, you'd also have to setup your SQL credentials within docker-compose.yml (4 values to modify under "environment" part).

Once everything seems correct according to your needs, just do :

docker compose build 

If all goes fine you should see stuff as "Building X.Ys (10/10) FINISHED" + several blue lines starting with "=>".

When it's over you are almost ready for the most exciting part ... but we'll need few more actions first !

Bot config

Beware Docker works in a way that makes the bot could wipes some files at reload so we need to render some persistents.

For that reason we will extract some files within the image we built earlier, and save them at host level to protect them.

To do this, we will now run this long line on Linux from our chosen folder :

docker run --rm --entrypoint tar bebot-image czf - Conf Custom Extras/Bank Extras/Scripts log Text > out.tar.gz && tar xzf out.tar.gz -C . && rm out.tar.gz && chown 1000:1000 * -R

On Windows a part of this shouldn't work at all, so we will only obtain compressed datas into our chosen folder :

docker run --rm --entrypoint tar bebot-image czf - Conf Custom Extras/Bank Extras/Scripts log Text > out.tar.gz

(then we can use any Windows utility, as Winzip or 7-zip etc, to decompress these datas right in place)

In any case we end up with several new folders ("Conf", "Custom", "Extras", "log" and "Text") in chosen folder.

Windows only : possibly set permissive rights on those folders/files (select all, right-click > Properties > Security) so our container acces them.

Run

We're now ready to run our container(s) : 1 only if we want Bebot with our usual SQL server, otherwise 2 for Bebot + SQL both as Docker containers.

docker compose run bebot

Your bot should now load (after launching its DB) and, as it's our first run, ask to fill up credentials informations.

So give him account name, pass, character, server and also owner and superadmin(s) plus few more questions.

Then you're asked for the SQL part. In upper cases 1/2 you should already have everything needed here.

For case 3 you are just missing one information (SQL server ip) obtainable by 2 ways :

A: either you open a second console in command line (if you can do this)

B: or you do Ctrl+p then Ctlr+q to detach off container view and be back to prompt

In both cases A/B you will do these 2 commands in order :

docker ps

(to see bebotdb's name or id, any if fine as both can be used below)

docker inspect -f '{{range.NetworkSettings.Networks}}{{.IPAddress}}{{end}}' bebotdb_name_or_id

Once you got that, you can go back into bot's view (first console in case A, or do "docker attach bebot_name_or_id" command in case B).

Continue the settings where you stopped, then bot will start and create all his DB entries, and endly come online !

Control

Now to check if your container(s) run properly, you have a set of commands :

To show a list of running container(s) : docker ps (can use -a parameter to also see stopped ones)

To see realtime stats of container(s) : docker stats (Ctrl+c to exit)

To see realtime log of a container : docker logs -f container_name_or_id (Ctrl+c to exit which will NOT shutdown bot/container)

To enter a container interactively : docker exec -it container_name_or_id sh (Ctrl+p Ctrl+q to exit without shutting down neither)

If you need to stop (and then restart) some container(s) :

To stop any container(s) clean : docker compose down (all should cleanly go offline)

To stop a given container : docker stop container_name_or_id

To stop all containers forced : docker stop $(docker ps -q)

To restart stopped bot : docker compose run -d bebot (-d so it stays in background)

If Bebot git code was patched, such container restart upper should make it correctly auto-updated.

Alternative manual way : enter the container, do "git pull" then exit and !restart the bot from ingame, for same result.

You may setup some task(s) (crontab on Linux/Mac / Task Manager > Startup on Windows) to run some container(s) right at host startup.

Sources : https://manpages.debian.org/bullseye/cron/crontab.5.en.html / https://www.howtogeek.com/208224/how-to-add-a-program-to-startup-in-windows/

Same way you should strongly save your SQL datas frequently as Docker won't do it for you ; can use task(s) based on mysqldump for that.

Source : https://dev.mysql.com/doc/refman/8.0/en/mysqldump.html

Conclusion

This guide is a work in progress, kept as simple as possible, and will evolve as we find improvements or tricks.

For more details and options you can refer to Docker official documentation here https://docs.docker.com/