miniflux.1 3.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180
  1. .\" Manpage for miniflux.
  2. .TH "MINIFLUX" "1" "November 9, 2018" "\ \&" "\ \&"
  3. .SH NAME
  4. miniflux \- Minimalist and opinionated feed reader
  5. .SH SYNOPSIS
  6. \fBminiflux\fR [-vi] [-create-admin] [-debug] [-flush-sessions] [-info] [-migrate]
  7. [-reset-feed-errors] [-reset-password] [-version]
  8. .SH DESCRIPTION
  9. \fBminiflux\fR is a minimalist and opinionated feed reader.
  10. .SH OPTIONS
  11. .PP
  12. .B \-create-admin
  13. .RS 4
  14. Create admin user\&.
  15. .RE
  16. .PP
  17. .B \-debug
  18. .RS 4
  19. Show debug logs\&.
  20. .RE
  21. .PP
  22. .B \-flush-sessions
  23. .RS 4
  24. Flush all sessions (disconnect users)\&.
  25. .RE
  26. .PP
  27. .B \-i
  28. .RS 4
  29. Show application information\&.
  30. .RE
  31. .PP
  32. .B \-info
  33. .RS 4
  34. Show application information\&.
  35. .RE
  36. .PP
  37. .B \-migrate
  38. .RS 4
  39. Run SQL migrations\&.
  40. .RE
  41. .PP
  42. .B \-reset-feed-errors
  43. .RS 4
  44. Clear all feed errors for all users\&.
  45. .RE
  46. .PP
  47. .B \-reset-password
  48. .RS 4
  49. Reset user password\&.
  50. .RE
  51. .PP
  52. .B \-v
  53. .RS 4
  54. Show application version\&.
  55. .RE
  56. .PP
  57. .B \-version
  58. .RS 4
  59. Show application version\&.
  60. .RE
  61. .SH ENVIRONMENT
  62. .TP
  63. .B DEBUG
  64. Set the value to 1 to enable debug logs\&.
  65. .TP
  66. .B WORKER_POOL_SIZE
  67. Number of background workers (default is 5)\&.
  68. .TP
  69. .B POLLING_FREQUENCY
  70. Refresh interval in minutes for feeds (default is 60 minutes)\&.
  71. .TP
  72. .B BATCH_SIZE
  73. Number of feeds to send to the queue for each interval (default is 10)\&.
  74. .TP
  75. .B DATABASE_URL
  76. Postgresql connection parameters\&.
  77. .br
  78. Default is "user=postgres password=postgres dbname=miniflux2 sslmode=disable"\&.
  79. .TP
  80. .B DATABASE_MAX_CONNS
  81. Maximum number of database connections (default is 20)\&.
  82. .TP
  83. .B DATABASE_MIN_CONNS
  84. Minimum number of database connections (default is 1)\&.
  85. .TP
  86. .B LISTEN_ADDR
  87. Address to listen on. Default is 127.0.0.1:8080\&.
  88. .br
  89. Use absolute path to listen on Unix socket (/var/run/miniflux.sock)\&.
  90. .TP
  91. .B PORT
  92. Override LISTEN_ADDR to 0.0.0.0:$PORT\&.
  93. .TP
  94. .B BASE_URL
  95. Base URL to generate HTML links and base path for cookies\&.
  96. .br
  97. Default is http://localhost/\&.
  98. .TP
  99. .B CLEANUP_FREQUENCY
  100. Cleanup job frequency, remove old sessions and archive read entries\&.
  101. .br
  102. Default is 24 hours\&.
  103. .TP
  104. .B ARCHIVE_READ_DAYS
  105. Number of days after marking read items as removed\&.
  106. .br
  107. Default is 60 days\&.
  108. .TP
  109. .B HTTPS
  110. Forces cookies to use secure flag and send HSTS header\&.
  111. .TP
  112. .B DISABLE_HSTS
  113. Disable HTTP Strict Transport Security header if \fBHTTPS\fR is set\&.
  114. .TP
  115. .B DISABLE_HTTP_SERVICE
  116. Set the value to 1 to disable the HTTP service\&.
  117. .TP
  118. .B DISABLE_SCHEDULER_SERVICE
  119. Set the value to 1 to disable the internal scheduler service\&.
  120. .TP
  121. .B CERT_FILE
  122. Path to SSL certificate\&.
  123. .TP
  124. .B KEY_FILE
  125. Path to SSL private key\&.
  126. .TP
  127. .B CERT_DOMAIN
  128. Use Let's Encrypt to get automatically a certificate for this domain\&.
  129. .TP
  130. .B CERT_CACHE
  131. Let's Encrypt cache directory (default is /tmp/cert_cache)\&.
  132. .TP
  133. .B OAUTH2_PROVIDER
  134. OAuth2 provider to use\&. Only google is supported\&.
  135. .TP
  136. .B OAUTH2_CLIENT_ID
  137. OAuth2 client ID\&.
  138. .TP
  139. .B OAUTH2_CLIENT_SECRET
  140. OAuth2 client secret\&.
  141. .TP
  142. .B OAUTH2_REDIRECT_URL
  143. OAuth2 redirect URL\&.
  144. .TP
  145. .B OAUTH2_USER_CREATION
  146. Set to 1 to authorize OAuth2 user creation\&.
  147. .TP
  148. .B RUN_MIGRATIONS
  149. Set to 1 to run database migrations\&.
  150. .TP
  151. .B CREATE_ADMIN
  152. Set to 1 to create an admin user from environment variables\&.
  153. .TP
  154. .B ADMIN_USERNAME
  155. Admin user login, used only if \fBCREATE_ADMIN\fR is enabled\&.
  156. .TP
  157. .B ADMIN_PASSWORD
  158. Admin user password, used only if \fBCREATE_ADMIN\fR is enabled\&.
  159. .TP
  160. .B POCKET_CONSUMER_KEY
  161. Pocket consumer API key for all users\&.
  162. .TP
  163. .B PROXY_IMAGES
  164. Avoids mixed content warnings for external images: http-only, all, or none\&.
  165. .br
  166. Default is http-only\&.
  167. .SH AUTHORS
  168. .sp
  169. Miniflux is written and maintained by Fr\['e]d\['e]ric Guillot\&.
  170. .SH "COPYRIGHT"
  171. .sp
  172. Miniflux is released under the Apache 2.0 license\&.