Integration with External Services
External services available:
Fever API ¶
Miniflux implements the Fever API in addition to its own REST API. The Fever API allows you to use existing mobile applications to read your feeds instead of the web user interface.
To activate the Fever API, go to the integration section and choose a username/password.
- Reeder (iOS/macOS)
- Unread (iOS)
- FeedMe (Android)
- NewsFlash (Linux)
- Fluent Reader (Windows and Mac)
- Saving an entry will add a new bookmark and save the article
- Only the JSON format is supported
- Refreshing feeds is not possible with Reeder because no user information is sent
- Links, sparks, and kindlings are not supported
Google Reader API ¶
Miniflux implements the Google Reader API.
To activate the Google Reader API, go to the integration section and choose a username/password.
- Reeder >= 5 (iOS/macOS)
You could save articles to Pinboard.
To activate this service, go to the integration section and enter your Pinboard API credentials. You must use the API token, not your password.
You could save articles to Instapaper.
To activate this service, go to the integration section and enter your Instapaper credentials.
To configure the Pocket integration on your own Miniflux instance, you need to create an application on Pocket’s website.
Go to https://getpocket.com/developer/apps/new and create a new application.
- You can define the Pocket Consumer Key for all users by using the environment variable
- Or, you can set the Pocket Consumer Key only for your user by using the form and hitting the update button.
If the environment variable is defined, the text field for the Pocket Consumer API key will be hidden.
Make sure the environment variable
BASE_URL is defined properly to
allow the authorization flow to work afterward, this variable should
point to your current instance address and/or the URL you have
set on your Pocket application.
Once the consumer key is configured, you need to get a Pocket Access Token. This token could be fetched automatically by using the authorization flow or manually by making some HTTP calls.
The simplest solution is to use the link, “Connect your Pocket account”. This method redirects the end user to Pocket’s website and ask for authorization.
After the authorization is given, Miniflux will fetch the Pocket Access Token for you.
If you prefer to fetch Pocket Access Token manually, the process is described in Pocket’s developer documentation.
Wallabag is a self-hosted application for saving web pages.
- The API URL is the root URL of your instance, for example, if you have the hosted version use:
- To create a new API client, go to the section “API clients management” and choose “Create a new client”.
Send only URLis checked, Miniflux sends only the URL of the item being saved, instead of the item’s page body content.
Nunux Keeper ¶
Nunux Keeper is a “personal content curation service”. It’s an alternative to Pocket or Wallabag.
- The API URL is the root URL of your instance, for example, if you are using the hosted version:
- To create a new API key, go to the settings tab: “API key” and choose “Regenerate API key”.
Telegram Bot ¶
Telegram is a free, cross-platform, cloud-based instant messaging software. You can enable integration via Telegram Bot API and new entries will be pushed to the specific chat when fetched.
You should Create a bot using @BotFather and get the bot token from it.
Then invite @getidsbot to your channel or group,
or just send
/about to the bot if you want to push the message to the direct message chat to you.
Get the chat id field from the message. You can stop or remove the bot after getting the id.
Now invite your bot to your channel or group, or send some message to it if you want to push the message to the direct message.
Fill in the values and enable the telegram bot integration in miniflux, and new entries should be pushed to the chat you have selected now.