{
  "schema_version": 1,
  "generated_at": "2026-10-22T00:00:00.000Z",
  "canonical_url": "https://openlogs.fyi/tools/miniflux",
  "slug": "miniflux",
  "name": "Miniflux",
  "tagline": "Minimalist feed reader written in Go with a web interface.",
  "replaces": {
    "summary": "Paid feed reader services, such as Feedly.",
    "products": [
      {
        "slug": "feedly",
        "name": "Feedly",
        "vendor": "Feedly",
        "url": "https://openlogs.fyi/alternatives/feedly"
      }
    ]
  },
  "stack": [
    {
      "kind": "language",
      "name": "Go"
    },
    {
      "kind": "database",
      "name": "PostgreSQL"
    }
  ],
  "deployment_methods": [
    "docker_compose"
  ],
  "requirements": {
    "min_ram_mb": null,
    "min_cpu_cores": null,
    "source_url": null
  },
  "license": {
    "spdx": "Apache-2.0",
    "class": "osi",
    "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/LICENSE"
  },
  "business_model": {
    "value": "unknown",
    "notes": "The README at the pinned commit does not state a business model, so it stays unknown.",
    "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/README.md",
    "checked_at": "2026-10-22"
  },
  "difficulty": {
    "value": "easy",
    "reason": "2 services (1 database or broker: postgres), 1 volume mount, no env values to set, no elevated host access. Heuristic score 2 of 11: easy."
  },
  "repository": {
    "owner": "miniflux",
    "name": "v2",
    "url": "https://github.com/miniflux/v2"
  },
  "compose_check": {
    "status": "config_ok",
    "validated_at": "2026-10-22",
    "summary": "config_ok on 2026-10-22"
  },
  "recipe": {
    "version": 1,
    "source_path": "contrib/docker-compose/basic.yml",
    "source_repo": "miniflux/v2",
    "source_commit_sha": "8de58f8b6fe11efb5b86024f64276e31b36f4572",
    "source_kind": "app_repo",
    "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml"
  },
  "install_steps": [
    {
      "order": 1,
      "kind": "prerequisite",
      "language": "text",
      "label": "Docker with the Compose plugin",
      "body": "A host with Docker and the Docker Compose plugin. This entry runs from a compose file.",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "validation_status": "unvalidated"
    },
    {
      "order": 2,
      "kind": "compose",
      "language": "yaml",
      "label": "Save the compose file as compose.yaml",
      "body": "services:\n  miniflux:\n    image: ${MINIFLUX_IMAGE:-miniflux/miniflux:latest}\n    container_name: miniflux\n    restart: always\n    ports:\n      - \"80:8080\"\n    depends_on:\n      db:\n        condition: service_healthy\n    environment:\n      - DATABASE_URL=postgres://miniflux:secret@db/miniflux?sslmode=disable\n      - RUN_MIGRATIONS=1\n      - CREATE_ADMIN=1\n      - ADMIN_USERNAME=admin\n      - ADMIN_PASSWORD=test123\n      - DEBUG=1\n    # Optional health check:\n    # healthcheck:\n    #  test: [\"CMD\", \"/usr/bin/miniflux\", \"-healthcheck\", \"auto\"]\n  db:\n    image: postgres:latest\n    container_name: postgres\n    restart: always\n    environment:\n      - POSTGRES_USER=miniflux\n      - POSTGRES_PASSWORD=secret\n      - POSTGRES_DB=miniflux\n    volumes:\n      - miniflux-db:/var/lib/postgresql\n    healthcheck:\n      test: [\"CMD\", \"pg_isready\", \"-U\", \"miniflux\"]\n      interval: 10s\n      start_period: 30s\nvolumes:\n  miniflux-db:\n",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "validation_status": "config_ok"
    },
    {
      "order": 3,
      "kind": "env",
      "language": "text",
      "label": "Set the values the compose file needs",
      "body": "Replace the placeholder values listed under Gotchas.",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "validation_status": "unvalidated"
    },
    {
      "order": 4,
      "kind": "shell",
      "language": "bash",
      "label": "Start it",
      "body": "docker compose up -d",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "validation_status": "unvalidated"
    },
    {
      "order": 5,
      "kind": "verify",
      "language": "text",
      "label": "Open the app",
      "body": "Open http://localhost:80. The compose file publishes host port 80 for the miniflux service.",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "validation_status": "unvalidated"
    }
  ],
  "notes": [
    {
      "kind": "gotcha",
      "title": "Some images use the latest tag or no tag",
      "body": "Images without a pinned version: miniflux: ${MINIFLUX_IMAGE:-miniflux/miniflux:latest}, db: postgres:latest. A later pull can get a different version.",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file has placeholder values",
      "body": "Placeholder values: POSTGRES_PASSWORD is \"secret\" (db).",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "checked_at": "2026-10-22"
    },
    {
      "kind": "gotcha",
      "title": "The compose file publishes host ports",
      "body": "Host ports: 80 (miniflux). A port without a host address listens on all host network interfaces.",
      "source_url": "https://github.com/miniflux/v2/blob/8de58f8b6fe11efb5b86024f64276e31b36f4572/contrib/docker-compose/basic.yml",
      "checked_at": "2026-10-22"
    }
  ],
  "signals": {
    "captured_at": "2026-10-22",
    "stars": 9815,
    "forks": 950,
    "open_issues": 279,
    "last_push": "2026-10-21",
    "days_since_push": 0,
    "latest_release": "2.3.4",
    "latest_release_date": "2026-10-20",
    "days_since_release": 1
  },
  "links": {
    "html": "https://openlogs.fyi/tools/miniflux",
    "markdown": "https://openlogs.fyi/tools/miniflux.md",
    "json": "https://openlogs.fyi/tools/miniflux.json"
  },
  "updated_at": "2026-10-22"
}
