Miniflux¶

Description / name	Input element
Your domain name

Overview¶

Miniflux is a minimalist and opinionated feed reader.

Manual

Releases

Community

Deployment¶

sb install sandbox-miniflux

Usage¶

Visit https://miniflux.iYOUR_DOMAIN_NAMEi.

Role Defaults¶

Use the Inventory to customize variables. (1)

Example override
```
miniflux_name: "custom_value"
```
Avoid overriding variables ending in _default

When overriding variables that end in _default (like miniflux_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.

Instead, use the corresponding _custom variable (like miniflux_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.

BasicsSettingsWebDNSTraefikDockerDocker+Global Override Options

miniflux_name

# Type: string
miniflux_name: miniflux

miniflux_role_admin_username

# Type: string
miniflux_role_admin_username: "{{ user.name }}"

miniflux_role_admin_password

# Type: string
miniflux_role_admin_password: "{{ user.pass }}"

miniflux_role_create_admin

# Type: string
miniflux_role_create_admin: "1"

miniflux_role_run_migrations

# Type: string
miniflux_role_run_migrations: "1"

miniflux_role_postgres_deploy

# Type: bool (true/false)
miniflux_role_postgres_deploy: true

miniflux_role_postgres_name

# Type: string
miniflux_role_postgres_name: "{{ miniflux_name }}-postgres"

miniflux_role_postgres_user

# Type: string
miniflux_role_postgres_user: "{{ postgres_role_docker_env_user }}"

miniflux_role_postgres_password

# Type: string
miniflux_role_postgres_password: "{{ postgres_role_docker_env_password }}"

miniflux_role_postgres_docker_env_db

# Type: string
miniflux_role_postgres_docker_env_db: "miniflux"

miniflux_role_postgres_docker_image_tag

# Type: string
miniflux_role_postgres_docker_image_tag: "14-alpine"

miniflux_role_postgres_docker_image_repo

# Type: string
miniflux_role_postgres_docker_image_repo: "postgres"

miniflux_role_postgres_docker_healthcheck

# Type: dict
miniflux_role_postgres_docker_healthcheck:
  test: ["CMD-SHELL", "pg_isready -d {{ lookup('role_var', '_postgres_docker_env_db', role='miniflux') }} -U {{ postgres_role_docker_env_user }}"]
  start_period: 20s
  interval: 30s
  retries: 5
  timeout: 5s

miniflux_role_postgres_paths_folder

# Type: string
miniflux_role_postgres_paths_folder: "{{ miniflux_name }}"

miniflux_role_postgres_paths_location

# Type: string
miniflux_role_postgres_paths_location: "{{ server_appdata_path }}/{{ miniflux_role_postgres_paths_folder }}/postgres"

miniflux_role_web_subdomain

# Type: string
miniflux_role_web_subdomain: "{{ miniflux_name }}"

miniflux_role_web_domain

# Type: string
miniflux_role_web_domain: "{{ user.domain }}"

miniflux_role_web_port

# Type: string
miniflux_role_web_port: "8080"

miniflux_role_web_url

# Type: string
miniflux_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='miniflux') + '.' + lookup('role_var', '_web_domain', role='miniflux')
                        if (lookup('role_var', '_web_subdomain', role='miniflux') | length > 0)
                        else lookup('role_var', '_web_domain', role='miniflux')) }}"

miniflux_role_dns_record

# Type: string
miniflux_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='miniflux') }}"

miniflux_role_dns_zone

# Type: string
miniflux_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='miniflux') }}"

miniflux_role_dns_proxy

# Type: bool (true/false)
miniflux_role_dns_proxy: "{{ dns_proxied }}"

miniflux_role_traefik_sso_middleware

# Type: string
miniflux_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"

miniflux_role_traefik_middleware_default

# Type: string
miniflux_role_traefik_middleware_default: "{{ traefik_default_middleware }}"

miniflux_role_traefik_middleware_custom

# Type: string
miniflux_role_traefik_middleware_custom: ""

miniflux_role_traefik_certresolver

# Type: string
miniflux_role_traefik_certresolver: "{{ traefik_default_certresolver }}"

