Skip to content

arebaka/tgbooru

Repository files navigation

Telegram Booru

Maybe you meant: Unlimited Telegram Gallery

A builtin personal inline booru for Telegram.

demo demo

Commands

/help – display all commands
/lang – change the language bot speaks
/add <tags...> – add a media to your booru
/delete – delete the media from your booru
/info – display some information about the media
/replace <tags...> – replace all tags of the media
/addtag <tags...> – add one or more tags of the media
/deltag <tags...> – remove one or more tags from the media
/edittag <old> <new> – replace the any tag everywhere
/stats – display your summary

Supported media types

  • 🖼️ photo
  • 📹 GIF
  • 🎬 video

TLDR

  1. Create and setup a bot via @BotFather
  2. Install PostgreSQL if you didnt
  3. Create an empty database 'tgbooru' in PSQL owned to your user
  4. Install npm & node.js
  5. npm i tgbooru
  6. export TOKEN=<TOKEN_FROM_BOTFATHER>
  7. npx tgbooru
  8. To stop the bot type to console with it stop and press enter

Preparing

  1. Create your bot via @BotFather, it will guide you on that
  2. The bot uses DBMS PostgreSQL. Install if you dont have it
  3. Create a database in PSQL for you bot
  4. The bot works using node.js. Install it

Installation

npm i tgbooru

Launch

The bot requires some environment variables. Here is a list of them:
TOKEN – bot token from @BotFather
DBURI – URI-string for connection to PSQL in format postgres://<USER>:<PASSWORD>@<HOST>/<DATABASE>:<PORT>

Instead of the environment you can set launch parameters in a file config.toml.

After setup the environment run

npx tgbooru

If everything went well, you will see something like this in the console:

> tgbooru@1.0.0 start
> node index.js

Bot @myboorubot started.
> _

Control

After the launch, there are available commands stop & reload for safe stop and restart respectively.

Usage

To see how the bot works, you can refer to @myboorubot.
So far, the bot doesnt use any query language, just returning media with all given tags.

Support

If something doesnt work, or you just wanna talk to the bot creator or his mom, write @arelive. There also accepted kicks from volunteer project managers.