miniflux/miniflux.1 at master · xqin/miniflux

Repository navigation

.\" Manpage for miniflux.
.TH "MINIFLUX" "1" "August 18, 2024" "\ \&" "\ \&"
miniflux \- Minimalist and opinionated feed reader
.SH SYNOPSIS
\fBminiflux\fR [-vic] [-config-dump] [-config-file] [-create-admin] [-debug] [-flush-sessions]
    [-healthcheck] [-info] [-migrate] [-refresh-feeds] [-reset-feed-errors] [-reset-password]
    [-run-cleanup-tasks] [-version]
.SH DESCRIPTION
\fBminiflux\fR is a minimalist and opinionated feed reader.
.SH OPTIONS
.B \-config-dump
Print parsed configuration values. This will include sensitive information like passwords\&.
.B \-c /path/to/miniflux.conf
Load configuration file\&.
.B \-config-file /path/to/miniflux.conf
Load configuration file\&.
.B \-create-admin
Create an admin user from an interactive terminal\&.
Set log level to debug\&.
.B \-export-user-feeds <username>
Export user feeds (provide the username as argument)\&.
Example: "miniflux -export-user-feeds someone > feeds.xml"\&.
.B \-flush-sessions
Flush all sessions (disconnect users)\&.
.B \-healthcheck <endpoint>
Perform a health check on the given endpoint\&.
The value "auto" try to guess the health check endpoint\&.
Show build information\&.
Show build information\&.
.B \-migrate
Run SQL migrations\&.
.B \-refresh-feeds
Refresh a batch of feeds and exit\&.
.B \-reset-feed-errors
Clear all feed errors for all users\&.
.B \-reset-password
Reset user password\&.
.B \-run-cleanup-tasks
Run cleanup tasks (delete old sessions and archives old entries)\&.
Show application version\&.
.B \-version
Show application version\&.
.SH CONFIGURATION FILE
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.
.SH ENVIRONMENT
.B ADMIN_PASSWORD
Admin user password, used only if $CREATE_ADMIN is enabled\&.
Default is empty\&.
.B ADMIN_PASSWORD_FILE
Path to a secret key exposed as a file, it should contain $ADMIN_PASSWORD value\&.
Default is empty\&.
.B ADMIN_USERNAME
Admin user login, used only if $CREATE_ADMIN is e
8000
nabled\&.
Default is empty\&.
.B ADMIN_USERNAME_FILE
Path to a secret key exposed as a file, it should contain $ADMIN_USERNAME value\&.
Default is empty\&.
.B AUTH_PROXY_HEADER
Proxy authentication HTTP header\&.
Default is empty.
.B AUTH_PROXY_USER_CREATION
Set to 1 to create users based on proxy authentication information\&.
Disabled by default\&.
.B BASE_URL
Base URL to generate HTML links and base path for cookies\&.
Default is http://localhost/\&.
.B BATCH_SIZE
Number of feeds to send to the queue for each interval\&.
Default is 100 feeds\&.
.B CERT_DOMAIN
Use Let's Encrypt to get automatically a certificate for this domain\&.
Default is empty\&.
.B CERT_FILE
Path to SSL certificate\&.
Default is empty\&.
.B CLEANUP_ARCHIVE_BATCH_SIZE
Number of entries to archive for each job interval\&.
Default is 10000 entries\&.
.B CLEANUP_ARCHIVE_READ_DAYS
Number of days after marking read entries as removed\&.
Set to -1 to keep all read entries.
Default is 60 days\&.
.B CLEANUP_ARCHIVE_UNREAD_DAYS
Number of days after marking unread entries as removed\&.
Set to -1 to keep all unread entries.
Default is 180 days\&.
.B CLEANUP_FREQUENCY_HOURS
Cleanup job frequency. Remove old sessions and archive entries\&.
Default is 24 hours\&.
.B CLEANUP_REMOVE_SESSIONS_DAYS
Number of days after removing old sessions from the database\&.
Default is 30 days\&.
.B CREATE_ADMIN
Set to 1 to create an admin user from environment variables\&.
Disabled by default\&.
.B DATABASE_CONNECTION_LIFETIME
Set the maximum amount of time a connection may be reused\&.
Default is 5 minutes\&.
.B DATABASE_MAX_CONNS
Maximum number of database connections\&.
Default is 20\&.
.B DATABASE_MIN_CONNS
Minimum number of database connections\&.
Default is 20\&.
.B DATABASE_URL
Postgresql connection parameters\&.
Default is "user=postgres password=postgres dbname=miniflux2 sslmode=disable"\&.
.B DATABASE_URL_FILE
Path to a secret key exposed as a file, it should contain $DATABASE_URL value\&.
Default is empty\&.
.B DISABLE_HSTS
Disable HTTP Strict Transport Security header if \fBHTTPS\fR is set\&.
Default is false (The HSTS is enabled)\&.
.B DISABLE_HTTP_SERVICE
Set the value to 1 to disable the HTTP service\&.
Default is false (The HTTP service is enabled)\&.
.B 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 false\&.
.B DISABLE_SCHEDULER_SERVICE
Set the value to 1 to disable the internal scheduler service\&.
Default is false (The internal scheduler service is enabled)\&.
.B 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\&.
.B 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\&.
.B 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\&.
.B 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\&.
.B 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 0 (disabled)\&.
.B FORCE_REFRESH_INTERVAL
The minimum interval for manual refresh\&.
Default is 30 minutes\&.
.B HTTP_CLIENT_MAX_BODY_SIZE
Maximum body size for HTTP requests in Mebibyte (MiB)\&.
Default is 15 MiB\&.
.B HTTP_CLIENT_PROXY
Proxy URL for HTTP client\&.
Default is empty\&.
.B HTTP_CLIENT_TIMEOUT
Time limit in seconds before the HTTP client cancel the request\&.
Default is 20 seconds\&.
.B 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.
.B HTTP_SERVER_TIMEOUT
Time limit in seconds before the HTTP client cancel the request\&.
Default is 300 seconds\&.
Forces cookies to use secure flag and send HSTS header\&.
Default is empty\&.
.B INVIDIOUS_INSTANCE
Set a custom invidious instance to use\&.
Default is yewtu.be\&.
.B KEY_FILE
Path to SSL private key\&.
Default is empty\&.
.B LISTEN_ADDR
Address to listen on. Use absolute path to listen on Unix socket (/var/run/miniflux.sock)\&.
Default is 127.0.0.1:8080\&.
.B LOG_DATE_TIME
Display the date and time in log messages\&.
Disabled by default\&.
.B LOG_FILE
Supported values are "stderr", "stdout", or a file name\&.
Default is "stderr"\&.
.B LOG_FORMAT
Supported log formats are "text" or "json"\&.
Default is "text"\&.
.B LOG_LEVEL
Supported values are "debug", "info", "warning", or "error"\&.
Default is "info"\&.
.B MAINTENANCE_MESSAGE
Define a custom maintenance message\&.
Default is "Miniflux is currently under maintenance"\&.
.B MAINTENANCE_MODE
Set to 1 to enable maintenance mode\&.
Disabled by default\&.
.B MEDIA_PROXY_CUSTOM_URL
Sets an external server to proxy media through\&.
Default is empty, Miniflux does the proxying\&.
.B MEDIA_PROXY_HTTP_CLIENT_TIMEOUT
Time limit in seconds before the media proxy HTTP client cancel the request\&.
Default is 120 seconds\&.
.B MEDIA_PROXY_RESOURCE_TYPES
A comma-separated list of media types to proxify. Supported values are: image, audio, video\&.
Default is image\&.
.B MEDIA_PROXY_MODE
Possible values: http-only, all, or none\&.
Default is http-only\&.
.B 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\&.
.B METRICS_ALLOWED_NETWORKS
List of networks allowed to access the metrics endpoint (comma-separated values)\&.
Default is 127.0.0.1/8\&.
.B METRICS_COLLECTOR
Set to 1 to enable metrics collector. Expose a /metrics endpoint for Prometheus.
Disabled by default\&.
.B METRICS_PASSWORD
Metrics endpoint password for basic HTTP authentication\&.
Default is emtpty\&.
.B METRICS_PASSWORD_FILE
Path to a file that contains the password for the metrics endpoint HTTP authentication\&.
Default is emtpty\&.
.B METRICS_REFRESH_INTERVAL
Refresh interval to collect database metrics\&.
Default is 60 seconds\&.
.B METRICS_USERNAME
Metrics endpoint username for basic HTTP authentication\&.
Default is emtpty\&.
.B METRICS_USERNAME_FILE
Path to a file that contains the username for the metrics endpoint HTTP authentication\&.
Default is emtpty\&.
.B OAUTH2_CLIENT_ID
OAuth2 client ID\&.
Default is empty\&.
.B OAUTH2_CLIENT_ID_FILE
Path to a secret key exposed as a file, it should contain $OAUTH2_CLIENT_ID value\&.
Default is empty\&.
.B OAUTH2_CLIENT_SECRET
OAuth2 client secret\&.
Default is empty\&.
.B OAUTH2_CLIENT_SECRET_FILE
Path to a secret key exposed as a file, it should contain $OAUTH2_CLIENT_SECRET value\&.
Default is empty\&.
.B OAUTH2_OIDC_DISCOVERY_ENDPOINT
OpenID Connect discovery endpoint\&.
Default is empty\&.
.B OAUTH2_OIDC_PROVIDER_NAME
Name to display for the OIDC provider\&.
Default is OpenID Connect\&.
.B OAUTH2_PROVIDER
Possible values are "google" or "oidc"\&.
Default is empty\&.
.B 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\&.
.B OAUTH2_USER_CREATION
Set to 1 to authorize OAuth2 user creation\&.
Disabled by default\&.
.B POCKET_CONSUMER_KEY
Pocket consumer API key for all users\&.
Default is empty\&.
.B POCKET_CONSUMER_KEY_FILE
Path to a secret key exposed as a file, it should contain $POCKET_CONSUMER_KEY value\&.
Default is empty\&.
.B POLLING_FREQUENCY
Refresh interval in minutes for feeds\&.
Default is 60 minutes\&.
.B 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\&.
.B POLLING_SCHEDULER
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"\&.
Override LISTEN_ADDR to 0.0.0.0:$PORT\&.
Default is empty\&.
.B RUN_MIGRATIONS
Set to 1 to run database migrations\&.
Disabled by default\&.
.B SCHEDULER_ENTRY_FREQUENCY_FACTOR
Factor to increase refresh frequency for the entry frequency scheduler\&.
Default is 1\&.
.B SCHEDULER_ENTRY_FREQUENCY_MAX_INTERVAL
Maximum interval in minutes for the entry frequency scheduler\&.
Default is 24 hours\&.
.B SCHEDULER_ENTRY_FREQUENCY_MIN_INTERVAL
Minimum interval in minutes for the entry frequency scheduler\&.
Default is 5 minutes\&.
.B SCHEDULER_ROUND_ROBIN_MIN_INTERVAL
Minimum interval in minutes for the round robin scheduler\&.
Default is 60 minutes\&.
.B SERVER_TIMING_HEADER
Set the value to 1 to enable server-timing headers\&.
Disabled by default\&.
.B WATCHDOG
Enable or disable Systemd watchdog\&.
Enabled by default\&.
.B WEBAUTHN
Enable or disable WebAuthn/Passkey authentication\&.
Note: After activating and setting up your Passkey, just enter your username and click the Passkey login button\&.
Default is disabled\&.
.B WORKER_POOL_SIZE
Number of background workers\&.
Default is 16 workers\&.
.B YOUTUBE_EMBED_URL_OVERRIDE
YouTube URL which will be used for embeds\&.
Default is https://www.youtube-nocookie.com/embed/\&.
.SH AUTHORS
Miniflux is written and maintained by Fr\['e]d\['e]ric Guillot\&.
.SH "COPYRIGHT"
Miniflux is released under the Apache 2.0 license\&.
FilesExpand file tree

miniflux.1

Latest commit

History

miniflux.1

File metadata and controls
