Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
MINIFLUX(1)							   MINIFLUX(1)

NAME
       miniflux	- Minimalist and opinionated feed reader

SYNOPSIS
       miniflux	 [-vic]	 [-create-admin]  [-debug]  [-flush-sessions]  [-info]
       [-migrate]
		[-reset-feed-errors]  [-reset-password]	 [-version]  [-config-
       file] [-config-dump]

DESCRIPTION
       miniflux	is a minimalist	and opinionated	feed reader.

OPTIONS
       -c
	   Load	configuration file.

       -config-file
	   Load	configuration file.

       -config-dump
	   Print parsed	configuration values.

       -create-admin
	   Create admin	user.

       -debug
	   Show	debug logs.

       -flush-sessions
	   Flush all sessions (disconnect users).

       -i
	   Show	application information.

       -info
	   Show	application information.

       -migrate
	   Run SQL migrations.

       -reset-feed-errors
	   Clear all feed errors for all users.

       -reset-password
	   Reset user password.

       -v
	   Show	application version.

       -version
	   Show	application version.

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.

ENVIRONMENT
       DEBUG  Set the value to 1 to enable debug logs.
	      Disabled by default.

       SERVER_TIMING_HEADER
	      Set the value to 1 to enable server-timing headers.
	      Disabled by default.

       LOG_DATE_TIME
	      Display the date and time	in log messages.
	      Disabled by default.

       WORKER_POOL_SIZE
	      Number of	background workers.
	      Default is 5 workers.

       POLLING_FREQUENCY
	      Refresh interval in minutes for feeds.
	      Default is 60 minutes.

       BATCH_SIZE
	      Number of	feeds to send to the queue for each interval.
	      Default is 10 feeds.

       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".

       SCHEDULER_ENTRY_FREQUENCY_MAX_INTERVAL
	      Maximum interval in minutes for the entry	frequency scheduler.
	      Default is 24 hours.

       SCHEDULER_ENTRY_FREQUENCY_MIN_INTERVAL
	      Minimum interval in minutes for the entry	frequency scheduler.
	      Default is 5 minutes.

       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.

       DATABASE_URL
	      Postgresql connection parameters.
	      Default  is  "user=postgres  password=postgres  dbname=miniflux2
	      sslmode=disable".

       DATABASE_URL_FILE
	      Path to a	secret key exposed as a	file, it should	contain	$DATA-
	      BASE_URL value.
	      Default is empty.

       DATABASE_MAX_CONNS
	      Maximum number of	database connections.
	      Default is 20.

       DATABASE_MIN_CONNS
	      Minimum number of	database connections.
	      Default is 20.

       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.

       PORT   Override LISTEN_ADDR to 0.0.0.0:$PORT.
	      Default is empty.

       BASE_URL
	      Base URL to generate HTML	links and base path for	cookies.
	      Default is http://localhost/.

       CLEANUP_FREQUENCY_HOURS
	      Cleanup job frequency. Remove old	sessions and archive entries.
	      Default is 24 hours.

       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.

       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.

       CLEANUP_REMOVE_SESSIONS_DAYS
	      Number of	days after removing old	sessions from the database.
	      Default is 30 days.

       HTTPS  Forces cookies to	use secure flag	and send HSTS header.
	      Default is empty.

       DISABLE_HSTS
	      Disable HTTP Strict Transport Security header if HTTPS is	set.
	      Default is false (The HSTS is enabled).

       DISABLE_HTTP_SERVICE
	      Set the value to 1 to disable the	HTTP service.
	      Default is false (The HTTP service is enabled).

       DISABLE_SCHEDULER_SERVICE
	      Set the value to 1 to disable the	internal scheduler service.
	      Default is false (The internal scheduler service is enabled).

       CERT_FILE
	      Path to SSL certificate.
	      Default is empty.

       KEY_FILE
	      Path to SSL private key.
	      Default is empty.

       CERT_DOMAIN
	      Use  Let's  Encrypt  to get automatically	a certificate for this
	      domain.
	      Default is empty.

       METRICS_COLLECTOR
	      Set to 1 to enable metrics collector. Expose a /metrics endpoint
	      for Prometheus.
	      Disabled by default.

       METRICS_REFRESH_INTERVAL
	      Refresh interval to collect database metrics.
	      Default is 60 seconds.

       METRICS_ALLOWED_NETWORKS
	      List  of networks	allowed	to access the metrics endpoint (comma-
	      separated	values).
	      Default is 127.0.0.1/8.

       OAUTH2_PROVIDER
	      Possible values are "google" or "oidc".
	      Default is empty.

       OAUTH2_CLIENT_ID
	      OAuth2 client ID.
	      Default is empty.

       OAUTH2_CLIENT_ID_FILE
	      Path to a	secret key  exposed  as	 a  file,  it  should  contain
	      $OAUTH2_CLIENT_ID	value.
	      Default is empty.

       OAUTH2_CLIENT_SECRET
	      OAuth2 client secret.
	      Default is empty.

       OAUTH2_CLIENT_SECRET_FILE
	      Path  to	a  secret  key	exposed	 as  a file, it	should contain
	      $OAUTH2_CLIENT_SECRET value.
	      Default is empty.

       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.

       OAUTH2_OIDC_DISCOVERY_ENDPOINT
	      OpenID Connect discovery endpoint.
	      Default is empty.

       OAUTH2_USER_CREATION
	      Set to 1 to authorize OAuth2 user	creation.
	      Disabled by default.

       RUN_MIGRATIONS
	      Set to 1 to run database migrations.
	      Disabled by default.

       CREATE_ADMIN
	      Set to 1 to create an admin user from environment	variables.
	      Disabled by default.

       ADMIN_USERNAME
	      Admin user login,	used only if $CREATE_ADMIN is enabled.
	      Default is empty.

       ADMIN_USERNAME_FILE
	      Path  to	a secret key exposed as	a file,	it should contain $AD-
	      MIN_USERNAME value.
	      Default is empty.

       ADMIN_PASSWORD
	      Admin user password, used	only if	$CREATE_ADMIN is enabled.
	      Default is empty.

       ADMIN_PASSWORD_FILE
	      Path to a	secret key exposed as a	file, it should	 contain  $AD-
	      MIN_PASSWORD value.
	      Default is empty.

       POCKET_CONSUMER_KEY
	      Pocket consumer API key for all users.
	      Default is empty.

       POCKET_CONSUMER_KEY_FILE
	      Path  to	a  secret  key	exposed	 as  a file, it	should contain
	      $POCKET_CONSUMER_KEY value.
	      Default is empty.

       PROXY_IMAGES
	      Avoids mixed content warnings for	 external  images:  http-only,
	      all, or none.
	      Default is http-only.

       HTTP_CLIENT_TIMEOUT
	      Time limit in seconds before the HTTP client cancel the request.
	      Default is 20 seconds.

       HTTP_CLIENT_MAX_BODY_SIZE
	      Maximum body size	for HTTP requests in Mebibyte (MiB).
	      Default is 15 MiB.

       HTTP_CLIENT_PROXY
	      Proxy URL	for HTTP client.
	      Default is empty.

       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.

       AUTH_PROXY_HEADER
	      Proxy authentication HTTP	header.
	      Default is empty.

       AUTH_PROXY_USER_CREATION
	      Set  to 1	to create users	based on proxy authentication informa-
	      tion.
	      Disabled by default.

       MAINTENANCE_MODE
	      Set to 1 to enable maintenance mode.
	      Disabled by default.

       MAINTENANCE_MESSAGE
	      Define a custom maintenance message.
	      Default is "Miniflux is currently	under maintenance".

AUTHORS
       Miniflux	is written and maintained by Frederic Guillot.

COPYRIGHT
       Miniflux	is released under the Apache 2.0 license.

			      September	28, 2020		   MINIFLUX(1)

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | CONFIGURATION FILE | ENVIRONMENT | AUTHORS | COPYRIGHT

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=miniflux&sektion=1&manpath=FreeBSD+13.0-RELEASE+and+Ports>

home | help