Skip to content

Latest commit

 

History

History
59 lines (48 loc) · 1.79 KB

README.md

File metadata and controls

59 lines (48 loc) · 1.79 KB

Vocabacov

Telegram bot to enlarge your vocabulary.

Environment variables

Name Mandatory Default value Description
VOCABACOV_TOKEN yes Telegram bot token.
VOCABACOV_CHANNELS yes Comma delimited ids of telegram bot channels.
VOCABACOV_DEBUG no false Debug logging enabled/disabled.
VOCABACOV_TIMEOUT no 30 Request timeout to wait for an update.

Run

To run bot with telegram token YOUR_TELEGRAM_BOT_TOKEN, channel 36484 and mapping volume database file /db/vocabacov.db to you host's current directory:

touch $(pwd)/vocabacov.db

docker run -d \
--name vocabacov \
-e VOCABACOV_TOKEN=YOUR_TELEGRAM_BOT_TOKEN \
-e VOCABACOV_CHANNELS=36484 \
-v $(pwd)/vocabacov.db:/db/vocabacov.db \
ghcr.io/karlovskiy/vocabacov:latest

Telegram bot

To create telegram bot follow this guide.

Commands

Vocabacov bot accepts commands in the format

/lang
phrase
translation

where lang is ISO-3166 Alpha-2 code, phrase is one or more words and translation is a translation (could be also definition or description).

Examples:

/en 
hello world
say hi to the world

This bot saves submitted words in the sqlite3 database, and you can use sqlite3 to query phrases table.

$ sqlite3
SQLite version 3.38.2 2022-03-26 13:51:10
Enter ".help" for usage hints.
Connected to a transient in-memory database.
Use ".open FILENAME" to reopen on a persistent database.
sqlite> .open vocabacov.db
sqlite> select * from phrases;