Configuration Parameters
Miniflux can use a configuration file and environment variables.
The configuration file is loaded first if specified. Environment variables takes precedence over the options defined in the configuration file.
Configuration Options ¶
DEBUG
(deprecated in favor ofLOG_LEVEL
)Toggle debug mode (increase log level).
Disabled by default.
FETCH_BILIBILI_WATCH_TIME
Set the value to 1 to scrape video duration from Bilibili website and use it as a reading time.
Disabled by default.
FETCH_NEBULA_WATCH_TIME
Set the value to 1 to scrape video duration from Nebula website and use it as a reading time.
Disabled by default.
FETCH_ODYSEE_WATCH_TIME
Set the value to 1 to scrape video duration from Odysee website and use it as a reading time.
Disabled by default.
FETCH_YOUTUBE_WATCH_TIME
Set the value to 1 to scrape video duration from YouTube website and use it as a reading time.
Disabled by default.
YOUTUBE_EMBED_URL_OVERRIDE
YouTube URL which will be used for embeds.
Default is https://www.youtube-nocookie.com/embed/
LOG_DATE_TIME
Show date and time in log messages.
Disabled by default.
LOG_FILE
Supported values are
stderr
,stdout
, or a file name.Default is
stderr
.LOG_FORMAT
Supported log formats are
text
orjson
.Default is
text
.LOG_LEVEL
Supported values are
debug
,info
,warning
, orerror
.Default is
info
.WORKER_POOL_SIZE
Number of background workers to refresh feeds. Workers fetch information of feeds from a work queue.
Default is 5 workers.
POLLING_FREQUENCY
The interval in minutes that miniflux adds qualified feeds to the work queue.
Default is 60 minutes.
POLLING_PARSING_ERROR_LIMIT
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.
BATCH_SIZE
The maximum number of feeds to send to the work queue for each polling interval.
The actual number of feeds added to the work queue is subject to the scheduler.
Default is 100.
FORCE_REFRESH_INTERVAL
The minimum interval for manual refresh.
Default is 30 minutes.
POLLING_SCHEDULER
Scheduler used for polling feeds. Possible values are
round_robin
orentry_frequency
.The scheduler does not alter the polling interval, instead it throttles the number of qualified feeds for polling. The feeds will be added to the work queue, when the current time exceeds the targeting refreshing time. The maximum number of feeds polled for a given period is subject to
POLLING_FREQUENCY
andBATCH_SIZE
.When
entry_frequency
is selected, the targeting refreshing 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
.SCHEDULER_ENTRY_FREQUENCY_FACTOR
Factor to increase refresh frequency for the entry frequency scheduler.
Default is 1.
SCHEDULER_ENTRY_FREQUENCY_MAX_INTERVAL
Maximum interval in minutes for the entry frequency scheduler.
Default is 24 hours.
SCHEDULER_ENTRY_FREQUENCY_MIN_INTERVAL
Minimum interval in minutes for the entry frequency scheduler.
Default is 5 minutes.
SCHEDULER_ROUND_ROBIN_MIN_INTERVAL
Minimum interval in minutes for the round robin scheduler.
Default is 60 minutes.
DATABASE_URL
Postgresql connection parameters. See lib/pq for more details.
Default is
user=postgres password=postgres dbname=miniflux2 sslmode=disable
DATABASE_MAX_CONNS
Maximum number of database connections.
Default is
20
DATABASE_MIN_CONNS
Minimum number of database connections.
Default is
1
DATABASE_CONNECTION_LIFETIME
Set the maximum amount of time a connection may be reused.
Default is 5 minutes
LISTEN_ADDR
Address to listen on. Use absolute path for a Unix socket.
Default is
127.0.0.1:8080
.PORT
Override
LISTEN_ADDR
to0.0.0.0:$PORT
(Automatic configuration for PaaS).Default is empty.
BASE_URL
Base URL to generate HTML links and base path for cookies.
Default is
http://localhost/
.CLEANUP_FREQUENCY_HOURS
Cleanup job frequency to remove old sessions and archive entries.
Default is 24 hours.
CLEANUP_ARCHIVE_UNREAD_DAYS
Number of days after marking unread items as removed. Use
-1
to disable this feature.Default is 180 days.
CLEANUP_ARCHIVE_READ_DAYS
Number of days after which marking read items as removed. Use
-1
to disable this feature.Default is 60 days.
CLEANUP_ARCHIVE_BATCH_SIZE
Number of entries to archive for each job interval.
Default is 10000 entries.
CLEANUP_REMOVE_SESSIONS_DAYS
Number of days after removing old user sessions from the database.
Default is 30 days.
FILTER_ENTRY_MAX_AGE_DAYS
Number of days after which new entries should be retained. Set 7 to fetch only entries 7 days old.
Default is 30 days.
HTTPS
Forces cookies to use secure flag. Send HSTS HTTP header. Enabled automatically if the HTTP header
X-Forwarded-Proto
is set tohttps
.Default is 0 (disabled).
DISABLE_HSTS
Disable HTTP Strict Transport Security header if
$HTTPS
is set.Default is empty.
DISABLE_HTTP_SERVICE
Disable HTTP service.
Default is empty.
DISABLE_LOCAL_AUTH
Disable local authentication.
When set to true, the username/password form is hidden from the login screen, and the options to change username/password or unlink OAuth2 account are hidden from the settings page.
Default is empty.
DISABLE_SCHEDULER_SERVICE
Disable scheduler service.
Default is empty.
CERT_FILE
Path to SSL certificate.
Default is empty.
KEY_FILE
Path to SSL private key.
Default is empty.
CERT_DOMAIN
Use Let's Encrypt to get automatically a certificate for the domain specified in
$CERT_DOMAIN
.Default is empty.
MEDIA_PROXY_MODE
Avoids mixed content warnings for external media. Possible values:
http-only
,all
, ornone
.Default is
http-only
.MEDIA_PROXY_PRIVATE_KEY
Set a custom custom private key used to sign proxified media URLs.
By default, a secret key is randomly generated during startup.
MEDIA_PROXY_RESOURCE_TYPES
A comma-separated list of media types to proxify. Supported values are:
image
,audio
,video
.Default is
image
.MEDIA_PROXY_HTTP_CLIENT_TIMEOUT
Time limit in seconds before the proxy HTTP client cancel the request.
Default is 120 seconds.
MEDIA_PROXY_CUSTOM_URL
Sets a server to proxy media through.
Default is empty, miniflux does the proxying.
METRICS_COLLECTOR
Set to
1
to enable metrics collection. It exposes a/metrics
endpoint that can be used with Prometheus Monitoring software.Disabled by default.
METRICS_REFRESH_INTERVAL
Refresh interval to collect database metrics.
Default is 60 seconds.
METRICS_ALLOWED_NETWORKS
List of networks allowed to access the
/metrics
endpoint (comma-separated values).Default is
127.0.0.1/8
.METRICS_USERNAME
Metrics endpoint username for basic HTTP authentication.
Default is empty.
METRICS_USERNAME_FILE
Path to a file that contains the username for the metrics endpoint HTTP authentication.
Default is empty.
METRICS_PASSWORD
Metrics endpoint password for basic HTTP authentication.
Default is empty.
METRICS_PASSWORD_FILE
Path to a file that contains the password for the metrics endpoint HTTP authentication.
Default is empty.
OAUTH2_PROVIDER
OAuth2 provider. Possible values are
google
oroidc
for a generic OpenID Connect provider.Default is empty.
OAUTH2_CLIENT_ID
OAuth2 client ID.
Default is empty.
OAUTH2_CLIENT_ID_FILE
Path to a client ID exposed as a file, it should contain
$OAUTH2_CLIENT_ID
value.Default is empty.
OAUTH2_CLIENT_SECRET
OAuth2 client secret.
Default is empty.
OAUTH2_CLIENT_SECRET_FILE
Path to a secret key exposed as a file, it should contain
$OAUTH2_CLIENT_SECRET
value.Default is empty.
OAUTH2_REDIRECT_URL
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.
OAUTH2_OIDC_DISCOVERY_ENDPOINT
OpenID Connect discovery endpoint.
Note that the OIDC library automatically appends the
.well-known/openid-configuration
, this part has to be removed from the URL when settingOAUTH2_OIDC_DISCOVERY_ENDPOINT
.Default is empty.
OAUTH2_USER_CREATION
Set to
1
to authorize OAuth2 user creation.Default is empty.
RUN_MIGRATIONS
Set to
1
to run database migrations during application startup.Default is empty.
CREATE_ADMIN
Set to
1
to create an admin user from environment variables.Default is empty.
ADMIN_USERNAME
Admin user login, it's used only if
CREATE_ADMIN
is enabled.Default is empty.
ADMIN_USERNAME_FILE
Path to a secret key exposed as a file, it should contain
$ADMIN_USERNAME
value.Default is empty.
ADMIN_PASSWORD
Admin user password, it's used only if
CREATE_ADMIN
is enabled.Default is empty.
ADMIN_PASSWORD_FILE
Path to a secret key exposed as a file, it should contain
$ADMIN_PASSWORD
value.Default is empty.
POCKET_CONSUMER_KEY
Pocket consumer API key for all users.
Default is empty.
POCKET_CONSUMER_KEY_FILE
Path to a secret key exposed as a file, it should contain
$POCKET_CONSUMER_KEY
value.Default is empty.
HTTP_CLIENT_TIMEOUT
Time limit in seconds before the HTTP client cancel the request.
Default is 20 seconds.
HTTP_CLIENT_MAX_BODY_SIZE
Maximum body size for HTTP requests in Mebibyte (MiB).
Default is 15 MiB.
HTTP_CLIENT_PROXY
Proxy URL for the HTTP client. For example:
http://127.0.0.1:8888
.This proxy is used only when the feed has the option "Fetch via proxy" enabled.
If you prefer to have a proxy for all outgoing requests, use the environment variables
HTTP_PROXY
orHTTPS_PROXY
, look at the official Golang documentation for more details.Default is empty.
HTTP_CLIENT_USER_AGENT
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.
AUTH_PROXY_HEADER
Proxy authentication HTTP header.
Default is empty.
AUTH_PROXY_USER_CREATION
Enable user creation based on proxy authentication information.
Default is empty.
MAINTENANCE_MODE
Set to 1 to enable maintenance mode. Maintenance mode disables the web ui and show a text message to the users.
Default is empty.
MAINTENANCE_MESSAGE
Define a custom maintenance message.
Default is empty.
SERVER_TIMING_HEADER
Set the value to 1 to enable server-timing headers.
Default is empty.
WATCHDOG
Enable or disable Systemd watchdog.
Enabled by default.
INVIDIOUS_INSTANCE
Set a custom invidious instance to use.
Default is yewtu.be.
WEBAUTHN
Enable or disable WebAuthn/Passkey authentication.
Default is disabled
Configuration File ¶
The configuration file is optional. It’s 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 above.
Example:
DEBUG=on
WORKER_POOL_SIZE=20
Environment variables override the values defined in the config file.
To specify a configuration file, use the command line argument -config-file
or -c
.
You can also dump interpreted values with the flag -config-dump
for debugging.
Systemd uses the file /etc/miniflux.conf
to populate environment variables.