Using in Docker#

Installing#

Installing from Dockerhub#

We have few tags:

latest - Latest project release.
dev - Latest possible project version. Use this only for testing, it always can have breaking changes.
x.y.z - Project release in Semantic Versions style.

Every of those tags also have duplicates with database suffixes, at now it can be sqlite, mysql or postgresql. As example, for tag latest there also will be available tag latest-sqlite.

Tag without suffix - standard database. At now, it is sqlite. It means that tag latest is the same as latest-sqlite.

There are few deprecated tags, which are still available only for history. It is main, rewrite and newdb.

Warning

If you use non-sqlite database, you need to apply database migrations manually. In sqlite, migrations are applied automatically while we compile the image. See Database migrations for details.

Self compilation#

You can compile images from project’s root. To make this, you just need to run the command:

docker build -t perchunpak/pingerbot . --build-arg dialect=sqlite

Where --build-arg dialect=sqlite - parameter, which defines database, what you want to use. Instead of sqlite you can set any supported.

Warning

If you use non-sqlite database, you need to apply database migrations manually. In sqlite, migrations are applied automatically while we compile the image. See Database migrations for details.

Run#

To run the bot, in both cases of installation, use this command:

docker run --name pingerbot -d perchunpak/pingerbot

If you want to use sqlite, you also need to set -v YOUR_FOLDER:/app/pinger/data option (Where YOUR_FOLDER it is a folder with your database file. I recommend to set absolute path.) This is needed to save database in case of container restart. This parameter must be set between -d flag and perchunpak/pingerbot.

You also have to set -e option for every configuration parameter. This option just set environment variables, interface will be the same as in config.yml, but all parameters keys in upper case.

They should be used like -e KEY=VALUE, where KEY upper cased key from config.yml (example DISCORD_TOKEN), and VALUE is a value.

Same as -v option, they must be set between -d flag and perchunpak/pingerbot.

Since version 0.4.0 the container runs in non-root mode, which means that if you use the sqlite tag and a -v option, you have to give rights to the folder. This can be done with the command chown -R 5000:5000 <your folder>.

This doesn’t apply to Windows users.