miniflux_role_traefik_enabled

# Type: bool (true/false)
miniflux_role_traefik_enabled: true

miniflux_role_traefik_api_enabled

# Type: bool (true/false)
miniflux_role_traefik_api_enabled: false

miniflux_role_traefik_api_endpoint

# Type: string
miniflux_role_traefik_api_endpoint: ""

Container

miniflux_role_docker_container

# Type: string
miniflux_role_docker_container: "{{ miniflux_name }}"

Image

miniflux_role_docker_image_pull

# Type: bool (true/false)
miniflux_role_docker_image_pull: true

miniflux_role_docker_image_tag

# Type: string
miniflux_role_docker_image_tag: "latest"

miniflux_role_docker_image_repo

# Type: string
miniflux_role_docker_image_repo: "miniflux/miniflux"

miniflux_role_docker_image

# Type: string
miniflux_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='miniflux') }}:{{ lookup('role_var', '_docker_image_tag', role='miniflux') }}"

Envs

miniflux_role_docker_envs_default

# Type: dict
miniflux_role_docker_envs_default:
  DATABASE_URL: "postgres://{{ lookup('role_var', '_postgres_user', role='miniflux') }}:{{ lookup('role_var', '_postgres_password', role='miniflux') }}@{{ lookup('role_var', '_postgres_name', role='miniflux') }}/{{ lookup('role_var', '_postgres_docker_env_db', role='miniflux') }}?sslmode=disable"
  RUN_MIGRATIONS: "{{ lookup('role_var', '_run_migrations', role='miniflux') }}"
  CREATE_ADMIN: "{{ lookup('role_var', '_create_admin', role='miniflux') }}"
  ADMIN_USERNAME: "{{ lookup('role_var', '_admin_username', role='miniflux') }}"
  ADMIN_PASSWORD: "{{ lookup('role_var', '_admin_password', role='miniflux') }}"

miniflux_role_docker_envs_custom

# Type: dict
miniflux_role_docker_envs_custom: {}

Volumes

miniflux_role_docker_volumes_default

# Type: list
miniflux_role_docker_volumes_default:
  - /etc/localtime:/etc/localtime:ro

miniflux_role_docker_volumes_custom

# Type: list
miniflux_role_docker_volumes_custom: []

Hostname

miniflux_role_docker_hostname

# Type: string
miniflux_role_docker_hostname: "{{ miniflux_name }}"

Networks

miniflux_role_docker_networks_alias

# Type: string
miniflux_role_docker_networks_alias: "{{ miniflux_name }}"

miniflux_role_docker_networks_default

# Type: list
miniflux_role_docker_networks_default: []

miniflux_role_docker_networks_custom

# Type: list
miniflux_role_docker_networks_custom: []

Restart Policy

miniflux_role_docker_restart_policy

# Type: string
miniflux_role_docker_restart_policy: unless-stopped

State

miniflux_role_docker_state

# Type: string
miniflux_role_docker_state: started

Dependencies

minuflux_role_depends_on

# Type: string
minuflux_role_depends_on: "{{ minuflux_role_postgres_name }}"

minuflux_role_depends_on_delay

# Type: string (quoted number)
minuflux_role_depends_on_delay: "0"

minuflux_role_depends_on_healthchecks

# Type: string ("true"/"false")
minuflux_role_depends_on_healthchecks: "false"

The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module

Resource Limits

miniflux_role_docker_blkio_weight

# Type: int
miniflux_role_docker_blkio_weight:

miniflux_role_docker_cpu_period

# Type: int
miniflux_role_docker_cpu_period:

miniflux_role_docker_cpu_quota

# Type: int
miniflux_role_docker_cpu_quota:

miniflux_role_docker_cpu_shares

# Type: int
miniflux_role_docker_cpu_shares:

miniflux_role_docker_cpus

# Type: string
miniflux_role_docker_cpus:

miniflux_role_docker_cpuset_cpus

# Type: string
miniflux_role_docker_cpuset_cpus:

miniflux_role_docker_cpuset_mems

