miniflux.1 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761
  1. .\" Manpage for miniflux.
  2. .\" Write one sentence per line and use \: to add break points in long URLs.
  3. .TH "MINIFLUX" "1" "October 31, 2026" "\ \&" "\ \&"
  4. .\" Left-align text, disable hyphenation, and use a single space between sentences.
  5. .ds AD l
  6. .ss 12 0
  7. .nr HY 0
  8. .SH NAME
  9. miniflux \- Minimalist and opinionated feed reader
  10. .SH SYNOPSIS
  11. \fBminiflux\fR [\fBoptions\fR]
  12. .SH DESCRIPTION
  13. \fBminiflux\fR is a minimalist and opinionated feed reader.
  14. .PP
  15. When started without any command option, \fBminiflux\fR runs as a daemon:
  16. it starts the HTTP server, the background scheduler that refreshes feeds,
  17. and the cleanup jobs.
  18. .PP
  19. Miniflux requires a PostgreSQL database.
  20. The database schema must be up to date before the daemon starts:
  21. use \fB\-migrate\fR or set \fBRUN_MIGRATIONS\fR.
  22. .PP
  23. Options can be prefixed with one or two dashes.
  24. .SH OPTIONS
  25. .TP
  26. \fB\-c\fR, \fB\-config\-file\fR \fI/path/to/miniflux.conf\fR
  27. Load configuration file.
  28. Environment variables override the values defined in the file.
  29. .TP
  30. .B \-config\-dump
  31. Print parsed configuration values and exit.
  32. The output includes sensitive information like passwords.
  33. .TP
  34. .B \-create\-admin
  35. Create an admin user from an interactive terminal and exit.
  36. The username and password are prompted for.
  37. .TP
  38. .B \-debug
  39. Set log level to debug.
  40. .TP
  41. \fB\-export\-user\-feeds\fR \fIusername\fR
  42. Export the feeds of the given user as OPML to the standard output and exit.
  43. .TP
  44. .B \-flush\-sessions
  45. Flush all sessions (disconnect users) and exit.
  46. .TP
  47. \fB\-h\fR, \fB\-help\fR
  48. Show usage information and exit.
  49. .TP
  50. \fB\-healthcheck\fR \fIendpoint\fR
  51. Perform a health check on the given endpoint and exit.
  52. The check fails if the endpoint cannot be reached within 3 seconds
  53. or does not return HTTP status 200.
  54. .IP
  55. The value "auto" builds the endpoint from the first \fBLISTEN_ADDR\fR address
  56. and the base path of \fBBASE_URL\fR,
  57. for example http://127.0.0.1:8080/healthcheck.
  58. .TP
  59. \fB\-i\fR, \fB\-info\fR
  60. Show build information and exit.
  61. .TP
  62. .B \-migrate
  63. Run SQL migrations and exit.
  64. .TP
  65. .B \-refresh\-feeds
  66. Refresh a batch of feeds and exit.
  67. .TP
  68. .B \-reset\-feed\-errors
  69. Clear all feed errors for all users and exit.
  70. .TP
  71. .B \-reset\-feed\-next\-check\-at
  72. Reset the next check time for all feeds and exit.
  73. .TP
  74. .B \-reset\-password
  75. Reset a user password from an interactive terminal and exit.
  76. The username and new password are prompted for.
  77. .TP
  78. .B \-run\-cleanup\-tasks
  79. Run cleanup tasks (delete old sessions and archive old entries) and exit.
  80. .TP
  81. \fB\-v\fR, \fB\-version\fR
  82. Show application version and exit.
  83. .SH CONFIGURATION FILE
  84. The configuration file is a text file that follows these rules:
  85. .PD 0
  86. .IP \(bu 2
  87. Each line is in KEY=VALUE format.
  88. .IP \(bu 2
  89. Lines beginning with # are comments and are ignored.
  90. .IP \(bu 2
  91. Blank lines and lines without "=" are ignored.
  92. .IP \(bu 2
  93. Whitespace around keys and values is removed.
  94. .IP \(bu 2
  95. Quotes are not removed: values are used as written.
  96. .IP \(bu 2
  97. An empty value keeps the default value.
  98. .IP \(bu 2
  99. Unknown keys are ignored.
  100. .IP \(bu 2
  101. There is no variable interpolation.
  102. .PD
  103. .PP
  104. Keys are the same as the environment variables described below.
  105. Environment variables override the values defined in the config file.
  106. .SH ENVIRONMENT
  107. Boolean options accept the following values (case-insensitive):
  108. 1/0, yes/no, true/false, on/off.
  109. .PP
  110. For variables ending in \fB_FILE\fR,
  111. the value is a path to a file that contains the corresponding secret value.
  112. .TP
  113. .B ADMIN_PASSWORD
  114. Admin user password, used only if \fBCREATE_ADMIN\fR is enabled.
  115. .IP
  116. Default is empty.
  117. .TP
  118. .B ADMIN_PASSWORD_FILE
  119. Path to a secret key exposed as a file,
  120. it should contain the \fBADMIN_PASSWORD\fR value.
  121. .IP
  122. Default is empty.
  123. .TP
  124. .B ADMIN_USERNAME
  125. Admin user login, used only if \fBCREATE_ADMIN\fR is enabled.
  126. .IP
  127. Default is empty.
  128. .TP
  129. .B ADMIN_USERNAME_FILE
  130. Path to a secret key exposed as a file,
  131. it should contain the \fBADMIN_USERNAME\fR value.
  132. .IP
  133. Default is empty.
  134. .TP
  135. .B AUTH_PROXY_HEADER
  136. Proxy authentication HTTP header.
  137. The option \fBTRUSTED_REVERSE_PROXY_NETWORKS\fR must be configured
  138. to allow the proxy to authenticate users.
  139. .IP
  140. Default is empty.
  141. .TP
  142. .B AUTH_PROXY_USER_CREATION
  143. Set to 1 to create users based on proxy authentication information.
  144. When disabled, users must already exist in Miniflux
  145. to sign in through the proxy.
  146. .IP
  147. Disabled by default.
  148. .TP
  149. .B BASE_URL
  150. Base URL to generate HTML links and base path for cookies.
  151. The scheme must be http or https.
  152. .IP
  153. A path component sets the base path when Miniflux is served from a subfolder,
  154. for example https://example.org/miniflux/.
  155. .IP
  156. Default is http://localhost.
  157. .TP
  158. .B BATCH_SIZE
  159. Number of feeds to send to the queue for each interval.
  160. .IP
  161. Default is 100 feeds.
  162. .TP
  163. .B CERT_DOMAIN
  164. Use Let's Encrypt to get automatically a certificate for this domain.
  165. Miniflux also listens on port 80 to answer the ACME HTTP challenge.
  166. Certificates are cached in the database.
  167. .IP
  168. This option cannot be used with \fBCERT_FILE\fR and \fBKEY_FILE\fR.
  169. .IP
  170. Default is empty.
  171. .TP
  172. .B CERT_FILE
  173. Path to SSL certificate.
  174. Must be used with \fBKEY_FILE\fR.
  175. .IP
  176. Default is empty.
  177. .TP
  178. .B CLEANUP_ARCHIVE_BATCH_SIZE
  179. Number of entries to archive for each job interval.
  180. .IP
  181. Default is 10000 entries.
  182. .TP
  183. .B CLEANUP_ARCHIVE_READ_DAYS
  184. Number of days before the cleanup job archives read entries.
  185. .IP
  186. Archiving deletes non-bookmarked, non-shared read entries from the database
  187. and records a tombstone to prevent the same entry
  188. from being imported again during a later feed refresh.
  189. .IP
  190. Set to \-1 to disable automatic archiving of read entries.
  191. .IP
  192. Default is 60 days.
  193. .TP
  194. .B CLEANUP_ARCHIVE_UNREAD_DAYS
  195. Number of days before the cleanup job archives unread entries.
  196. .IP
  197. Archiving deletes non-bookmarked, non-shared unread entries from the database
  198. and records a tombstone to prevent the same entry
  199. from being imported again during a later feed refresh.
  200. .IP
  201. Set to \-1 to disable automatic archiving of unread entries.
  202. .IP
  203. Default is 180 days.
  204. .TP
  205. .B CLEANUP_FREQUENCY_HOURS
  206. Interval in hours between cleanup jobs
  207. (remove old sessions and archive entries).
  208. .IP
  209. Default is 24 hours.
  210. .TP
  211. .B CLEANUP_REMOVE_SESSIONS_DAYS
  212. Number of days after which sessions are removed from the database.
  213. .IP
  214. Default is 30 days.
  215. .TP
  216. .B CREATE_ADMIN
  217. Set to 1 to create an admin user from environment variables.
  218. .IP
  219. Disabled by default.
  220. .TP
  221. .B DATABASE_CONNECTION_LIFETIME
  222. Maximum amount of time in minutes a connection may be reused.
  223. .IP
  224. Default is 5 minutes.
  225. .TP
  226. .B DATABASE_MAX_CONNS
  227. Maximum number of database connections.
  228. .IP
  229. Default is 20.
  230. .TP
  231. .B DATABASE_MIN_CONNS
  232. Minimum number of database connections.
  233. Must be less than or equal to \fBDATABASE_MAX_CONNS\fR.
  234. .IP
  235. Default is 1.
  236. .TP
  237. .B DATABASE_URL
  238. PostgreSQL connection parameters.
  239. .IP
  240. Default is "user=postgres password=postgres dbname=miniflux2 sslmode=disable".
  241. .TP
  242. .B DATABASE_URL_FILE
  243. Path to a secret key exposed as a file,
  244. it should contain the \fBDATABASE_URL\fR value.
  245. .IP
  246. Default is empty.
  247. .TP
  248. .B DISABLE_API
  249. Disable miniflux's API.
  250. .IP
  251. Default is false (the API is enabled).
  252. .TP
  253. .B DISABLE_HSTS
  254. Disable HTTP Strict Transport Security header if \fBHTTPS\fR is set.
  255. .IP
  256. Default is false (HSTS is enabled).
  257. .TP
  258. .B DISABLE_HTTP_SERVICE
  259. Set the value to 1 to disable the HTTP service.
  260. .IP
  261. Default is false (the HTTP service is enabled).
  262. .TP
  263. .B DISABLE_LOCAL_AUTH
  264. Disable local authentication.
  265. When set to true, the username/password form is hidden from the login screen,
  266. and the options to change username/password or unlink OAuth2 account
  267. are hidden from the settings page.
  268. .IP
  269. Password authentication is also rejected by the login form
  270. and by the REST API HTTP Basic Authentication,
  271. and passwords can no longer be changed.
  272. API clients must use an API key instead.
  273. .IP
  274. This option requires an alternative authentication source
  275. such as OAuth2, auth proxy, or WebAuthn/Passkeys.
  276. If remote user creation is disabled, only existing users can sign in.
  277. .IP
  278. To use WebAuthn as the only authentication method,
  279. register at least one Passkey while another authentication method is available,
  280. before enabling \fBDISABLE_LOCAL_AUTH\fR.
  281. .IP
  282. Default is false.
  283. .TP
  284. .B DISABLE_SCHEDULER_SERVICE
  285. Set the value to 1 to disable the internal scheduler service.
  286. .IP
  287. Default is false (the internal scheduler service is enabled).
  288. .TP
  289. .B FETCHER_ALLOW_PRIVATE_FEED_PROXY
  290. Set to 1 to allow feed proxy URLs to use private or loopback network addresses.
  291. .IP
  292. This option applies to all authenticated users
  293. and should only be enabled when the private proxy boundary is trusted.
  294. .IP
  295. Disabled by default.
  296. .TP
  297. .B FETCHER_ALLOW_PRIVATE_NETWORKS
  298. Set to 1 to allow outgoing fetcher requests to private or loopback networks.
  299. .IP
  300. Disabled by default, private networks are refused.
  301. .TP
  302. .B FETCH_BILIBILI_WATCH_TIME
  303. Set the value to 1 to scrape video duration from Bilibili website
  304. and use it as a reading time.
  305. .IP
  306. Disabled by default.
  307. .TP
  308. .B FETCH_NEBULA_WATCH_TIME
  309. Set the value to 1 to scrape video duration from Nebula website
  310. and use it as a reading time.
  311. .IP
  312. Disabled by default.
  313. .TP
  314. .B FETCH_ODYSEE_WATCH_TIME
  315. Set the value to 1 to scrape video duration from Odysee website
  316. and use it as a reading time.
  317. .IP
  318. Disabled by default.
  319. .TP
  320. .B FETCH_YOUTUBE_WATCH_TIME
  321. Set the value to 1 to scrape video duration from YouTube website
  322. and use it as a reading time.
  323. .IP
  324. Disabled by default.
  325. .TP
  326. .B FORCE_REFRESH_INTERVAL
  327. Minimum interval in minutes between two manual refreshes.
  328. .IP
  329. Default is 30 minutes.
  330. .TP
  331. .B HTTP_CLIENT_MAX_BODY_SIZE
  332. Maximum body size for HTTP requests in Mebibyte (MiB).
  333. .IP
  334. Default is 15 MiB.
  335. .TP
  336. .B HTTP_CLIENT_PROXIES
  337. Enable proxy rotation for outgoing requests
  338. by providing a comma-separated list of proxy URLs.
  339. .IP
  340. Default is empty.
  341. .TP
  342. .B HTTP_CLIENT_PROXY
  343. Proxy URL to use when the "Fetch via proxy" feed option is enabled.
  344. .IP
  345. Default is empty.
  346. .TP
  347. .B HTTP_CLIENT_TIMEOUT
  348. Time limit in seconds before the HTTP client cancels the request.
  349. .IP
  350. Default is 20 seconds.
  351. .TP
  352. .B HTTP_CLIENT_USER_AGENT
  353. The default User-Agent header to use for the HTTP client.
  354. It can be overridden in per-feed settings.
  355. .IP
  356. When empty, Miniflux uses a default User-Agent
  357. that includes the Miniflux version.
  358. .IP
  359. Default is empty.
  360. .TP
  361. .B HTTP_SERVER_TIMEOUT
  362. Read, write, and idle timeout in seconds for the HTTP server.
  363. .IP
  364. Default is 300 seconds.
  365. .TP
  366. .B HTTPS
  367. Forces cookies to use secure flag and send HSTS header.
  368. .IP
  369. Default is disabled.
  370. .TP
  371. .B INTEGRATION_ALLOW_PRIVATE_NETWORKS
  372. Set to 1 to allow outgoing integration requests to private or loopback networks.
  373. .IP
  374. Disabled by default, private networks are refused.
  375. .TP
  376. .B INVIDIOUS_INSTANCE
  377. Set a custom invidious instance to use.
  378. .IP
  379. Default is yewtu.be.
  380. .TP
  381. .B KEY_FILE
  382. Path to SSL private key.
  383. Must be used with \fBCERT_FILE\fR.
  384. .IP
  385. Default is empty.
  386. .TP
  387. .B LISTEN_ADDR
  388. Address to listen on.
  389. Multiple addresses can be specified, separated by commas,
  390. for example 127.0.0.1:8080, 127.0.0.1:8081.
  391. .IP
  392. Use an absolute path to listen on a Unix socket (/var/run/miniflux.sock).
  393. When Miniflux creates the socket itself, it uses mode \fB0660\fR.
  394. This mode is hardcoded and cannot be configured.
  395. .IP
  396. With systemd socket activation, Miniflux uses the socket passed by systemd
  397. and only the first address is taken into account.
  398. .IP
  399. Default is 127.0.0.1:8080.
  400. .TP
  401. .B LOG_DATE_TIME
  402. Display the date and time in log messages.
  403. .IP
  404. Disabled by default.
  405. .TP
  406. .B LOG_FILE
  407. Supported values are "stderr", "stdout", or a file name.
  408. .IP
  409. Default is "stderr".
  410. .TP
  411. .B LOG_FORMAT
  412. Supported log formats are "text" or "json".
  413. .IP
  414. Default is "text".
  415. .TP
  416. .B LOG_LEVEL
  417. Supported values are "debug", "info", "warning", or "error".
  418. .IP
  419. Default is "info".
  420. .TP
  421. .B MAINTENANCE_MESSAGE
  422. Define a custom maintenance message.
  423. .IP
  424. Default is "Miniflux is currently under maintenance".
  425. .TP
  426. .B MAINTENANCE_MODE
  427. Set to 1 to enable maintenance mode.
  428. .IP
  429. Disabled by default.
  430. .TP
  431. .B MEDIA_PROXY_CUSTOM_URL
  432. Sets an external server to proxy media through.
  433. .IP
  434. Default is empty, Miniflux does the proxying.
  435. .TP
  436. .B MEDIA_PROXY_HTTP_CLIENT_TIMEOUT
  437. Time limit in seconds before the media proxy HTTP client cancels the request.
  438. .IP
  439. Default is 120 seconds.
  440. .TP
  441. .B MEDIA_PROXY_MODE
  442. Possible values are:
  443. .RS
  444. .TP
  445. .B http\-only
  446. Proxy only media served over insecure HTTP.
  447. .TP
  448. .B all
  449. Proxy all media.
  450. .TP
  451. .B none
  452. Disable the media proxy.
  453. .RE
  454. .IP
  455. Default is "http-only".
  456. .TP
  457. .B MEDIA_PROXY_PRIVATE_KEY
  458. Set a custom private key used to sign proxified media URLs.
  459. .IP
  460. By default, a secret key is randomly generated during startup.
  461. Proxified URLs are therefore invalidated on restart
  462. and are not shared between multiple instances.
  463. Set this option to keep them stable.
  464. .TP
  465. .B MEDIA_PROXY_RESOURCE_TYPES
  466. A comma-separated list of media types to proxify.
  467. Supported values are: image, audio, video.
  468. .IP
  469. Default is image.
  470. .TP
  471. .B METRICS_ALLOWED_NETWORKS
  472. List of networks allowed to access the metrics endpoint
  473. (comma-separated values).
  474. .IP
  475. Default is 127.0.0.1/8.
  476. .TP
  477. .B METRICS_COLLECTOR
  478. Set to 1 to enable the metrics collector
  479. and expose a /metrics endpoint for Prometheus.
  480. .IP
  481. Disabled by default.
  482. .TP
  483. .B METRICS_PASSWORD
  484. Metrics endpoint password for basic HTTP authentication.
  485. Must be used with \fBMETRICS_USERNAME\fR.
  486. .IP
  487. Default is empty.
  488. .TP
  489. .B METRICS_PASSWORD_FILE
  490. Path to a file that contains the password
  491. for the metrics endpoint HTTP authentication.
  492. .IP
  493. Default is empty.
  494. .TP
  495. .B METRICS_REFRESH_INTERVAL
  496. Interval in seconds between two collections of database metrics.
  497. .IP
  498. Default is 60 seconds.
  499. .TP
  500. .B METRICS_USERNAME
  501. Metrics endpoint username for basic HTTP authentication.
  502. Must be used with \fBMETRICS_PASSWORD\fR.
  503. .IP
  504. Default is empty.
  505. .TP
  506. .B METRICS_USERNAME_FILE
  507. Path to a file that contains the username
  508. for the metrics endpoint HTTP authentication.
  509. .IP
  510. Default is empty.
  511. .TP
  512. .B OAUTH2_ADDITIONAL_SCOPES
  513. Additional OAuth2 scopes to request.
  514. .IP
  515. Default is empty.
  516. .TP
  517. .B OAUTH2_ADMIN_GROUP
  518. Group for administrators.
  519. When set, the admin role is mapped based on the specified group.
  520. .IP
  521. Default is empty.
  522. .TP
  523. .B OAUTH2_CLIENT_ID
  524. OAuth2 client ID.
  525. .IP
  526. Default is empty.
  527. .TP
  528. .B OAUTH2_CLIENT_ID_FILE
  529. Path to a secret key exposed as a file,
  530. it should contain the \fBOAUTH2_CLIENT_ID\fR value.
  531. .IP
  532. Default is empty.
  533. .TP
  534. .B OAUTH2_CLIENT_SECRET
  535. OAuth2 client secret.
  536. .IP
  537. Default is empty.
  538. .TP
  539. .B OAUTH2_CLIENT_SECRET_FILE
  540. Path to a secret key exposed as a file,
  541. it should contain the \fBOAUTH2_CLIENT_SECRET\fR value.
  542. .IP
  543. Default is empty.
  544. .TP
  545. .B OAUTH2_GROUP_CLAIM
  546. Claim that contains user groups,
  547. which can be used for mapping the admin role.
  548. .IP
  549. The claim is read from the user info response, then from the ID token.
  550. Users without this claim are not administrators.
  551. .IP
  552. Default is empty.
  553. .TP
  554. .B OAUTH2_OIDC_DISCOVERY_ENDPOINT
  555. OpenID Connect discovery endpoint.
  556. Required when \fBOAUTH2_PROVIDER\fR is set to "oidc".
  557. .IP
  558. Default is empty.
  559. .TP
  560. .B OAUTH2_OIDC_PROVIDER_NAME
  561. Name to display for the OIDC provider.
  562. .IP
  563. Default is "OpenID Connect".
  564. .TP
  565. .B OAUTH2_PROVIDER
  566. Possible values are "google" or "oidc".
  567. .IP
  568. Default is empty.
  569. .TP
  570. .B OAUTH2_REDIRECT_URL
  571. OAuth2 redirect URL.
  572. This URL must be registered with the provider
  573. and is something like https://\:miniflux.example.org/\:oauth2/\:oidc/\:callback.
  574. .IP
  575. Default is empty.
  576. .TP
  577. .B OAUTH2_USER_CREATION
  578. Set to 1 to authorize OAuth2 user creation.
  579. When disabled, users must already exist in Miniflux
  580. or have a linked OAuth2 account to sign in.
  581. .IP
  582. Disabled by default.
  583. .TP
  584. .B POLLING_FREQUENCY
  585. Interval in minutes for the background job scheduler.
  586. It determines how often a batch of feeds is selected for refresh,
  587. based on their last refresh time.
  588. .IP
  589. Default is 60 minutes.
  590. .TP
  591. .B POLLING_LIMIT_PER_HOST
  592. Limits the number of concurrent requests to the same hostname
  593. when polling feeds.
  594. This helps prevent overwhelming a single server
  595. during batch processing by the worker pool.
  596. .IP
  597. Default is 0 (disabled).
  598. .TP
  599. .B POLLING_PARSING_ERROR_LIMIT
  600. The maximum number of parsing errors that the program will try
  601. before stopping polling a feed.
  602. Once the limit is reached, the user must refresh the feed manually.
  603. Set to 0 for unlimited.
  604. .IP
  605. Default is 3.
  606. .TP
  607. .B POLLING_SCHEDULER
  608. Determines the strategy used to schedule feed polling.
  609. Supported values are:
  610. .RS
  611. .TP
  612. .B round_robin
  613. Feeds are polled in a fixed, rotating order.
  614. .TP
  615. .B entry_frequency
  616. The polling interval for each feed is based on
  617. the average update frequency over the past week.
  618. .RE
  619. .IP
  620. The number of feeds polled in a given period is limited by
  621. the \fBPOLLING_FREQUENCY\fR and \fBBATCH_SIZE\fR settings.
  622. Regardless of the scheduler used,
  623. the total number of polled feeds will not exceed
  624. the maximum allowed per polling cycle.
  625. .IP
  626. Default is "round_robin".
  627. .TP
  628. .B PORT
  629. Override \fBLISTEN_ADDR\fR with \fB:$PORT\fR,
  630. which listens on all network interfaces.
  631. The value must be between 1 and 65535.
  632. .IP
  633. Default is empty.
  634. .TP
  635. .B RUN_MIGRATIONS
  636. Set to 1 to run database migrations.
  637. .IP
  638. Disabled by default.
  639. .TP
  640. .B SCHEDULER_ENTRY_FREQUENCY_FACTOR
  641. Factor to increase refresh frequency for the entry frequency scheduler.
  642. .IP
  643. Default is 1.
  644. .TP
  645. .B SCHEDULER_ENTRY_FREQUENCY_MAX_INTERVAL
  646. Maximum interval in minutes for the entry frequency scheduler.
  647. .IP
  648. Default is 1440 minutes (24 hours).
  649. .TP
  650. .B SCHEDULER_ENTRY_FREQUENCY_MIN_INTERVAL
  651. Minimum interval in minutes for the entry frequency scheduler.
  652. Must be less than or equal to
  653. \fBSCHEDULER_ENTRY_FREQUENCY_MAX_INTERVAL\fR.
  654. .IP
  655. Default is 5 minutes.
  656. .TP
  657. .B SCHEDULER_ROUND_ROBIN_MAX_INTERVAL
  658. Maximum interval in minutes for the round robin scheduler.
  659. .IP
  660. Default is 1440 minutes (24 hours).
  661. .TP
  662. .B SCHEDULER_ROUND_ROBIN_MIN_INTERVAL
  663. Minimum interval in minutes for the round robin scheduler.
  664. Must be less than or equal to
  665. \fBSCHEDULER_ROUND_ROBIN_MAX_INTERVAL\fR.
  666. .IP
  667. Default is 60 minutes.
  668. .TP
  669. .B TRUSTED_REVERSE_PROXY_NETWORKS
  670. A comma-separated list of networks (CIDR notation) allowed to use
  671. the proxy authentication header,
  672. \fBX-Forwarded-For\fR, \fBX-Forwarded-Proto\fR, and \fBX-Real-Ip\fR headers.
  673. .IP
  674. Default is empty.
  675. .TP
  676. .B WATCHDOG
  677. Enable or disable Systemd watchdog.
  678. .IP
  679. Enabled by default.
  680. .TP
  681. .B WEBAUTHN
  682. Enable or disable WebAuthn/Passkey authentication.
  683. .IP
  684. You must provide a username on the login page
  685. if you are using non-discoverable (non-resident) credentials,
  686. such as some hardware security keys.
  687. This is not required for discoverable credentials (Passkeys).
  688. .IP
  689. Default is disabled.
  690. .TP
  691. .B WORKER_POOL_SIZE
  692. Number of background workers.
  693. .IP
  694. Default is 16 workers.
  695. .TP
  696. .B YOUTUBE_API_KEY
  697. YouTube API key for use with \fBFETCH_YOUTUBE_WATCH_TIME\fR.
  698. If nonempty, the duration will be fetched from the YouTube API.
  699. Otherwise, the duration will be fetched from the YouTube website.
  700. .IP
  701. Default is empty.
  702. .TP
  703. .B YOUTUBE_EMBED_URL_OVERRIDE
  704. YouTube URL which will be used for embeds.
  705. .IP
  706. Default is https://www.youtube-nocookie.com/embed/.
  707. .SH FILES
  708. .TP
  709. .I /etc/miniflux.conf
  710. Configuration file installed by the Debian and RPM packages.
  711. The systemd service loads it as environment variables.
  712. .SH EXIT STATUS
  713. \fBminiflux\fR exits with status 0 on success and 1 on error.
  714. With \fB\-healthcheck\fR, a non-zero status means the health check failed.
  715. .SH EXAMPLES
  716. Run the database migrations and create an admin user
  717. from environment variables:
  718. .PP
  719. .EX
  720. export DATABASE_URL="postgres://miniflux:secret@localhost/miniflux?sslmode=disable"
  721. RUN_MIGRATIONS=1 CREATE_ADMIN=1 ADMIN_USERNAME=admin \e
  722. ADMIN_PASSWORD=changeme miniflux
  723. .EE
  724. .PP
  725. Start Miniflux with a configuration file:
  726. .PP
  727. .EX
  728. miniflux \-c /etc/miniflux.conf
  729. .EE
  730. .PP
  731. Check that a running instance is healthy,
  732. for example in a container health check:
  733. .PP
  734. .EX
  735. miniflux \-healthcheck auto
  736. .EE
  737. .PP
  738. Export the feeds of a user:
  739. .PP
  740. .EX
  741. miniflux \-export\-user\-feeds someone > feeds.xml
  742. .EE
  743. .SH SEE ALSO
  744. Online documentation: https://miniflux.app/docs/
  745. .SH AUTHORS
  746. Miniflux is developed and maintained by Fr\['e]d\['e]ric Guillot
  747. with contributions from the Miniflux community.
  748. .SH "COPYRIGHT"
  749. Miniflux is released under the Apache 2.0 license.