Portainer Templates logo

Portainer Templates

Miniflux

Stack

Feed Reader

Miniflux is a minimalist and opinionated feed reader.

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

miniflux-db

Configuration

Image
postgres:15
Volumes
/var/lib/postgresql/data : /portainer/Files/AppData/Config/minifluxdb
Env vars
POSTGRES_DB=minifluxPOSTGRES_USER=minifluxuserPOSTGRES_PASSWORD=minifluxpass
Restart
always

Image details

Pulls: 11.2B
User: stackbrew
Created: Jun 05, 2014
Updated: 39 minutes ago
Status: active

miniflux

Configuration

Image
miniflux/miniflux:latest
Ports
8645:8080
Env vars
DATABASE_URL=postgres://minifluxuser:minifluxpass@miniflux-db/miniflux?sslmode=disableRUN_MIGRATIONS=1CREATE_ADMIN=1ADMIN_USERNAME=adminADMIN_PASSWORD=adminpass
Restart
always

Image details

Pulls: 34.4M
User: miniflux
Created: Jan 05, 2018
Updated: 2 hours ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Miniflux

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Miniflux, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

services:
  miniflux-db:
    image: postgres:15
    container_name: Miniflux-DB
    hostname: miniflux-db
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "pg_isready", "-U", "miniflux"]
      timeout: 45s
      interval: 10s
      retries: 10
      start_period: 30s
    user: 1026:100
    volumes:
      - /portainer/Files/AppData/Config/minifluxdb:/var/lib/postgresql/data
    environment:
      - POSTGRES_DB=miniflux
      - POSTGRES_USER=minifluxuser
      - POSTGRES_PASSWORD=minifluxpass
    restart: always

  miniflux:
    image: miniflux/miniflux:latest
    container_name: Miniflux
    hostname: miniflux
    security_opt:
      - no-new-privileges:true
    healthcheck:
      test: ["CMD", "/usr/bin/miniflux", "-healthcheck", "auto"]
    user: 1026:100
    ports:
      - 8645:8080
    environment:
      - DATABASE_URL=postgres://minifluxuser:minifluxpass@miniflux-db/miniflux?sslmode=disable
      - RUN_MIGRATIONS=1
      - CREATE_ADMIN=1
      - ADMIN_USERNAME=admin
      - ADMIN_PASSWORD=adminpass
    restart: always
    depends_on:
      miniflux-db:
        condition: service_healthy

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/miniflux.yml up -d

More install options in our documentation.

Container Documentation

miniflux-db Documentation

The PostgreSQL object-relational database system provides reliability and data integrity.

miniflux Documentation

Official Miniflux Image

Serve Miniflux on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying miniflux.example.com to http://miniflux:8080

Add this to your Caddyfile

miniflux.example.com {
	reverse_proxy http://miniflux:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:8645 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :8645
  • Stop the other service, or pick a different host port. In 8645:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:8645. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, miniflux can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 8645

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/minifluxdb

Image won't pull

Test the pull directly on the host: docker pull postgres:15

  • "manifest unknown" means the tag no longer exists.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The always restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Miniflux is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • miniflux-db runs postgres:15
  • miniflux runs miniflux/miniflux:latest, starts after miniflux-db

Ports

A port is the door the app answers on. A mapping like 8645:8080 means it's reachable on port 8645 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:8645 in a browser. It opens:

  • 8645:8080, likely the web interface

Volumes

A volume is where Miniflux keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /var/lib/postgresql/data from /portainer/Files/AppData/Config/minifluxdb on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Miniflux takes 8 of them, all with defaults you can leave alone or tweak:

  • POSTGRES_DB, defaults to miniflux
  • POSTGRES_USER, defaults to minifluxuser
  • POSTGRES_PASSWORD, defaults to minifluxpass
  • DATABASE_URL, defaults to postgres://minifluxuser:minifluxpass@miniflux-db/miniflux?sslmode=disable
  • RUN_MIGRATIONS, defaults to 1
  • CREATE_ADMIN, defaults to 1
  • ADMIN_USERNAME, defaults to admin
  • ADMIN_PASSWORD, defaults to adminpass

Restart policy

The restart policy here is always, so Docker brings Miniflux back up after a crash and again when the server reboots. Good for anything you want running around the clock. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like miniflux-db) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Miniflux up. Add the template list to Portainer once, then deploying Miniflux is a click rather than a wall of config.