The tldr pages client for Telegram Messenger.
This free/libre code is currently running at @tldr_pages_bot. Try it out and share it in your group chats!
Installing / Getting started
This bot can be run with Docker or simply
npm start. In both cases
.env needs to be populated with the following environment variables:
NODE_ENV=production BOT_TOKEN=<TELEGRAMBOTFATHERTOKEN> BOT_USERNAME=<TELEGRAMBOTUSERNAME> GITHUB_TOKEN=<GITHUBTOKEN> REDIS_HOST=<REDISIP> REDIS_PORT=<REDISPORT> LOG_FILE=<LOGFILENAME>
REDIS_PORT are optional if you're using
docker-compose to start the bot.
.env file done you're ready to launch your selfhosted
docker run -d fuerbringer/tldr-telegram to get up and running quickly. Alternatively you can clone this repository and execute
docker-compose up -d for a more unified solution with both the bot and redis containerized.
The executable source code is freely available under the GNU Affero General Public License v3.0.
The icon files are licensed under the Creative Commons Attribution-ShareAlike 4.0 International License.
The development of this bot attempts to follow the Telegram API Terms of Service as closely as possible to guard the users' privacy. Logger code only retains information necessary to find bugs and keep a high uptime.