Miniflux#

Miniflux is a minimalist and opinionated feed reader.

amd64
arm64
armv7

Information#

Docker Image: !!! LINK TO DOCKER IMAGE/ DOCKER HUB !!!
Current Image Version: 2.0.21

SETUP#

Enabling miniflux#

Command:#

vlab set miniflux.enable True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

miniflux
enable: True

Finalising changes:#

run: vlab update_one service=miniflux

FIRST RUN#

!!! DEVELOPERS: make sure that you include any information that the user requires to get started, below. !!!
!!! Below are some examples with headings, and with some example instructions !!!

ADMINISTRATOR SETUP#

Navigate to https://False/admin

Create an account with your desired username; as this is the first user, miniflux makes this account the administrator.

SMTP/ MAIL#

  1. run vlab decrypt to decrypt the vault.yml file
  2. make some changes

SMTP Settings#

smtp:
host:
port:
user:
pass:
from_email:
from_name:
  1. run vlab update_one service=miniflux to complete the changes

ACCESS#

miniflux (HTTPS) link: https://miniflux.vivumlab.xyz/ miniflux (HTTP) link: http://miniflux.vivumlab.xyz/

OPTIONS#

HTTPS_ONLY#

Default: False
Options: True/False

Command:#

vlab set miniflux.https_only True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

miniflux
https_only: True
Finalising changes:#

run: vlab update_one service=miniflux

AUTH#

Default: False
Options: True/False

Command:#

vlab set miniflux.auth True

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

miniflux
auth: True
Finalising changes:#

run: vlab update_one service=miniflux

DOMAIN#

Default: False
NOTE: include the sitename and top level domain suffix. eg. name.com, site.net

Command:#

vlab set miniflux.domain miniflux.com

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

miniflux
domain: miniflux.com
Finalising changes:#

run: vlab update_one service=miniflux

SUBDOMAIN#

Default: miniflux
NOTE: Periods/ delimiters are not required. eg. 'media' will set the full URL as 'media.vivumlab.xyz'

Command:#

vlab set miniflux.subdomain media

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

miniflux
subdomain: media
Finalising changes:#

run: vlab update_one service=miniflux

VERSION#

Default: 2.0.21
NOTE: Ensure that the version exists

Command:#

vlab set miniflux.version 2.7

File alteration:#

set the appropriate service settings in settings/config.yml to true

eg.

miniflux
version: 2.7
Finalising changes:#

run: vlab update_one service=miniflux

Need more help?#

Further information regarding services can be found.
General Information can be found in the documentation.
Additional assistance can be found on our Contact Us page.