Run your own feed reader with Miniflux

Miniflux is a fast, minimal feed reader. You follow websites and blogs, and Miniflux gives you one clean list of everything new, with categories, keyboard shortcuts and an API that many reader apps understand. This guide covers ordering it in the panel, the first login, adding and importing feeds, connecting apps, and what to know about backups and your own domain.

What you get

The panel sets up Miniflux together with its own database, gives it an address with HTTPS and creates an admin account for you. You do not have to walk through an installer. Miniflux keeps everything in its database, so there are no files to look after.

1. Order the app

1. Sign in to the panel, open Apps in the sidebar and click Create App.
2. Under Template, choose Miniflux. You find it under Self-hosted apps.
3. Under Package, pick a package and set the resources with the sliders. Miniflux is very light, so the default resources suit most readers. You can change them later.
4. Under Details, fill in Display name. If a Version field is shown, leave it on Latest (recommended).
5. Tick the confirmation box, click Deploy app and pay.

Miniflux sets itself up on the first start. If the page does not load right after the status shows Running, wait a moment and try again.

2. Log in for the first time

1. On the app page, find the Admin login card and click Reveal. It shows the Username (admin) and the Password of the admin account the panel created.
2. In the Access card, wait for HTTPS active and click Open.
3. Log in with the username and password from the card.

Then change the password: open Settings and set a new one. The Admin login card always shows the password the app started with. Once you change it inside Miniflux, the one in the card no longer works, so save the new one in a password manager.

3. Add your feeds

1. Open Feeds and choose Add subscription.
2. Paste the address of the website or feed. Miniflux finds the feed for you.
3. Pick a category and add it.

Coming from another reader? Export your subscriptions there as an OPML file, then choose Import in Miniflux and upload it.

By default Miniflux checks your feeds about once an hour.

4. Connect an app

Under Settings you find Integrations and API Keys.

• Apps with Miniflux support: choose Miniflux as the account type, enter the address from the Access card and an API key from API Keys. Miniflutt on Android works this way.
• Apps that use Fever or the Google Reader API, such as Reeder, Fiery Feeds or FeedMe: switch the integration on under Integrations, set the username and password it asks for, and use those in the app.

5. Backups

The Backups card lists the backups of your Miniflux. The panel makes them automatically on a schedule that depends on your package, and each backup holds the database, which is where Miniflux keeps everything.

Click Create backup before you update Miniflux or change something big. With Restore you put a backup back. That overwrites everything that changed since the backup, and Miniflux is offline until the restore is done.

All details are in Back up and restore your app.

6. Your own domain

1. On the app page, go to the Custom Domains card and click Add domain.
2. Enter your domain and follow the DNS instructions the panel shows.
3. Wait until the domain shows as verified. HTTPS is set up for you.

The app then restarts briefly, and your first verified domain becomes the main address of your Miniflux. The original address from the Access card keeps working too.

The full steps, including the DNS records, are in Connect your own domain to an app. No domain yet? See Register a domain.

Keeping Miniflux up to date

When a new version is ready, the app page shows Update available with an Update button. Make a backup first, then update.