https://github.com/fuerbringer/tldr-telegram
:robot: :books: Telegram chatbot frontend for tldr-pages.
https://github.com/fuerbringer/tldr-telegram
redis telegraf telegram telegram-bot tldr tldr-pages
Last synced: 7 months ago
JSON representation
:robot: :books: Telegram chatbot frontend for tldr-pages.
- Host: GitHub
- URL: https://github.com/fuerbringer/tldr-telegram
- Owner: fuerbringer
- License: agpl-3.0
- Created: 2018-02-03T20:33:20.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2018-02-10T15:49:09.000Z (over 7 years ago)
- Last Synced: 2024-10-23T18:15:14.019Z (12 months ago)
- Topics: redis, telegraf, telegram, telegram-bot, tldr, tldr-pages
- Language: JavaScript
- Homepage: https://t.me/tldr_pages_bot
- Size: 454 KB
- Stars: 8
- Watchers: 3
- Forks: 2
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# tldr-telegram
> The tldr pages client for Telegram Messenger.
This free/libre code is currently running at [@tldr_pages_bot](https://t.me/tldr_pages_bot). Try it out and share it in your group chats!
## Screenshot
## 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=
BOT_USERNAME=
GITHUB_TOKEN=
REDIS_HOST=
REDIS_PORT=
LOG_FILE=
```
Note that `REDIS_HOST` and `REDIS_PORT` are optional if you're using `docker-compose` to start the bot.
### Docker installation
With the `.env` file done you're ready to launch your selfhosted `tldr-telegram` bot.
Use `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.
### Useful links
- [Telegram BotFather](https://core.telegram.org/bots#6-botfather)
- [GitHub Token Settings](https://github.com/settings/tokens)
- [fuerbringer/tldr-telegram Docker image](https://hub.docker.com/r/fuerbringer/tldr-telegram/)
## Licensing
### Code
The executable source code is freely available under the [GNU Affero General Public License v3.0](./LICENSE).
### Icon
[The icon files](./icon) are licensed under the [Creative Commons Attribution-ShareAlike 4.0 International License](./icon/LICENSE).
## Privacy
The development of this bot attempts to follow the [Telegram API Terms of Service](https://core.telegram.org/api/terms) as closely as possible to guard the users' privacy. Logger code only retains information necessary to find bugs and keep a high uptime.