mirror of
https://code.mensbeam.com/MensBeam/Arsse.git
synced 2024-12-22 13:12:41 +00:00
Initial Miniflux documentation
This commit is contained in:
J. King
parent
e861cca53d
commit
4d532cba3f
6 changed files with 121 additions and 10 deletions
|
|
@ -1,5 +1,6 @@
|
|||
The Advanced RSS Environment (affectionately called "The Arsse") is a news aggregator server which implements multiple synchronization protocols. Unlike most other aggregator servers, The Arsse does not include a Web front-end (though one is planned as a separate project), and it relies on [existing protocols](Supported_Protocols) to maximize compatibility with [existing clients](Compatible_Clients). Supported protocols are:
|
||||
|
||||
- Miniflux
|
||||
- Nextcloud News
|
||||
- Tiny Tiny RSS
|
||||
- Fever
|
||||
|
|
|
|||
26
docs/en/030_Supported_Protocols/005_Miniflux.md
Normal file
26
docs/en/030_Supported_Protocols/005_Miniflux.md
Normal file
|
|
@ -0,0 +1,26 @@
|
|||
[TOC]
|
||||
|
||||
# About
|
||||
|
||||
<dl>
|
||||
<dt>Supported since</dt>
|
||||
<dd>0.9.0</dd>
|
||||
<dt>Base URL</dt>
|
||||
<dd>/</dd>
|
||||
<dt>API endpoint</dt>
|
||||
<dd>/v1/</dd>
|
||||
<dt>Specifications</dt>
|
||||
<dd><a href="https://miniflux.app/docs/api.html">API Reference</a></dd>
|
||||
</dl>
|
||||
|
||||
The Miniflux protocol is a 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.
|
||||
|
||||
# Differences
|
||||
|
||||
TBD
|
||||
|
||||
# Interaction with nested folders
|
||||
|
||||
Tiny Tiny RSS is unique in allowing newsfeeds to be grouped into folders nested to arbitrary depth. When newsfeeds are placed into nested folders, they simply appear in the top-level folder when accessed via the Miniflux protocol. This does not affect OPML exports, where full nesting is preserved.
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
The Arsse was designed from the start as a server for multiple synchronization protocols which clients can make use of. Currently the following protocols are supported:
|
||||
|
||||
- [Miniflux](Miniflux)
|
||||
- [Nextcloud News](Nextcloud_News)
|
||||
- [Tiny Tiny RSS](Tiny_Tiny_RSS)
|
||||
- [Fever](Fever)
|
||||
|
|
|
|||
|
|
@ -5,10 +5,11 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<tr>
|
||||
<th rowspan="2">Name</th>
|
||||
<th rowspan="2">OS</th>
|
||||
<th colspan="3">Protocol</th>
|
||||
<th colspan="4">Protocol</th>
|
||||
<th rowspan="2">Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Miniflux</th>
|
||||
<th>Nextcloud News</th>
|
||||
<th>Tiny Tiny RSS</th>
|
||||
<th>Fever</th>
|
||||
|
|
@ -16,16 +17,33 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
</thead>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th colspan="6">Desktop</th>
|
||||
<th colspan="7">Web</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://github.com/reminiflux/reminiflux">reminiflux</a></td>
|
||||
<td></td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
<p>Three-pane alternative front-end for Minflux.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th colspan="7">Desktop</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://jangernert.github.io/FeedReader/">FeedReader</a></td>
|
||||
<td>Linux</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
<p>Excellent reader; one of the best on any platform.</p>
|
||||
<p>Excellent reader; discontinued in favour of NewsFlash.</p>
|
||||
<p>Not compatible with HTTP authentication when using TT-RSS.</p>
|
||||
</td>
|
||||
</tr>
|
||||
|
|
@ -33,6 +51,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="https://lzone.de/liferea/">Liferea</a></td>
|
||||
<td>Linux</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
|
|
@ -44,6 +63,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td>Linux, macOS</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
<p>Terminal-based client.</p>
|
||||
|
|
@ -52,11 +72,12 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<tr>
|
||||
<td><a href="https://gitlab.com/news-flash/news_flash_gtk">NewsFlash</a></td>
|
||||
<td>Linux</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
<p>Successor to FeedReader.</p>
|
||||
<p>Successor to FeedReader. One of the best on any platform</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
|
|
@ -64,6 +85,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td>macOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
<p>Also available for iOS.</p>
|
||||
|
|
@ -72,11 +94,12 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<tr>
|
||||
<td><a href="https://github.com/martinrotter/rssguard/">RSS Guard</a></td>
|
||||
<td>Windows, macOS, Linux</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
<p>Very basic client; now discontinued.</p>
|
||||
<p>Very basic client.</p>
|
||||
</td>
|
||||
</tr>
|
||||
</tr>
|
||||
|
|
@ -84,6 +107,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="https://www.microsoft.com/store/apps/9wzdncrdmbn3">Tiny Tiny RSS Reader</td>
|
||||
<td>Windows</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
|
|
@ -93,11 +117,12 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
</tbody>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th colspan="6">Mobile</th>
|
||||
<th colspan="7">Mobile</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://peterandlinda.com/cloudnews/">CloudNews</a></td>
|
||||
<td>iOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
|
|
@ -109,6 +134,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="https://play.google.com/store/apps/details?id=com.seazon.feedme">FeedMe</a></td>
|
||||
<td>Android</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
|
|
@ -119,6 +145,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="http://cocoacake.net/apps/fiery/">Fiery Feeds</a></td>
|
||||
<td>iOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
|
|
@ -126,9 +153,28 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<p>Currently keeps showing items in the unread badge which have already been read.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://play.google.com/store/apps/details?id=com.constantin.microflux">Microflux for Miniflux</a></td>
|
||||
<td>Android</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://github.com/DocMarty84/miniflutt">Miniflutt</a></td>
|
||||
<td>Android</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td></td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://github.com/SimonSchubert/NewsOut">Newsout</a></td>
|
||||
<td>Android, iOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
|
|
@ -139,6 +185,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<tr>
|
||||
<td><a href="https://github.com/nextcloud/news-android/">Nextcloud News</a></td>
|
||||
<td>Android</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
|
|
@ -149,6 +196,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<tr>
|
||||
<td><a href="https://github.com/schaal/ocreader/">OCReader</a></td>
|
||||
<td>Android</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
|
|
@ -159,16 +207,29 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td>Android</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
<p>Fetches favicons independently.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://github.com/ali322/reed">Reed</a></td>
|
||||
<td>Android</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
<p>Binaries only available from GitHub.</p>
|
||||
</td>
|
||||
</tr>
|
||||
<tr>
|
||||
<td><a href="https://reeder.app/">Reeder</a></td>
|
||||
<td>iOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
<p>Also available for macOS.</p>
|
||||
|
|
@ -178,6 +239,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="http://tt-rss.org/">Tiny Tiny RSS</a></td>
|
||||
<td>Android</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
|
|
@ -188,6 +250,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="http://github.com/nilsbraden/ttrss-reader-fork/">TTRSS-Reader</a></td>
|
||||
<td>Android</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
|
|
@ -199,6 +262,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td>iOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
<p>Trialware with one-time purchase.</p>
|
||||
|
|
@ -214,10 +278,11 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<tr>
|
||||
<th rowspan="2">Name</th>
|
||||
<th rowspan="2">OS</th>
|
||||
<th colspan="3">Protocol</th>
|
||||
<th colspan="4">Protocol</th>
|
||||
<th rowspan="2">Notes</th>
|
||||
</tr>
|
||||
<tr>
|
||||
<th>Miniflux</th>
|
||||
<th>Nextcloud News</th>
|
||||
<th>Tiny Tiny RSS</th>
|
||||
<th>Fever</th>
|
||||
|
|
@ -228,15 +293,30 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="https://github.com/jeena/feedthemonkey">FeedTheMonkey</a></td>
|
||||
<td>Linux</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
<p></p>
|
||||
</td>
|
||||
</tr>
|
||||
<!--
|
||||
<tr>
|
||||
<td><a href="https://github.com/fabienheureux/liseur">Liseur</a></td>
|
||||
<td>Windows?</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
<p>Level of functionality unclear.</p>
|
||||
</td>
|
||||
</tr>
|
||||
-->
|
||||
<tr>
|
||||
<td><a href="https://open-store.io/app/newsie.martinferretti">Newsie</a></td>
|
||||
<td>Ubuntu Touch</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
|
|
@ -249,6 +329,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td>macOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
<p>Requires purchase. Presumed to work.</p>
|
||||
|
|
@ -259,6 +340,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td>Windows</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td>
|
||||
<p>Requires manual configuration.</p>
|
||||
|
|
@ -268,6 +350,7 @@ The Arsse does not at this time have any first party clients. However, because T
|
|||
<td><a href="http://www.pluchon.com/en/tiny_reader_rss.php">tiny Reader RSS</a></td>
|
||||
<td>iOS</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="N">✘</td>
|
||||
<td class="Y">✔</td>
|
||||
<td class="N">✘</td>
|
||||
<td>
|
||||
|
|
|
|||
2
docs/theme/arsse/arsse.css
vendored
2
docs/theme/arsse/arsse.css
vendored
File diff suppressed because one or more lines are too long
4
docs/theme/src/arsse.scss
vendored
4
docs/theme/src/arsse.scss
vendored
|
|
@ -245,12 +245,12 @@ ul.TableOfContents {
|
|||
}
|
||||
|
||||
thead tr + tr th {
|
||||
width: 16.66%;
|
||||
width: 12%;
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
tbody td {
|
||||
&:nth-child(3), &:nth-child(4), &:nth-child(5) {
|
||||
&:nth-child(3), &:nth-child(4), &:nth-child(5), &:nth-child(6) {
|
||||
text-align: center;
|
||||
}
|
||||
|
||||
|
|
|
|||
Loading…
Reference in a new issue