miniflux.1 4.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222
  1. .\" Manpage for miniflux.
  2. .TH "MINIFLUX" "1" "June 8, 2019" "\ \&" "\ \&"
  3. .SH NAME
  4. miniflux \- Minimalist and opinionated feed reader
  5. .SH SYNOPSIS
  6. \fBminiflux\fR [-vic] [-create-admin] [-debug] [-flush-sessions] [-info] [-migrate]
  7. [-reset-feed-errors] [-reset-password] [-version] [-config-file] [-config-dump]
  8. .SH DESCRIPTION
  9. \fBminiflux\fR is a minimalist and opinionated feed reader.
  10. .SH OPTIONS
  11. .PP
  12. .B \-c
  13. .RS 4
  14. Load configuration file\&.
  15. .RE
  16. .PP
  17. .B \-config-file
  18. .RS 4
  19. Load configuration file\&.
  20. .RE
  21. .PP
  22. .B \-config-dump
  23. .RS 4
  24. Print parsed configuration values\&.
  25. .RE
  26. .PP
  27. .B \-create-admin
  28. .RS 4
  29. Create admin user\&.
  30. .RE
  31. .PP
  32. .B \-debug
  33. .RS 4
  34. Show debug logs\&.
  35. .RE
  36. .PP
  37. .B \-flush-sessions
  38. .RS 4
  39. Flush all sessions (disconnect users)\&.
  40. .RE
  41. .PP
  42. .B \-i
  43. .RS 4
  44. Show application information\&.
  45. .RE
  46. .PP
  47. .B \-info
  48. .RS 4
  49. Show application information\&.
  50. .RE
  51. .PP
  52. .B \-migrate
  53. .RS 4
  54. Run SQL migrations\&.
  55. .RE
  56. .PP
  57. .B \-reset-feed-errors
  58. .RS 4
  59. Clear all feed errors for all users\&.
  60. .RE
  61. .PP
  62. .B \-reset-password
  63. .RS 4
  64. Reset user password\&.
  65. .RE
  66. .PP
  67. .B \-v
  68. .RS 4
  69. Show application version\&.
  70. .RE
  71. .PP
  72. .B \-version
  73. .RS 4
  74. Show application version\&.
  75. .RE
  76. .SH CONFIGURATION FILE
  77. The configuration file is a text file that follow these rules:
  78. .LP
  79. - Miniflux expects each line to be in KEY=VALUE format.
  80. .br
  81. - Lines beginning with # are processed as comments and ignored.
  82. .br
  83. - Blank lines are ignored.
  84. .br
  85. - There is no variable interpolation.
  86. .PP
  87. Keys are the same as the environment variables described below.
  88. .br
  89. Environment variables override the values defined in the config file.
  90. .SH ENVIRONMENT
  91. .TP
  92. .B DEBUG
  93. Set the value to 1 to enable debug logs\&.
  94. .TP
  95. .B LOG_DATE_TIME
  96. Display the date and time in log messages\&.
  97. .TP
  98. .B WORKER_POOL_SIZE
  99. Number of background workers (default is 5)\&.
  100. .TP
  101. .B POLLING_FREQUENCY
  102. Refresh interval in minutes for feeds (default is 60 minutes)\&.
  103. .TP
  104. .B BATCH_SIZE
  105. Number of feeds to send to the queue for each interval (default is 10)\&.
  106. .TP
  107. .B DATABASE_URL
  108. Postgresql connection parameters\&.
  109. .br
  110. Default is "user=postgres password=postgres dbname=miniflux2 sslmode=disable"\&.
  111. .TP
  112. .B DATABASE_MAX_CONNS
  113. Maximum number of database connections (default is 20)\&.
  114. .TP
  115. .B DATABASE_MIN_CONNS
  116. Minimum number of database connections (default is 1)\&.
  117. .TP
  118. .B LISTEN_ADDR
  119. Address to listen on. Default is 127.0.0.1:8080\&.
  120. .br
  121. Use absolute path to listen on Unix socket (/var/run/miniflux.sock)\&.
  122. .TP
  123. .B PORT
  124. Override LISTEN_ADDR to 0.0.0.0:$PORT\&.
  125. .TP
  126. .B BASE_URL
  127. Base URL to generate HTML links and base path for cookies\&.
  128. .br
  129. Default is http://localhost/\&.
  130. .TP
  131. .B CLEANUP_FREQUENCY
  132. Cleanup job frequency, remove old sessions and archive read entries\&.
  133. .br
  134. Default is 24 hours\&.
  135. .TP
  136. .B ARCHIVE_READ_DAYS
  137. Number of days after marking read items as removed\&.
  138. .br
  139. Default is 60 days\&.
  140. .TP
  141. .B HTTPS
  142. Forces cookies to use secure flag and send HSTS header\&.
  143. .TP
  144. .B DISABLE_HSTS
  145. Disable HTTP Strict Transport Security header if \fBHTTPS\fR is set\&.
  146. .TP
  147. .B DISABLE_HTTP_SERVICE
  148. Set the value to 1 to disable the HTTP service\&.
  149. .TP
  150. .B DISABLE_SCHEDULER_SERVICE
  151. Set the value to 1 to disable the internal scheduler service\&.
  152. .TP
  153. .B CERT_FILE
  154. Path to SSL certificate\&.
  155. .TP
  156. .B KEY_FILE
  157. Path to SSL private key\&.
  158. .TP
  159. .B CERT_DOMAIN
  160. Use Let's Encrypt to get automatically a certificate for this domain\&.
  161. .TP
  162. .B CERT_CACHE
  163. Let's Encrypt cache directory (default is /tmp/cert_cache)\&.
  164. .TP
  165. .B OAUTH2_PROVIDER
  166. OAuth2 provider to use\&. Only google is supported\&.
  167. .TP
  168. .B OAUTH2_CLIENT_ID
  169. OAuth2 client ID\&.
  170. .TP
  171. .B OAUTH2_CLIENT_SECRET
  172. OAuth2 client secret\&.
  173. .TP
  174. .B OAUTH2_REDIRECT_URL
  175. OAuth2 redirect URL\&.
  176. .TP
  177. .B OAUTH2_USER_CREATION
  178. Set to 1 to authorize OAuth2 user creation\&.
  179. .TP
  180. .B RUN_MIGRATIONS
  181. Set to 1 to run database migrations\&.
  182. .TP
  183. .B CREATE_ADMIN
  184. Set to 1 to create an admin user from environment variables\&.
  185. .TP
  186. .B ADMIN_USERNAME
  187. Admin user login, used only if \fBCREATE_ADMIN\fR is enabled\&.
  188. .TP
  189. .B ADMIN_PASSWORD
  190. Admin user password, used only if \fBCREATE_ADMIN\fR is enabled\&.
  191. .TP
  192. .B POCKET_CONSUMER_KEY
  193. Pocket consumer API key for all users\&.
  194. .TP
  195. .B PROXY_IMAGES
  196. Avoids mixed content warnings for external images: http-only, all, or none\&.
  197. .br
  198. Default is http-only\&.
  199. .TP
  200. .B HTTP_CLIENT_TIMEOUT
  201. Time limit in seconds before the HTTP client cancel the request\&.
  202. .br
  203. Default is 20 seconds\&.
  204. .TP
  205. .B HTTP_CLIENT_MAX_BODY_SIZE
  206. Maximum body size for HTTP requests in Mebibyte (MiB)\&.
  207. .br
  208. Default is 15 MiB\&.
  209. .SH AUTHORS
  210. .P
  211. Miniflux is written and maintained by Fr\['e]d\['e]ric Guillot\&.
  212. .SH "COPYRIGHT"
  213. .P
  214. Miniflux is released under the Apache 2.0 license\&.