# Type: string
miniflux_role_docker_cpuset_mems:

miniflux_role_docker_kernel_memory

# Type: string
miniflux_role_docker_kernel_memory:

miniflux_role_docker_memory

# Type: string
miniflux_role_docker_memory:

miniflux_role_docker_memory_reservation

# Type: string
miniflux_role_docker_memory_reservation:

miniflux_role_docker_memory_swap

# Type: string
miniflux_role_docker_memory_swap:

miniflux_role_docker_memory_swappiness

# Type: int
miniflux_role_docker_memory_swappiness:

miniflux_role_docker_shm_size

# Type: string
miniflux_role_docker_shm_size:

Security & Devices

miniflux_role_docker_cap_drop

# Type: list
miniflux_role_docker_cap_drop:

miniflux_role_docker_cgroupns_mode

# Type: string
miniflux_role_docker_cgroupns_mode:

miniflux_role_docker_device_cgroup_rules

# Type: list
miniflux_role_docker_device_cgroup_rules:

miniflux_role_docker_device_read_bps

# Type: list
miniflux_role_docker_device_read_bps:

miniflux_role_docker_device_read_iops

# Type: list
miniflux_role_docker_device_read_iops:

miniflux_role_docker_device_requests

# Type: list
miniflux_role_docker_device_requests:

miniflux_role_docker_device_write_bps

# Type: list
miniflux_role_docker_device_write_bps:

miniflux_role_docker_device_write_iops

# Type: list
miniflux_role_docker_device_write_iops:

miniflux_role_docker_devices

# Type: list
miniflux_role_docker_devices:

miniflux_role_docker_devices_default

# Type: string
miniflux_role_docker_devices_default:

miniflux_role_docker_groups

# Type: list
miniflux_role_docker_groups:

miniflux_role_docker_privileged

# Type: bool (true/false)
miniflux_role_docker_privileged:

miniflux_role_docker_security_opts

# Type: list
miniflux_role_docker_security_opts:

miniflux_role_docker_user

# Type: string
miniflux_role_docker_user:

miniflux_role_docker_userns_mode

# Type: string
miniflux_role_docker_userns_mode:

Networking

miniflux_role_docker_dns_opts

# Type: list
miniflux_role_docker_dns_opts:

miniflux_role_docker_dns_search_domains

# Type: list
miniflux_role_docker_dns_search_domains:

miniflux_role_docker_dns_servers

# Type: list
miniflux_role_docker_dns_servers:

miniflux_role_docker_domainname

# Type: string
miniflux_role_docker_domainname:

miniflux_role_docker_exposed_ports

# Type: list
miniflux_role_docker_exposed_ports:

miniflux_role_docker_hosts

# Type: dict
miniflux_role_docker_hosts:

miniflux_role_docker_hosts_use_common

# Type: bool (true/false)
miniflux_role_docker_hosts_use_common:

miniflux_role_docker_ipc_mode

# Type: string
miniflux_role_docker_ipc_mode:

miniflux_role_docker_links

# Type: list
miniflux_role_docker_links:

miniflux_role_docker_network_mode

# Type: string
miniflux_role_docker_network_mode:

miniflux_role_docker_pid_mode

# Type: string
miniflux_role_docker_pid_mode:

miniflux_role_docker_ports

# Type: list
miniflux_role_docker_ports:

miniflux_role_docker_uts

# Type: string
miniflux_role_docker_uts:

Storage

miniflux_role_docker_keep_volumes

# Type: bool (true/false)
miniflux_role_docker_keep_volumes:

miniflux_role_docker_mounts

# Type: list
miniflux_role_docker_mounts:

miniflux_role_docker_storage_opts

# Type: dict
miniflux_role_docker_storage_opts:

miniflux_role_docker_tmpfs

# Type: list
miniflux_role_docker_tmpfs:

miniflux_role_docker_volume_driver

# Type: string
miniflux_role_docker_volume_driver:

miniflux_role_docker_volumes_from

# Type: list
miniflux_role_docker_volumes_from:

miniflux_role_docker_volumes_global

# Type: bool (true/false)
miniflux_role_docker_volumes_global:

