flymin / miniflux-telegram-bot

A Telegram bot that sends you new Miniflux articles

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Miniflux Telegram Bot

A Telegram Bot that sends you new Miniflux entries with inline actions to manage your feed.

Setup

  1. Download the latest release
  2. Place the binary somewhere in your path
  3. Set the environment variables outlined below
  4. Start the service
    Note: There is a example Systemd .service file in the contrib folder

Configuration options

Name Default Description
MINIFLUX_URL https://reader.miniflux.app URL for your Miniflux instance
MINIFLUX_API_KEY (Required) nil Your Miniflux API key
MINIFLUX_SLEEP_TIME 30 How many minutes the bot should sleep before checking for new entries
TELEGRAM_BOT_TOKEN (Required) nil Bot token to use with the Telegram API
TELEGRAM_CHAT_ID (Required) 0 The Chat ID the bot should send messages to (You can find your Chat ID by talking to IDBot)
TELEGRAM_POLL_TIMEOUT 120 How many seconds to wait for a notification from Telegram before establishing a new connection
TELEGRAM_SECRET (Required) nil A secret string used to protect callback queries
TELEGRAM_SILENT_NOTIFICATION true Determines whether notifications are delivered silently or not

License

Code released under the MIT license.

About

A Telegram bot that sends you new Miniflux articles

License:MIT License


Languages

Language:Go 89.1%Language:Dockerfile 6.4%Language:Shell 4.5%