MINIFLUX(1)   MINIFLUX(1)

miniflux - Minimalist and opinionated feed reader

miniflux [-vic] [-create-admin] [-debug] [-flush-sessions] [-info] [-migrate]
[-reset-feed-errors] [-reset-password] [-version] [-config-file] [-config-dump]

miniflux is a minimalist and opinionated feed reader.

-c

Load configuration file.

-config-file

Load configuration file.

-config-dump

Print parsed configuration values.

-create-admin

Create admin user.

-debug

Show debug logs.

-flush-sessions

Flush all sessions (disconnect users).

-healthcheck

Perform a health check on the given endpoint.
The value "auto" try to guess the health check endpoint.

-i

Show application information.

-info

Show application information.

-migrate

Run SQL migrations.

-reset-feed-errors

Clear all feed errors for all users.

-reset-password

Reset user password.

-v

Show application version.

-version

Show application version.

The configuration file is a text file that follow these rules:

- Miniflux expects each line to be in KEY=VALUE format.
- Lines beginning with # are processed as comments and ignored.
- Blank lines are ignored.
- There is no variable interpolation.

Keys are the same as the environment variables described below.
Environment variables override the values defined in the config file.

Set the value to 1 to enable debug logs.
Disabled by default.
Set the value to 1 to scrape video duration from YouTube website and use it as a reading time.
Disabled by default.
Set the value to 1 to enable server-timing headers.
Disabled by default.
Display the date and time in log messages.
Disabled by default.
Number of background workers.
Default is 5 workers.
Refresh interval in minutes for feeds.
Default is 60 minutes.
Number of feeds to send to the queue for each interval.
Default is 100 feeds.
Scheduler used for polling feeds. Possible values are "round_robin" or "entry_frequency".
The maximum number of feeds polled for a given period is subject to POLLING_FREQUENCY and BATCH_SIZE.
When "entry_frequency" is selected, the refresh interval for a given feed is equal to the average updating interval of the last week of the feed.
The actual number of feeds polled will not exceed the maximum number of feeds that could be polled for a given period.
Default is "round_robin".
Maximum interval in minutes for the entry frequency scheduler.
Default is 24 hours.
Minimum interval in minutes for the entry frequency scheduler.
Default is 5 minutes.
The maximum number of parsing errors that the program will try before stopping polling a feed. Once the limit is reached, the user must refresh the feed manually. Set to 0 for unlimited.
Default is 3.
Postgresql connection parameters.
Default is "user=postgres password=postgres dbname=miniflux2 sslmode=disable".
Path to a secret key exposed as a file, it should contain $DATABASE_URL value.
Default is empty.
Set the maximum amount of time a connection may be reused.
Default is 5 minutes.
Maximum number of database connections.
Default is 20.
Minimum number of database connections.
Default is 20.
Address to listen on. Use absolute path to listen on Unix socket (/var/run/miniflux.sock).
Default is 127.0.0.1:8080.
Override LISTEN_ADDR to 0.0.0.0:$PORT.
Default is empty.
Base URL to generate HTML links and base path for cookies.
Default is http://localhost/.
Cleanup job frequency. Remove old sessions and archive entries.
Default is 24 hours.
Number of days after marking read entries as removed.
Set to -1 to keep all read entries.
Default is 60 days.
Number of days after marking unread entries as removed.
Set to -1 to keep all unread entries.
Default is 180 days.
Number of entries to archive for each job interval.
Default is 10000 entries.
Number of days after removing old sessions from the database.
Default is 30 days.
Forces cookies to use secure flag and send HSTS header.
Default is empty.
Disable HTTP Strict Transport Security header if HTTPS is set.
Default is false (The HSTS is enabled).
Set the value to 1 to disable the HTTP service.
Default is false (The HTTP service is enabled).
Set the value to 1 to disable the internal scheduler service.
Default is false (The internal scheduler service is enabled).
Path to SSL certificate.
Default is empty.
Path to SSL private key.
Default is empty.
Use Let's Encrypt to get automatically a certificate for this domain.
Default is empty.
Set to 1 to enable metrics collector. Expose a /metrics endpoint for Prometheus.
Disabled by default.
Refresh interval to collect database metrics.
Default is 60 seconds.
List of networks allowed to access the metrics endpoint (comma-separated values).
Default is 127.0.0.1/8.
Possible values are "google" or "oidc".
Default is empty.
OAuth2 client ID.
Default is empty.
Path to a secret key exposed as a file, it should contain $OAUTH2_CLIENT_ID value.
Default is empty.
OAuth2 client secret.
Default is empty.
Path to a secret key exposed as a file, it should contain $OAUTH2_CLIENT_SECRET value.
Default is empty.
OAuth2 redirect URL.
This URL must be registered with the provider and is something like https://miniflux.example.org/oauth2/oidc/callback.
Default is empty.
OpenID Connect discovery endpoint.
Default is empty.
Set to 1 to authorize OAuth2 user creation.
Disabled by default.
Set to 1 to run database migrations.
Disabled by default.
Set to 1 to create an admin user from environment variables.
Disabled by default.
Admin user login, used only if $CREATE_ADMIN is enabled.
Default is empty.
Path to a secret key exposed as a file, it should contain $ADMIN_USERNAME value.
Default is empty.
Admin user password, used only if $CREATE_ADMIN is enabled.
Default is empty.
Path to a secret key exposed as a file, it should contain $ADMIN_PASSWORD value.
Default is empty.
Pocket consumer API key for all users.
Default is empty.
Path to a secret key exposed as a file, it should contain $POCKET_CONSUMER_KEY value.
Default is empty.
Avoids mixed content warnings for external images: http-only, all, or none.
Default is http-only.
Time limit in seconds before the HTTP client cancel the request.
Default is 20 seconds.
Maximum body size for HTTP requests in Mebibyte (MiB).
Default is 15 MiB.
Proxy URL for HTTP client.
Default is empty.
The default User-Agent header to use for the HTTP client. Can be overridden in per-feed settings.
When empty, Miniflux uses a default User-Agent that includes the Miniflux version.
Default is empty.
Proxy authentication HTTP header.
Default is empty.
Set to 1 to create users based on proxy authentication information.
Disabled by default.
Set to 1 to enable maintenance mode.
Disabled by default.
Define a custom maintenance message.
Default is "Miniflux is currently under maintenance".
Enable or disable Systemd watchdog.
Enabled by default.
Set a custom invidious instance to use.
Default is yewtu.be.

Miniflux is written and maintained by Frédéric Guillot.

Miniflux is released under the Apache 2.0 license.

January 5, 2022