8000 GitHub - pengchangg/miniflux-v2 at homelab · GitHub
[go: up one dir, main page]

Skip to content
forked from miniflux/v2

About

Minimalist and opinionated feed reader

Resources

Contributing

Security policy

Stars

1 star

Watchers

0 watching

Forks

 
 

Repository files navigation

Miniflux 2

Miniflux is a minimalist and opinionated feed reader. It's simple, fast, lightweight and super easy to install.

Official website: https://miniflux.app

Fork Additions

This is a personal fork of miniflux/v2 (branch homelab, based on upstream fb043227 / release 2.3.5). It keeps upstream behavior and adds the following podcast/video playback features.

The additions below are meant for personal use and are not intended to be submitted upstream: they are largely AI-generated, opinionated about playback, and would be a maintenance burden for upstream maintainers. Upstream main is still merged into this fork regularly, so the code stays close to the latest release.

Per-Episode Playback Lock

  • An episode can be played on only one device at a time: the first player to start claims it, and the claim is renewed every 10 seconds with the progress save (30-second TTL).
  • Starting the same episode elsewhere does not steal the session: the new device gets a banner and must take over explicitly, and progress writes from a device without the lock are refused.
  • The player polls the session state, so pausing on the device that holds the lock pauses the same episode everywhere.
  • The sessions page has a "Pause playback on all devices" button as a last resort.

Playback Across Page Navigation

  • Playing audio moves into a mini player pinned to the bottom of the page with the episode title and a close button, so it survives page changes.
  • Internal GET links (menus, entry list, next/previous, keyboard shortcuts, browser back and forward) are handled with a soft navigation that swaps only the page content instead of reloading the whole document.
  • The entry page keeps a placeholder where the player was; closing the mini player puts the player back in that spot and pauses it.
  • Form submissions, external links, downloads and full page loads still reload the page and stop playback.

Features

Feed Reader

  • Supported feed formats: Atom 0.3/1.0, RSS 1.0/2.0, and JSON Feed 1.0/1.1.
  • OPML file import/export and URL import.
  • Supports multiple attachments (podcasts, videos, music, and images enclosures).
  • Plays videos from YouTube directly inside Miniflux.
  • Organizes articles using categories and bookmarks.
  • Share individual articles publicly.
  • Fetches website icons (favicons).
  • Saves articles to third-party services.
  • Provides full-text search (powered by Postgres).
  • Available in 20 languages: Portuguese (Brazilian), Chinese (Simplified and Traditional), Dutch, English (US), Finnish, French, German, Greek, Hindi, Indonesian, Italian, Japanese, Polish, Romanian, Russian, Taiwanese POJ, Ukrainian, Spanish, and Turkish.

Privacy and Security

  • Removes pixel trackers.
  • Strips tracking parameters from URLs (e.g., utm_source, utm_medium, utm_campaign, fbclid, etc.).
  • Retrieves original links when feeds are sourced from FeedBurner.
  • Opens external links with attributes rel="noopener noreferrer" referrerpolicy="no-referrer" for improved security.
  • Implements the HTTP header Referrer-Policy: no-referrer to prevent referrer leakage.
  • Provides a media proxy to avoid tracking and resolve mixed content warnings when using HTTPS.
  • Plays YouTube videos via the privacy-focused domain youtube-nocookie.com.
  • Supports alternative YouTube video players such as Invidious.
  • Blocks external JavaScript to prevent tracking and enhance security.
  • Sanitizes external content before rendering it.
  • Enforces a Content Security and a Trusted Types Policy to only application JavaScript and blocks inline scripts and styles.

Bot Protection Bypass Mechanisms

  • Optionally disable HTTP/2 to mitigate fingerprinting.
  • Allows configuration of a custom user agent.
  • Supports adding custom cookies for specific use cases.
  • Enables the use of proxies for enhanced privacy or bypassing restrictions.

Content Manipulation

  • Fetches the original article and extracts only the relevant content using a local Readability parser.
  • Allows custom scraper rules based on CSS selectors.
  • Supports custom rewriting rules for content manipulation.
  • Provides a regex filter to include or exclude articles based on specific patterns.
  • Optionally permits self-signed or invalid certificates (disabled by default).
  • Scrapes YouTube's website to retrieve video duration as read time or uses the YouTube API (disabled by default).

User Interface

< 942A ul dir="auto">
  • Optimized stylesheet for readability.
  • Responsive design that adapts seamlessly to desktop, tablet, and mobile devices.
  • Minimalistic and distraction-free user interface.
  • No requirement to download an app from Apple App Store or Google Play Store.
  • Can be added directly to the home screen for quick access.
  • Supports a wide range of keyboard shortcuts for efficient navigation.
  • Optional touch gesture support for navigation on mobile devices.
  • Custom stylesheets and JavaScript to personalize the user interface to your preferences.
  • Themes:
    • Light (Sans-Serif)
    • Light (Serif)
    • Dark (Sans-Serif)
    • Dark (Serif)
    • System (Sans-Serif) – Automatically switches between Dark and Light themes based on system preferences.
    • System (Serif)
  • Integrations

    Authentication

    • Local username and password.
    • Passkeys (WebAuthn).
    • Google (OAuth2).
    • Generic OpenID Connect.
    • Reverse-Proxy authentication.

    Technical Stuff

    • Written in Go (Golang).
    • Single binary compiled statically without dependency.
    • Works only with PostgreSQL.
    • Does not use any ORM or any complicated frameworks.
    • Uses modern vanilla JavaScript only when necessary.
    • All static files are bundled into the application binary using the Go embed package.
    • Supports the Systemd sd_notify protocol for process monitoring.
    • Configures HTTPS automatically with Let's Encrypt.
    • Allows the use of custom SSL certificates.
    • Supports HTTP/2 when TLS is enabled.
    • Updates feeds in the background using an internal scheduler or a traditional cron job.
    • Uses native lazy loading for images and iframes.
    • Compatible only with modern browsers.
    • Adheres to the Twelve-Factor App methodology.
    • Provides official Debian/RPM packages and pre-built binaries.
    • Publishes a Docker image to Docker Hub, GitHub Registry, and Quay.io Registry, with ARM and RISC-V architecture support.
    • Uses a limited amount of third-party go dependencies
    • Has a comprehensive testsuite, with both unit tests and integration tests.
    • Only uses a couple of MB of memory and a negligible amount of CPU, even with several hundreds of feeds.
    • Respects/sends Last-Modified, If-Modified-Since, If-None-Match, Cache-Control, Expires and ETags headers, and has a default polling interval of 1h.

    Documentation

    The Miniflux documentation is available here: https://miniflux.app/docs/ (Man page)

    Screenshots

    Default theme:

    Default theme

    Dark theme when using keyboard navigation:

    Dark theme

    Credits

    About

    Minimalist and opinionated feed reader

    Resources

    Contributing

    Security policy

    Stars

    1 star

    Watchers

    0 watching

    Forks

    Releases

    Packages

    Contributors

    Languages

    0