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 ¶
DEBUGToggle debug mode (increase log level).
Disabled by default.
FETCH_YOUTUBE_WATCH_TIMESet the value to 1 to scrape video duration from YouTube website and use it as a reading time.
Disabled by default.
LOG_DATE_TIMEShow date and time in log messages.
Disabled by default.
WORKER_POOL_SIZENumber of background workers to refresh feeds.
Default is 5 workers.
POLLING_FREQUENCYRefresh interval in minutes for feeds.
Default is 60 minutes.
POLLING_PARSING_ERROR_LIMITThe 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_SIZENumber of feeds to send to the queue for each interval.
Default is 100 feeds.
POLLING_SCHEDULERScheduler used for polling feeds. Possible values are
round_robinorentry_frequency.The maximum number of feeds polled for a given period is subject to
POLLING_FREQUENCYandBATCH_SIZE.When
entry_frequencyis 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.SCHEDULER_ENTRY_FREQUENCY_MAX_INTERVALMaximum interval in minutes for the entry frequency scheduler.
Default is 24 hours.
SCHEDULER_ENTRY_FREQUENCY_MIN_INTERVALMinimum interval in minutes for the entry frequency scheduler.
Default is 5 minutes.
DATABASE_URLPostgresql connection parameters. See lib/pq for more details.
Default is
user=postgres password=postgres dbname=miniflux2 sslmode=disableDATABASE_MAX_CONNSMaximum number of database connections.
Default is
20DATABASE_MIN_CONNSMinimum number of database connections.
Default is
1DATABASE_CONNECTION_LIFETIMESet the maximum amount of time a connection may be reused.
Default is 5 minutes
LISTEN_ADDRAddress to listen on. Use absolute path for a Unix socket.
Default is
127.0.0.1:8080.PORTOverride
LISTEN_ADDRto0.0.0.0:$PORT(Automatic configuration for PaaS).Default is empty.
BASE_URLBase URL to generate HTML links and base path for cookies.
Default is
http://localhost/.CLEANUP_FREQUENCY_HOURSCleanup job frequency to remove old sessions and archive entries.
Default is 24 hours.
CLEANUP_ARCHIVE_UNREAD_DAYSNumber of days after marking unread items as removed. Use
-1to disable this feature.Default is 180 days.
CLEANUP_ARCHIVE_READ_DAYSNumber of days after which marking read items as removed. Use
-1to disable this feature.Default is 60 days.
CLEANUP_ARCHIVE_BATCH_SIZENumber of entries to archive for each job interval.
Default is 10000 entries.
CLEANUP_REMOVE_SESSIONS_DAYSNumber of days after removing old user sessions from the database.
Default is 30 days.
HTTPSForces cookies to use secure flag. Send HSTS HTTP header. Enabled automatically if the HTTP header
X-Forwarded-Protois set tohttps.Default is empty.
DISABLE_HSTSDisable HTTP Strict Transport Security header if
$HTTPSis set.Default is empty.
DISABLE_HTTP_SERVICEDisable HTTP service.
Default is empty.
DISABLE_SCHEDULER_SERVICEDisable scheduler service.
Default is empty.
CERT_FILEPath to SSL certificate.
Default is empty.
KEY_FILEPath to SSL private key.
Default is empty.
CERT_DOMAINUse Let's Encrypt to get automatically a certificate for the domain specified in
$CERT_DOMAIN.Default is empty.
METRICS_COLLECTORSet to
1to enable metrics collection. It exposes a/metricsendpoint that can be used with Prometheus Monitoring software.Disabled by default.
METRICS_REFRESH_INTERVALRefresh interval to collect database metrics.
Default is 60 seconds.
METRICS_ALLOWED_NETWORKSList of networks allowed to access the
/metricsendpoint (comma-separated values).Default is
127.0.0.1/8.METRICS_USERNAMEMetrics endpoint username for basic HTTP authentication.
Default is empty.
METRICS_USERNAME_FILEPath to a file that contains the username for the metrics endpoint HTTP authentication.
Default is empty.
METRICS_PASSWORDMetrics endpoint password for basic HTTP authentication.
Default is empty.
METRICS_PASSWORD_FILEPath to a file that contains the password for the metrics endpoint HTTP authentication.
Default is empty.
OAUTH2_PROVIDEROAuth2 provider. Possible values are
googleoroidcfor a generic OpenID Connect provider.Default is empty.
OAUTH2_CLIENT_IDOAuth2 client ID.
Default is empty.
OAUTH2_CLIENT_ID_FILEPath to a client ID exposed as a file, it should contain
$OAUTH2_CLIENT_IDvalue.Default is empty.
OAUTH2_CLIENT_SECRETOAuth2 client secret.
Default is empty.
OAUTH2_CLIENT_SECRET_FILEPath to a secret key exposed as a file, it should contain
$OAUTH2_CLIENT_SECRETvalue.Default is empty.
OAUTH2_REDIRECT_URLOAuth2 redirect URL. This URL must be registered with the provider and is something like
https://miniflux.example.org/oauth2/oidc/callbackDefault is empty.
OAUTH2_OIDC_DISCOVERY_ENDPOINTOpenID Connect discovery endpoint.
Default is empty.
OAUTH2_USER_CREATIONSet to
1to authorize OAuth2 user creation.Default is empty.
RUN_MIGRATIONSSet to
1to run database migrations during application startup.Default is empty.
CREATE_ADMINSet to
1to create an admin user from environment variables.Default is empty.
ADMIN_USERNAMEAdmin user login, it's used only if
CREATE_ADMINis enabled.Default is empty.
ADMIN_USERNAME_FILEPath to a secret key exposed as a file, it should contain
$ADMIN_USERNAMEvalue.Default is empty.
ADMIN_PASSWORDAdmin user password, it's used only if
CREATE_ADMINis enabled.Default is empty.
ADMIN_PASSWORD_FILEPath to a secret key exposed as a file, it should contain
$ADMIN_PASSWORDvalue.Default is empty.
POCKET_CONSUMER_KEYPocket consumer API key for all users.
Default is empty.
POCKET_CONSUMER_KEY_FILEPath to a secret key exposed as a file, it should contain
$POCKET_CONSUMER_KEYvalue.Default is empty.
PROXY_OPTIONAvoids mixed content warnings for external media:
http-only,all, ornone.Default is
http-only.PROXY_MEDIA_TYPESA list of media types to proxify (comma-separated values):
image,audio,video.Default is
image.PROXY_HTTP_CLIENT_TIMEOUTTime limit in seconds before the proxy HTTP client cancel the request.
Default is 120 seconds.
PROXY_URLSets a server to proxy media through.
Default is empty, miniflux does the proxying.
HTTP_CLIENT_TIMEOUTTime limit in seconds before the HTTP client cancel the request.
Default is 20 seconds.
HTTP_CLIENT_MAX_BODY_SIZEMaximum body size for HTTP requests in Mebibyte (MiB).
Default is 15 MiB.
HTTP_CLIENT_PROXYProxy 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_PROXYorHTTPS_PROXY, look at the official Golang documentation for more details.Default is empty.
HTTP_CLIENT_USER_AGENTThe 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_HEADERProxy authentication HTTP header.
Default is empty.
AUTH_PROXY_USER_CREATIONEnable user creation based on proxy authentication information.
Default is empty.
MAINTENANCE_MODESet to 1 to enable maintenance mode. Maintenance mode disables the web ui and show a text message to the users.
Default is empty.
MAINTENANCE_MESSAGEDefine a custom maintenance message.
Default is empty.
SERVER_TIMING_HEADERSet the value to 1 to enable server-timing headers.
Default is empty.
WATCHDOGEnable or disable Systemd watchdog.
Enabled by default.
INVIDIOUS_INSTANCESet a custom invidious instance to use.
Default is yewtu.be.
Configuration File ¶
The configuration file is optional. It’s a text file that follow these rules:
- Miniflux expects each line to be in
KEY=VALUEformat. - 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.
Database Connection Parameters ¶
Miniflux uses the Golang library pq to communicate with PostgreSQL. The list of connection parameters are available on this page.
The default value for DATABASE_URL is user=postgres password=postgres dbname=miniflux2 sslmode=disable.
You could also use the URL format postgres://postgres:postgres@localhost/miniflux2?sslmode=disable.
net/url: invalid userinfo.
To avoid this issue, do not use the URL format for DATABASE_URL or make sure the password is URL encoded.