MensBeam
/
Arsse
3
1
Fork 0
Code Issues 24 Pull Requests Releases 28 Activity
The clean & modern RSS server that doesn't give you any crap. https://thearsse.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1064 Commits
10 Branches
28 Tags
52 MiB
 
Tree: 14d2d19ae1
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '14d2d19ae1'
${ noResults }
Arsse/docs/en/030_Supported_Protocols/005_Miniflux.md

3.3 KiB
Raw Blame History

[TOC]

About

Supported since
0.9.0
Base URL
/
API endpoint
/v1/
Specifications
API Reference, Filtering Rules

The Miniflux protocol is a fairly well-designed protocol supporting a wide variety of operations on newsfeeds, folders (termed "categories"), and articles; it also allows for user administration, and native OPML importing and exporting. Architecturally it is similar to the Nextcloud News protocol, but is generally more efficient and has more capabilities.

Miniflux version 2.0.27 is emulated, though not all features are implemented

Missing features

  • JSON Feed format is not suported
  • Various feed-related features are not supported; attempting to use them has no effect
    • Rewrite rules and scraper rules
    • Custom User-Agent strings
    • The disabled, ignore_http_cache, and fetch_via_proxy flags
    • Changing the URL, username, or password of a feed

Differences

  • Various error messages differ due to significant implementation differences
  • PUT requests which return a body respond with 200 OK rather than 201 Created
  • Only the URL should be considered reliable in feed discovery results
  • The "All" category is treated specially (see below for details)
  • Category names consisting only of whitespace are rejected along with the empty string
  • Filtering rules may not function identically (see below for details)
  • The checked_at field of feeds indicates when the feed was last updated rather than when it was last checked

Behaviour of filtering (block and keep) rules

The Miniflux documentation gives only a brief example of a pattern for its filtering rules; the allowed syntax is described in full in Google's documentation for RE2. Being a PHP application, The Arsse instead accepts PCRE syntax (or since PHP 7.3 PCRE2 syntax), specifically in UTF-8 mode. Delimiters should not be included, and slashes should not be escaped; anchors may be used if desired. For example ^(?i)RE/MAX$ is a valid pattern.

For convenience the patterns are tested after collapsing whitespace. Unlike Miniflux, The Arsse tests the patterns against an article's author-supplied categories if they do not match its title. Also unlike Miniflux, when filter rules are modified they are re-evaluated against all applicable articles immediately.

Special handling of the "All" category

Nextcloud News' root folder and Tiny Tiny RSS' "Uncategorized" catgory are mapped to Miniflux's initial "All" category. This Miniflux category can be renamed, but it cannot be deleted. Attempting to do so will delete the child feeds it contains, but not the category itself.

Interaction with nested categories

Tiny Tiny RSS is unique in allowing newsfeeds to be grouped into categories nested to arbitrary depth. When newsfeeds are placed into nested categories, they simply appear in the top-level category when accessed via the Miniflux protocol. This does not affect OPML exports, where full nesting is preserved.