Table of Contents:
- Why are you not merging my pull-request?
- Why are you not developing my feature request?
- Feature X was available in Miniflux v1?
- Why Miniflux stores favicons into the database?
- How to create themes for Miniflux 2?
- Why there is no plugin system?
- What is “Save this article”?
- How are items removed from the database?
- What “Flush History” does?
- Which binary do I need to use on my Raspberry Pi?
- Which Debian package architecture should I use for my Raspberry Pi?
- Which binary do I need to use on Scaleway ARM machines?
- Which Docker architecture should I use?
- Why SQL migrations are not executed automatically?
- How to backup my data?
Why are you not merging my pull-request? ¶
List of things to avoid:
- Too many changes that would make the pull-request very hard to review
- Breaking changes
- Introduce new bugs, regressions, or security issues
- Add unnecessary dependencies
- Slowing down the software
- Changes are against the philosophy of the software
- Poor code quality
- Chaining pull-requests that depends from each other
- Radical user interface changes
Why are you not developing my feature request? ¶
- Developing a software takes a lot of time.
- This is a free and open source project, no one owes you anything.
- If you miss something, contribute to the project.
- Don’t expect anyone to work for free.
- As mentioned previously, the number of features is voluntarily limited. Nobody likes bloatware.
- Improving existing features is more important than adding new ones.
Feature X was available in Miniflux v1? ¶
Miniflux 2 doesn’t try to reimplement all features of Miniflux 1. The minimalist approach is pushed a little bit further.
If you really miss something, you must contribute to the project, but remember, you have to keep the minimalist philosophy of Miniflux.
Why Miniflux stores favicons into the database? ¶
Miniflux follows the the Twelve Factors principle. Nothing is stored on the local file system. The application is designed to run on ephemeral containers without persistent storage.
How to create themes for Miniflux 2? ¶
As of now, Miniflux 2 doesn’t have any mechanism to load external stylesheets to avoid dependencies. Themes are embedded into the binary.
If you would like to submit a new official theme, you must send a pull-request. But do not forget that you will have to maintain your theme over the time, otherwise, your theme will be removed from the code base.
Why there is no plugin system? ¶
- Because this software has a minimalist approach.
- Because implementing a plugin system increase the complexity of the software.
- Because people do not maintain their plugins after a while.
What is "Save this article"? ¶
“Save” sends the feed entry to third-party services like Pinboard or Instapaper if configured.
How are items removed from the database? ¶
Entry status in the database follows this flow: read -> unread -> removed.
Entries marked as removed are not visible in the web ui. They are deleted from the database only when they are not visible anymore in the original feed.
Entries marked as favorite are never deleted (column starred in the entries table).
Data retention is also controlled with the variables CLEANUP_ARCHIVE_UNREAD_DAYS and CLEANUP_ARCHIVE_READ_DAYS.
Keep in mind that Postgres needs to run the VACUUM command to reclaim disk space.
What "Flush History" does? ¶
“Flush History” changes the status of entries from “read” to “removed” (except for bookmarks). Entries with the status “removed” are not visible in the user interface.
Which binary do I need to use on my Raspberry Pi? ¶
| Raspberry Pi Model | Miniflux Binary |
|---|---|
| A, A+, B, B+, Zero | miniflux-linux-armv6 (32 bits) |
| 2 and 3 | miniflux-linux-armv7 (32 bits) |
| 3 and 4 | miniflux-linux-arm64 (64 bits) |
Which Debian package architecture should I use for my Raspberry Pi? ¶
| Raspberry Pi Model | Debian Package Architecture |
|---|---|
| A, A+, B, B+, Zero | Not supported yet |
| 2 and 3 | armhf (32 bits) |
| 3 and 4 | arm64 (64 bits) |
Which binary do I need to use on Scaleway ARM machines? ¶
| Server Type | Miniflux Binary | uname -m |
|---|---|---|
| Scaleway C1 | miniflux-linux-armv6 | armv7l |
| Scaleway ARM64 | miniflux-linux-armv8 | aarch64 |
Which Docker architecture should I use? ¶
Pulling the latest tag or a specific version should download the correct image according to your machine.
| Docker Architecture | uname -m | Example |
|---|---|---|
| amd64 | x86_64 | |
| arm32v6 | armhf | Raspberry Pi |
| arm32v6 | armv7l | Scaleway C1 |
| arm64v8 | aarch64 | Scaleway ARM64 |
If you use the wrong architecture, Docker will returns an error like this one:
standard_init_linux.go:178: exec user process caused "exec format error"
Multi-arch Docker images are available only since Miniflux 2.0.12.
Why SQL migrations are not executed automatically? ¶
- Because it’s a source of problems.
- Only one process should manipulate the database schema at once.
- If you run multiple containers with an orchestrator that may cause issues.
- You can still run the migrations by defining the variable
RUN_MIGRATIONS=1.
How to backup my data? ¶
Refer to the official Postgres documentation for details about backing up and restoring a Postgres database.
Basic SQL dump example:
# Backup
pg_dump miniflux2 -f miniflux.dump
# Restore
psql miniflux2 < miniflux.dump
There many other options available, refer to the official documentation of pg_dump and pg_restore.