> ## Documentation Index
> Fetch the complete documentation index at: https://www.towbar.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Miniflux

> Miniflux is a minimal feed reader for following articles from websites you choose.

export const UseCaseNavigation = () => {
  useLayoutEffect(() => {
    const storageKey = "towbar-use-case-open-groups";
    const groupSelector = "#sidebar li[data-title] > button[aria-expanded]";
    let restoring = false;
    let frame = 0;
    function storedGroups() {
      try {
        return new Set(JSON.parse(sessionStorage.getItem(storageKey) || "[]"));
      } catch {
        return new Set();
      }
    }
    function save(groups) {
      try {
        sessionStorage.setItem(storageKey, JSON.stringify([...groups]));
      } catch {}
    }
    function groupName(button) {
      return button.parentElement?.dataset.title;
    }
    function rememberOpenGroups() {
      const groups = new Set();
      for (const button of document.querySelectorAll(groupSelector)) {
        if (button.getAttribute("aria-expanded") === "true") {
          const name = groupName(button);
          if (name) groups.add(name);
        }
      }
      save(groups);
    }
    function restoreOpenGroups() {
      frame = 0;
      const groups = storedGroups();
      if (!groups.size) return;
      restoring = true;
      for (const button of document.querySelectorAll(groupSelector)) {
        if (groups.has(groupName(button)) && button.getAttribute("aria-expanded") === "false") {
          button.click();
        }
      }
      restoring = false;
    }
    function scheduleRestore() {
      if (!frame) frame = requestAnimationFrame(restoreOpenGroups);
    }
    function onClick(event) {
      if (restoring || !(event.target instanceof Element)) return;
      const button = event.target.closest(groupSelector);
      if (button) {
        const name = groupName(button);
        if (!name) return;
        const groups = storedGroups();
        if (button.getAttribute("aria-expanded") === "true") groups.delete(name); else groups.add(name);
        save(groups);
        return;
      }
      if (event.target.closest('a[href^="/docs/use-cases/"]')) {
        rememberOpenGroups();
      }
    }
    const observer = new MutationObserver(scheduleRestore);
    document.addEventListener("click", onClick, true);
    observer.observe(document.getElementById("sidebar") || document.body, {
      childList: true,
      subtree: true
    });
    scheduleRestore();
    return () => {
      document.removeEventListener("click", onClick, true);
      observer.disconnect();
      cancelAnimationFrame(frame);
    };
  }, []);
  return null;
};

<UseCaseNavigation />

<img className="towbar-doc-brand-logo" src="https://mintcdn.com/avgeek/EGkEWLTQnOwecqNx/assets/use-case-logos/miniflux.png?fit=max&auto=format&n=EGkEWLTQnOwecqNx&q=85&s=dccf84878234ad893256628b2cb9cae2" alt="Miniflux logo" aria-hidden="true" width="128" height="128" data-path="assets/use-case-logos/miniflux.png" />

**Upstream source:** [Current installation guide](https://miniflux.app/docs/docker.html).

Miniflux requires PostgreSQL for feeds, accounts, and read state. `RUN_MIGRATIONS=1` initializes schema; the first-run administrator values should be removed after creation.

## Towbar manifests

<CodeGroup>
  ```yaml title=".towbar/datastores/miniflux-postgres.datastore.yml" theme={"system"}
  id: miniflux-postgres
  name: Miniflux PostgreSQL
  type: postgres
  container:
    network: application
    networkAlias: miniflux-postgres
    resources:
      cpus: 1
      memory: 1g
  secrets:
    runtime:
      - POSTGRES_USER
      - POSTGRES_DB
      - POSTGRES_PASSWORD
  environments:
    production:
      server: 192.0.2.10
  ```

  ```yaml title=".towbar/services/miniflux.service.yml" theme={"system"}
  id: miniflux
  name: Miniflux
  buildServer: null
  deployment:
    type: image
    image: miniflux/miniflux:2.2.12
  container:
    port: 8080
    network: application
  environments:
    production:
      server: 192.0.2.10
  secrets:
    runtime:
      - DATABASE_URL
      - RUN_MIGRATIONS
      - CREATE_ADMIN
      - ADMIN_USERNAME
      - ADMIN_PASSWORD
  domains:
    primary: miniflux.example.com
  tls:
    mode: direct
  ```
</CodeGroup>

## Configure

1. Prepare the example server, connect the repository, and map `production` to the branch containing these manifests. Replace the example server IP and domain. Commit the manifests, then sync the repository and inspect the resolved configuration.
2. Save the initialization values in the table below for the postgres Datastore under **Datastore → Settings → Secrets**. Deploy it first and wait for readiness. These values create the database and user only on an empty volume.
3. Set the Service's declared runtime values under **Service → Settings → Secrets** using the table below. Replace descriptions and placeholders with actual values; do not commit passwords or keys.
4. Deploy the Service, then perform the checks below before enabling auto-deploy.

## Datastore values

Save these in each Datastore's **Settings → Secrets** before deploying it. Use the suggested names or choose your own, then use the same names and passwords in the Service connection values below.

| Datastore         | Key                 | Suggested value                                                                           |
| ----------------- | ------------------- | ----------------------------------------------------------------------------------------- |
| Miniflux postgres | `POSTGRES_DB`       | miniflux                                                                                  |
| Miniflux postgres | `POSTGRES_USER`     | miniflux                                                                                  |
| Miniflux postgres | `POSTGRES_PASSWORD` | Run `openssl rand -hex 32`; save its output and reuse it in the Service connection value. |

## Runtime values

Save these values on the Service after the repository sync. The manifest declares required keys, not their values.

| Key              | Value to save                                                                                                                |
| ---------------- | ---------------------------------------------------------------------------------------------------------------------------- |
| `DATABASE_URL`   | `postgres://miniflux:PASSWORD@miniflux-postgres:5432/miniflux?sslmode=disable` (replace `PASSWORD` with `POSTGRES_PASSWORD`) |
| `RUN_MIGRATIONS` | 1                                                                                                                            |
| `CREATE_ADMIN`   | 1                                                                                                                            |
| `ADMIN_USERNAME` | Choose the initial username.                                                                                                 |
| `ADMIN_PASSWORD` | Generate the initial password.                                                                                               |

## Verify

Add a feed, refresh it, and confirm subscription and read state survive redeployment. After the administrator exists, remove `CREATE_ADMIN`, `ADMIN_USERNAME`, and `ADMIN_PASSWORD` from the manifest and Service secrets, sync, and redeploy; they are first-run values only.

For field constraints, see [Service manifest](/docs/services/manifest) and [Datastore manifest](/docs/datastores/manifest).