miniflux_role_docker_working_dir

# Type: string
miniflux_role_docker_working_dir:

Monitoring & Lifecycle

miniflux_role_docker_auto_remove

# Type: bool (true/false)
miniflux_role_docker_auto_remove:

miniflux_role_docker_cleanup

# Type: bool (true/false)
miniflux_role_docker_cleanup:

miniflux_role_docker_force_kill

# Type: string
miniflux_role_docker_force_kill:

miniflux_role_docker_healthcheck

# Type: dict
miniflux_role_docker_healthcheck:

miniflux_role_docker_healthy_wait_timeout

# Type: int
miniflux_role_docker_healthy_wait_timeout:

miniflux_role_docker_init

# Type: bool (true/false)
miniflux_role_docker_init:

miniflux_role_docker_kill_signal

# Type: string
miniflux_role_docker_kill_signal:

miniflux_role_docker_log_driver

# Type: string
miniflux_role_docker_log_driver:

miniflux_role_docker_log_options

# Type: dict
miniflux_role_docker_log_options:

miniflux_role_docker_oom_killer

# Type: bool (true/false)
miniflux_role_docker_oom_killer:

miniflux_role_docker_oom_score_adj

# Type: int
miniflux_role_docker_oom_score_adj:

miniflux_role_docker_output_logs

# Type: bool (true/false)
miniflux_role_docker_output_logs:

miniflux_role_docker_paused

# Type: bool (true/false)
miniflux_role_docker_paused:

miniflux_role_docker_recreate

# Type: bool (true/false)
miniflux_role_docker_recreate:

miniflux_role_docker_restart_retries

# Type: int
miniflux_role_docker_restart_retries:

miniflux_role_docker_stop_timeout

# Type: int
miniflux_role_docker_stop_timeout:

Other Options

miniflux_role_docker_capabilities

# Type: list
miniflux_role_docker_capabilities:

miniflux_role_docker_cgroup_parent

# Type: string
miniflux_role_docker_cgroup_parent:

miniflux_role_docker_commands

# Type: list
miniflux_role_docker_commands:

miniflux_role_docker_create_timeout

# Type: int
miniflux_role_docker_create_timeout:

miniflux_role_docker_entrypoint

# Type: string
miniflux_role_docker_entrypoint:

miniflux_role_docker_env_file

# Type: string
miniflux_role_docker_env_file:

miniflux_role_docker_labels

# Type: dict
miniflux_role_docker_labels:

miniflux_role_docker_labels_use_common

# Type: bool (true/false)
miniflux_role_docker_labels_use_common:

miniflux_role_docker_read_only

# Type: bool (true/false)
miniflux_role_docker_read_only:

miniflux_role_docker_runtime

# Type: string
miniflux_role_docker_runtime:

miniflux_role_docker_sysctls

# Type: list
miniflux_role_docker_sysctls:

miniflux_role_docker_ulimits

# Type: list
miniflux_role_docker_ulimits:

miniflux_role_admin_password

# Type: string
miniflux_role_admin_password:

miniflux_role_admin_username

# Type: string
miniflux_role_admin_username:

miniflux_role_autoheal_enabled

# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
miniflux_role_autoheal_enabled: true

miniflux_role_create_admin

# Type: string
miniflux_role_create_admin:

miniflux_role_depends_on

# List of container dependencies that must be running before the container start
# Type: string
miniflux_role_depends_on: ""

miniflux_role_depends_on_delay

# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
miniflux_role_depends_on_delay: "0"

miniflux_role_depends_on_healthchecks

# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
miniflux_role_depends_on_healthchecks:

miniflux_role_diun_enabled

# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
miniflux_role_diun_enabled: true

miniflux_role_dns_enabled

# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
miniflux_role_dns_enabled: true

miniflux_role_docker_controller

# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
miniflux_role_docker_controller: true

miniflux_role_docker_image_repo

# Type: string
miniflux_role_docker_image_repo:

miniflux_role_docker_image_tag

# Type: string
miniflux_role_docker_image_tag:

miniflux_role_docker_volumes_download

