| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761 |
- .\" Manpage for miniflux.
- .\" Write one sentence per line and use \: to add break points in long URLs.
- .TH "MINIFLUX" "1" "October 31, 2026" "\ \&" "\ \&"
- .\" Left-align text, disable hyphenation, and use a single space between sentences.
- .ds AD l
- .ss 12 0
- .nr HY 0
- .SH NAME
- miniflux \- Minimalist and opinionated feed reader
- .SH SYNOPSIS
- \fBminiflux\fR [\fBoptions\fR]
- .SH DESCRIPTION
- \fBminiflux\fR is a minimalist and opinionated feed reader.
- .PP
- When started without any command option, \fBminiflux\fR runs as a daemon:
- it starts the HTTP server, the background scheduler that refreshes feeds,
- and the cleanup jobs.
- .PP
- Miniflux requires a PostgreSQL database.
- The database schema must be up to date before the daemon starts:
- use \fB\-migrate\fR or set \fBRUN_MIGRATIONS\fR.
- .PP
- Options can be prefixed with one or two dashes.
- .SH OPTIONS
- .TP
- \fB\-c\fR, \fB\-config\-file\fR \fI/path/to/miniflux.conf\fR
- Load configuration file.
- Environment variables override the values defined in the file.
- .TP
- .B \-config\-dump
- Print parsed configuration values and exit.
- The output includes sensitive information like passwords.
- .TP
- .B \-create\-admin
- Create an admin user from an interactive terminal and exit.
- The username and password are prompted for.
- .TP
- .B \-debug
- Set log level to debug.
- .TP
- \fB\-export\-user\-feeds\fR \fIusername\fR
- Export the feeds of the given user as OPML to the standard output and exit.
- .TP
- .B \-flush\-sessions
- Flush all sessions (disconnect users) and exit.
- .TP
- \fB\-h\fR, \fB\-help\fR
- Show usage information and exit.
- .TP
- \fB\-healthcheck\fR \fIendpoint\fR
- Perform a health check on the given endpoint and exit.
- The check fails if the endpoint cannot be reached within 3 seconds
- or does not return HTTP status 200.
- .IP
- The value "auto" builds the endpoint from the first \fBLISTEN_ADDR\fR address
- and the base path of \fBBASE_URL\fR,
- for example http://127.0.0.1:8080/healthcheck.
- .TP
- \fB\-i\fR, \fB\-info\fR
- Show build information and exit.
- .TP
- .B \-migrate
- Run SQL migrations and exit.
- .TP
- .B \-refresh\-feeds
- Refresh a batch of feeds and exit.
- .TP
- .B \-reset\-feed\-errors
- Clear all feed errors for all users and exit.
- .TP
- .B \-reset\-feed\-next\-check\-at
- Reset the next check time for all feeds and exit.
- .TP
- .B \-reset\-password
- Reset a user password from an interactive terminal and exit.
- The username and new password are prompted for.
- .TP
- .B \-run\-cleanup\-tasks
- Run cleanup tasks (delete old sessions and archive old entries) and exit.
- .TP
- \fB\-v\fR, \fB\-version\fR
- Show application version and exit.
- .SH CONFIGURATION FILE
- The configuration file is a text file that follows these rules:
- .PD 0
- .IP \(bu 2
- Each line is in KEY=VALUE format.
- .IP \(bu 2
- Lines beginning with # are comments and are ignored.
- .IP \(bu 2
- Blank lines and lines without "=" are ignored.
- .IP \(bu 2
- Whitespace around keys and values is removed.
- .IP \(bu 2
- Quotes are not removed: values are used as written.
- .IP \(bu 2
- An empty value keeps the default value.
- .IP \(bu 2
- Unknown keys are ignored.
- .IP \(bu 2
- There is no variable interpolation.
- .PD
- .PP
- Keys are the same as the environment variables described below.
- Environment variables override the values defined in the config file.
- .SH ENVIRONMENT
- Boolean options accept the following values (case-insensitive):
- 1/0, yes/no, true/false, on/off.
- .PP
- For variables ending in \fB_FILE\fR,
- the value is a path to a file that contains the corresponding secret value.
- .TP
- .B ADMIN_PASSWORD
- Admin user password, used only if \fBCREATE_ADMIN\fR is enabled.
- .IP
- Default is empty.
- .TP
- .B ADMIN_PASSWORD_FILE
- Path to a secret key exposed as a file,
- it should contain the \fBADMIN_PASSWORD\fR value.
- .IP
- Default is empty.
- .TP
- .B ADMIN_USERNAME
- Admin user login, used only if \fBCREATE_ADMIN\fR is enabled.
- .IP
- Default is empty.
- .TP
- .B ADMIN_USERNAME_FILE
- Path to a secret key exposed as a file,
- it should contain the \fBADMIN_USERNAME\fR value.
- .IP
- Default is empty.
- .TP
- .B AUTH_PROXY_HEADER
- Proxy authentication HTTP header.
- The option \fBTRUSTED_REVERSE_PROXY_NETWORKS\fR must be configured
- to allow the proxy to authenticate users.
- .IP
- Default is empty.
- .TP
- .B AUTH_PROXY_USER_CREATION
- Set to 1 to create users based on proxy authentication information.
- When disabled, users must already exist in Miniflux
- to sign in through the proxy.
- .IP
- Disabled by default.
- .TP
- .B BASE_URL
- Base URL to generate HTML links and base path for cookies.
- The scheme must be http or https.
- .IP
- A path component sets the base path when Miniflux is served from a subfolder,
- for example https://example.org/miniflux/.
- .IP
- Default is http://localhost.
- .TP
- .B BATCH_SIZE
- Number of feeds to send to the queue for each interval.
- .IP
- Default is 100 feeds.
- .TP
- .B CERT_DOMAIN
- Use Let's Encrypt to get automatically a certificate for this domain.
- Miniflux also listens on port 80 to answer the ACME HTTP challenge.
- Certificates are cached in the database.
- .IP
- This option cannot be used with \fBCERT_FILE\fR and \fBKEY_FILE\fR.
- .IP
- Default is empty.
- .TP
- .B CERT_FILE
- Path to SSL certificate.
- Must be used with \fBKEY_FILE\fR.
- .IP
- Default is empty.
- .TP
- .B CLEANUP_ARCHIVE_BATCH_SIZE
- Number of entries to archive for each job interval.
- .IP
- Default is 10000 entries.
- .TP
- .B CLEANUP_ARCHIVE_READ_DAYS
- Number of days before the cleanup job archives read entries.
- .IP
- Archiving deletes non-bookmarked, non-shared read entries from the database
- and records a tombstone to prevent the same entry
- from being imported again during a later feed refresh.
- .IP
- Set to \-1 to disable automatic archiving of read entries.
- .IP
- Default is 60 days.
- .TP
- .B CLEANUP_ARCHIVE_UNREAD_DAYS
- Number of days before the cleanup job archives unread entries.
- .IP
- Archiving deletes non-bookmarked, non-shared unread entries from the database
- and records a tombstone to prevent the same entry
- from being imported again during a later feed refresh.
- .IP
- Set to \-1 to disable automatic archiving of unread entries.
- .IP
- Default is 180 days.
- .TP
- .B CLEANUP_FREQUENCY_HOURS
- Interval in hours between cleanup jobs
- (remove old sessions and archive entries).
- .IP
- Default is 24 hours.
- .TP
- .B CLEANUP_REMOVE_SESSIONS_DAYS
- Number of days after which sessions are removed from the database.
- .IP
- Default is 30 days.
- .TP
- .B CREATE_ADMIN
- Set to 1 to create an admin user from environment variables.
- .IP
- Disabled by default.
- .TP
- .B DATABASE_CONNECTION_LIFETIME
- Maximum amount of time in minutes a connection may be reused.
- .IP
- Default is 5 minutes.
- .TP
- .B DATABASE_MAX_CONNS
- Maximum number of database connections.
- .IP
- Default is 20.
- .TP
- .B DATABASE_MIN_CONNS
- Minimum number of database connections.
- Must be less than or equal to \fBDATABASE_MAX_CONNS\fR.
- .IP
- Default is 1.
- .TP
- .B DATABASE_URL
- PostgreSQL connection parameters.
- .IP
- Default is "user=postgres password=postgres dbname=miniflux2 sslmode=disable".
- .TP
- .B DATABASE_URL_FILE
- Path to a secret key exposed as a file,
- it should contain the \fBDATABASE_URL\fR value.
- .IP
- Default is empty.
- .TP
- .B DISABLE_API
- Disable miniflux's API.
- .IP
- Default is false (the API is enabled).
- .TP
- .B DISABLE_HSTS
- Disable HTTP Strict Transport Security header if \fBHTTPS\fR is set.
- .IP
- Default is false (HSTS is enabled).
- .TP
- .B DISABLE_HTTP_SERVICE
- Set the value to 1 to disable the HTTP service.
- .IP
- Default is false (the HTTP service is enabled).
- .TP
- .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.
- .IP
- Password authentication is also rejected by the login form
- and by the REST API HTTP Basic Authentication,
- and passwords can no longer be changed.
- API clients must use an API key instead.
- .IP
- This option requires an alternative authentication source
- such as OAuth2, auth proxy, or WebAuthn/Passkeys.
- If remote user creation is disabled, only existing users can sign in.
- .IP
- To use WebAuthn as the only authentication method,
- register at least one Passkey while another authentication method is available,
- before enabling \fBDISABLE_LOCAL_AUTH\fR.
- .IP
- Default is false.
- .TP
- .B DISABLE_SCHEDULER_SERVICE
- Set the value to 1 to disable the internal scheduler service.
- .IP
- Default is false (the internal scheduler service is enabled).
- .TP
- .B FETCHER_ALLOW_PRIVATE_FEED_PROXY
- Set to 1 to allow feed proxy URLs to use private or loopback network addresses.
- .IP
- This option applies to all authenticated users
- and should only be enabled when the private proxy boundary is trusted.
- .IP
- Disabled by default.
- .TP
- .B FETCHER_ALLOW_PRIVATE_NETWORKS
- Set to 1 to allow outgoing fetcher requests to private or loopback networks.
- .IP
- Disabled by default, private networks are refused.
- .TP
- .B FETCH_BILIBILI_WATCH_TIME
- Set the value to 1 to scrape video duration from Bilibili website
- and use it as a reading time.
- .IP
- Disabled by default.
- .TP
- .B FETCH_NEBULA_WATCH_TIME
- Set the value to 1 to scrape video duration from Nebula website
- and use it as a reading time.
- .IP
- Disabled by default.
- .TP
- .B FETCH_ODYSEE_WATCH_TIME
- Set the value to 1 to scrape video duration from Odysee website
- and use it as a reading time.
- .IP
- Disabled by default.
- .TP
- .B FETCH_YOUTUBE_WATCH_TIME
- Set the value to 1 to scrape video duration from YouTube website
- and use it as a reading time.
- .IP
- Disabled by default.
- .TP
- .B FORCE_REFRESH_INTERVAL
- Minimum interval in minutes between two manual refreshes.
- .IP
- Default is 30 minutes.
- .TP
- .B HTTP_CLIENT_MAX_BODY_SIZE
- Maximum body size for HTTP requests in Mebibyte (MiB).
- .IP
- Default is 15 MiB.
- .TP
- .B HTTP_CLIENT_PROXIES
- Enable proxy rotation for outgoing requests
- by providing a comma-separated list of proxy URLs.
- .IP
- Default is empty.
- .TP
- .B HTTP_CLIENT_PROXY
- Proxy URL to use when the "Fetch via proxy" feed option is enabled.
- .IP
- Default is empty.
- .TP
- .B HTTP_CLIENT_TIMEOUT
- Time limit in seconds before the HTTP client cancels the request.
- .IP
- Default is 20 seconds.
- .TP
- .B HTTP_CLIENT_USER_AGENT
- The default User-Agent header to use for the HTTP client.
- It can be overridden in per-feed settings.
- .IP
- When empty, Miniflux uses a default User-Agent
- that includes the Miniflux version.
- .IP
- Default is empty.
- .TP
- .B HTTP_SERVER_TIMEOUT
- Read, write, and idle timeout in seconds for the HTTP server.
- .IP
- Default is 300 seconds.
- .TP
- .B HTTPS
- Forces cookies to use secure flag and send HSTS header.
- .IP
- Default is disabled.
- .TP
- .B INTEGRATION_ALLOW_PRIVATE_NETWORKS
- Set to 1 to allow outgoing integration requests to private or loopback networks.
- .IP
- Disabled by default, private networks are refused.
- .TP
- .B INVIDIOUS_INSTANCE
- Set a custom invidious instance to use.
- .IP
- Default is yewtu.be.
- .TP
- .B KEY_FILE
- Path to SSL private key.
- Must be used with \fBCERT_FILE\fR.
- .IP
- Default is empty.
- .TP
- .B LISTEN_ADDR
- Address to listen on.
- Multiple addresses can be specified, separated by commas,
- for example 127.0.0.1:8080, 127.0.0.1:8081.
- .IP
- Use an absolute path to listen on a Unix socket (/var/run/miniflux.sock).
- When Miniflux creates the socket itself, it uses mode \fB0660\fR.
- This mode is hardcoded and cannot be configured.
- .IP
- With systemd socket activation, Miniflux uses the socket passed by systemd
- and only the first address is taken into account.
- .IP
- Default is 127.0.0.1:8080.
- .TP
- .B LOG_DATE_TIME
- Display the date and time in log messages.
- .IP
- Disabled by default.
- .TP
- .B LOG_FILE
- Supported values are "stderr", "stdout", or a file name.
- .IP
- Default is "stderr".
- .TP
- .B LOG_FORMAT
- Supported log formats are "text" or "json".
- .IP
- Default is "text".
- .TP
- .B LOG_LEVEL
- Supported values are "debug", "info", "warning", or "error".
- .IP
- Default is "info".
- .TP
- .B MAINTENANCE_MESSAGE
- Define a custom maintenance message.
- .IP
- Default is "Miniflux is currently under maintenance".
- .TP
- .B MAINTENANCE_MODE
- Set to 1 to enable maintenance mode.
- .IP
- Disabled by default.
- .TP
- .B MEDIA_PROXY_CUSTOM_URL
- Sets an external server to proxy media through.
- .IP
- Default is empty, Miniflux does the proxying.
- .TP
- .B MEDIA_PROXY_HTTP_CLIENT_TIMEOUT
- Time limit in seconds before the media proxy HTTP client cancels the request.
- .IP
- Default is 120 seconds.
- .TP
- .B MEDIA_PROXY_MODE
- Possible values are:
- .RS
- .TP
- .B http\-only
- Proxy only media served over insecure HTTP.
- .TP
- .B all
- Proxy all media.
- .TP
- .B none
- Disable the media proxy.
- .RE
- .IP
- Default is "http-only".
- .TP
- .B MEDIA_PROXY_PRIVATE_KEY
- Set a custom private key used to sign proxified media URLs.
- .IP
- By default, a secret key is randomly generated during startup.
- Proxified URLs are therefore invalidated on restart
- and are not shared between multiple instances.
- Set this option to keep them stable.
- .TP
- .B MEDIA_PROXY_RESOURCE_TYPES
- A comma-separated list of media types to proxify.
- Supported values are: image, audio, video.
- .IP
- Default is image.
- .TP
- .B METRICS_ALLOWED_NETWORKS
- List of networks allowed to access the metrics endpoint
- (comma-separated values).
- .IP
- Default is 127.0.0.1/8.
- .TP
- .B METRICS_COLLECTOR
- Set to 1 to enable the metrics collector
- and expose a /metrics endpoint for Prometheus.
- .IP
- Disabled by default.
- .TP
- .B METRICS_PASSWORD
- Metrics endpoint password for basic HTTP authentication.
- Must be used with \fBMETRICS_USERNAME\fR.
- .IP
- Default is empty.
- .TP
- .B METRICS_PASSWORD_FILE
- Path to a file that contains the password
- for the metrics endpoint HTTP authentication.
- .IP
- Default is empty.
- .TP
- .B METRICS_REFRESH_INTERVAL
- Interval in seconds between two collections of database metrics.
- .IP
- Default is 60 seconds.
- .TP
- .B METRICS_USERNAME
- Metrics endpoint username for basic HTTP authentication.
- Must be used with \fBMETRICS_PASSWORD\fR.
- .IP
- Default is empty.
- .TP
- .B METRICS_USERNAME_FILE
- Path to a file that contains the username
- for the metrics endpoint HTTP authentication.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_ADDITIONAL_SCOPES
- Additional OAuth2 scopes to request.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_ADMIN_GROUP
- Group for administrators.
- When set, the admin role is mapped based on the specified group.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_CLIENT_ID
- OAuth2 client ID.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_CLIENT_ID_FILE
- Path to a secret key exposed as a file,
- it should contain the \fBOAUTH2_CLIENT_ID\fR value.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_CLIENT_SECRET
- OAuth2 client secret.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_CLIENT_SECRET_FILE
- Path to a secret key exposed as a file,
- it should contain the \fBOAUTH2_CLIENT_SECRET\fR value.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_GROUP_CLAIM
- Claim that contains user groups,
- which can be used for mapping the admin role.
- .IP
- The claim is read from the user info response, then from the ID token.
- Users without this claim are not administrators.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_OIDC_DISCOVERY_ENDPOINT
- OpenID Connect discovery endpoint.
- Required when \fBOAUTH2_PROVIDER\fR is set to "oidc".
- .IP
- Default is empty.
- .TP
- .B OAUTH2_OIDC_PROVIDER_NAME
- Name to display for the OIDC provider.
- .IP
- Default is "OpenID Connect".
- .TP
- .B OAUTH2_PROVIDER
- Possible values are "google" or "oidc".
- .IP
- Default is empty.
- .TP
- .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.
- .IP
- Default is empty.
- .TP
- .B OAUTH2_USER_CREATION
- Set to 1 to authorize OAuth2 user creation.
- When disabled, users must already exist in Miniflux
- or have a linked OAuth2 account to sign in.
- .IP
- Disabled by default.
- .TP
- .B POLLING_FREQUENCY
- Interval in minutes for the background job scheduler.
- It determines how often a batch of feeds is selected for refresh,
- based on their last refresh time.
- .IP
- Default is 60 minutes.
- .TP
- .B POLLING_LIMIT_PER_HOST
- Limits the number of concurrent requests to the same hostname
- when polling feeds.
- This helps prevent overwhelming a single server
- during batch processing by the worker pool.
- .IP
- Default is 0 (disabled).
- .TP
- .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.
- .IP
- Default is 3.
- .TP
- .B POLLING_SCHEDULER
- Determines the strategy used to schedule feed polling.
- Supported values are:
- .RS
- .TP
- .B round_robin
- Feeds are polled in a fixed, rotating order.
- .TP
- .B entry_frequency
- The polling interval for each feed is based on
- the average update frequency over the past week.
- .RE
- .IP
- The number of feeds polled in a given period is limited by
- the \fBPOLLING_FREQUENCY\fR and \fBBATCH_SIZE\fR settings.
- Regardless of the scheduler used,
- the total number of polled feeds will not exceed
- the maximum allowed per polling cycle.
- .IP
- Default is "round_robin".
- .TP
- .B PORT
- Override \fBLISTEN_ADDR\fR with \fB:$PORT\fR,
- which listens on all network interfaces.
- The value must be between 1 and 65535.
- .IP
- Default is empty.
- .TP
- .B RUN_MIGRATIONS
- Set to 1 to run database migrations.
- .IP
- Disabled by default.
- .TP
- .B SCHEDULER_ENTRY_FREQUENCY_FACTOR
- Factor to increase refresh frequency for the entry frequency scheduler.
- .IP
- Default is 1.
- .TP
- .B SCHEDULER_ENTRY_FREQUENCY_MAX_INTERVAL
- Maximum interval in minutes for the entry frequency scheduler.
- .IP
- Default is 1440 minutes (24 hours).
- .TP
- .B SCHEDULER_ENTRY_FREQUENCY_MIN_INTERVAL
- Minimum interval in minutes for the entry frequency scheduler.
- Must be less than or equal to
- \fBSCHEDULER_ENTRY_FREQUENCY_MAX_INTERVAL\fR.
- .IP
- Default is 5 minutes.
- .TP
- .B SCHEDULER_ROUND_ROBIN_MAX_INTERVAL
- Maximum interval in minutes for the round robin scheduler.
- .IP
- Default is 1440 minutes (24 hours).
- .TP
- .B SCHEDULER_ROUND_ROBIN_MIN_INTERVAL
- Minimum interval in minutes for the round robin scheduler.
- Must be less than or equal to
- \fBSCHEDULER_ROUND_ROBIN_MAX_INTERVAL\fR.
- .IP
- Default is 60 minutes.
- .TP
- .B TRUSTED_REVERSE_PROXY_NETWORKS
- A comma-separated list of networks (CIDR notation) allowed to use
- the proxy authentication header,
- \fBX-Forwarded-For\fR, \fBX-Forwarded-Proto\fR, and \fBX-Real-Ip\fR headers.
- .IP
- Default is empty.
- .TP
- .B WATCHDOG
- Enable or disable Systemd watchdog.
- .IP
- Enabled by default.
- .TP
- .B WEBAUTHN
- Enable or disable WebAuthn/Passkey authentication.
- .IP
- You must provide a username on the login page
- if you are using non-discoverable (non-resident) credentials,
- such as some hardware security keys.
- This is not required for discoverable credentials (Passkeys).
- .IP
- Default is disabled.
- .TP
- .B WORKER_POOL_SIZE
- Number of background workers.
- .IP
- Default is 16 workers.
- .TP
- .B YOUTUBE_API_KEY
- YouTube API key for use with \fBFETCH_YOUTUBE_WATCH_TIME\fR.
- If nonempty, the duration will be fetched from the YouTube API.
- Otherwise, the duration will be fetched from the YouTube website.
- .IP
- Default is empty.
- .TP
- .B YOUTUBE_EMBED_URL_OVERRIDE
- YouTube URL which will be used for embeds.
- .IP
- Default is https://www.youtube-nocookie.com/embed/.
- .SH FILES
- .TP
- .I /etc/miniflux.conf
- Configuration file installed by the Debian and RPM packages.
- The systemd service loads it as environment variables.
- .SH EXIT STATUS
- \fBminiflux\fR exits with status 0 on success and 1 on error.
- With \fB\-healthcheck\fR, a non-zero status means the health check failed.
- .SH EXAMPLES
- Run the database migrations and create an admin user
- from environment variables:
- .PP
- .EX
- export DATABASE_URL="postgres://miniflux:secret@localhost/miniflux?sslmode=disable"
- RUN_MIGRATIONS=1 CREATE_ADMIN=1 ADMIN_USERNAME=admin \e
- ADMIN_PASSWORD=changeme miniflux
- .EE
- .PP
- Start Miniflux with a configuration file:
- .PP
- .EX
- miniflux \-c /etc/miniflux.conf
- .EE
- .PP
- Check that a running instance is healthy,
- for example in a container health check:
- .PP
- .EX
- miniflux \-healthcheck auto
- .EE
- .PP
- Export the feeds of a user:
- .PP
- .EX
- miniflux \-export\-user\-feeds someone > feeds.xml
- .EE
- .SH SEE ALSO
- Online documentation: https://miniflux.app/docs/
- .SH AUTHORS
- Miniflux is developed and maintained by Fr\['e]d\['e]ric Guillot
- with contributions from the Miniflux community.
- .SH "COPYRIGHT"
- Miniflux is released under the Apache 2.0 license.
|