# Type: bool (true/false)
miniflux_role_docker_volumes_download:

miniflux_role_postgres_docker_env_db

# Type: string
miniflux_role_postgres_docker_env_db:

miniflux_role_postgres_name

# Type: string
miniflux_role_postgres_name:

miniflux_role_postgres_password

# Type: string
miniflux_role_postgres_password:

miniflux_role_postgres_user

# Type: string
miniflux_role_postgres_user:

miniflux_role_run_migrations

# Type: string
miniflux_role_run_migrations:

miniflux_role_themepark_addons

# Type: string
miniflux_role_themepark_addons:

miniflux_role_themepark_app

# Type: string
miniflux_role_themepark_app:

miniflux_role_themepark_theme

# Type: string
miniflux_role_themepark_theme:

miniflux_role_traefik_api_endpoint

# Type: dict/omit
miniflux_role_traefik_api_endpoint:

miniflux_role_traefik_api_middleware

# Type: string
miniflux_role_traefik_api_middleware:

miniflux_role_traefik_api_middleware_http

# Type: string
miniflux_role_traefik_api_middleware_http:

miniflux_role_traefik_autodetect_enabled

# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
miniflux_role_traefik_autodetect_enabled: false

miniflux_role_traefik_certresolver

# Type: string
miniflux_role_traefik_certresolver:

miniflux_role_traefik_crowdsec_enabled

# Enable CrowdSec middleware for the container
# Type: bool (true/false)
miniflux_role_traefik_crowdsec_enabled: false

miniflux_role_traefik_error_pages_enabled

# Enable custom error pages middleware for the container
# Type: bool (true/false)
miniflux_role_traefik_error_pages_enabled: false

miniflux_role_traefik_gzip_enabled

# Enable gzip compression middleware for the container
# Type: bool (true/false)
miniflux_role_traefik_gzip_enabled: false

miniflux_role_traefik_middleware_http

# Type: string
miniflux_role_traefik_middleware_http:

miniflux_role_traefik_middleware_http_api_insecure

# Type: bool (true/false)
miniflux_role_traefik_middleware_http_api_insecure:

miniflux_role_traefik_middleware_http_insecure

# Type: bool (true/false)
miniflux_role_traefik_middleware_http_insecure:

miniflux_role_traefik_priority

# Type: string
miniflux_role_traefik_priority:

miniflux_role_traefik_robot_enabled

# Enable robots.txt middleware for the container
# Type: bool (true/false)
miniflux_role_traefik_robot_enabled: true

miniflux_role_traefik_tailscale_enabled

# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
miniflux_role_traefik_tailscale_enabled: false

miniflux_role_traefik_wildcard_enabled

# Enable wildcard certificate for the container
# Type: bool (true/false)
miniflux_role_traefik_wildcard_enabled: true

miniflux_role_web_domain

# Type: string
miniflux_role_web_domain:

miniflux_role_web_fqdn_override

# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
miniflux_role_web_fqdn_override:

Example Override

miniflux_role_web_fqdn_override:
  - "{{ traefik_host }}"
  - "miniflux2.{{ user.domain }}"
  - "miniflux.otherdomain.tld"

Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries

miniflux_role_web_host_override

# Override the Traefik web host configuration for the container
# Type: string
miniflux_role_web_host_override:

Example Override

miniflux_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'miniflux2.' + user.domain }}`)"

Note: Use {{ traefik_host }} to include the default host configuration in your custom rule

miniflux_role_web_http_port

# Type: string (quoted number)
miniflux_role_web_http_port:

miniflux_role_web_http_scheme

# Type: string ("http"/"https")
miniflux_role_web_http_scheme:

miniflux_role_web_http_serverstransport

# Type: dict/omit
miniflux_role_web_http_serverstransport:

miniflux_role_web_scheme

# URL scheme to use for web access to the container
# Type: string ("http"/"https")
miniflux_role_web_scheme:

miniflux_role_web_serverstransport

# Type: dict/omit
miniflux_role_web_serverstransport:

miniflux_role_web_subdomain

# Type: string
miniflux_role_web_subdomain: