mirror of
https://code.mensbeam.com/MensBeam/Arsse.git
synced 2024-12-22 13:12:41 +00:00
Various documentation tweaks
- Place protocol infoboxes above intro text - Fill out Fever text from README - Fix MySQL version - Add note that Percona Server should work
This commit is contained in:
J. King
parent
7d82725a03
commit
4fd060f001
6 changed files with 33 additions and 18 deletions
|
|
@ -7,7 +7,7 @@ The Arsse has the following requirements:
|
|||
- One of:
|
||||
- [sqlite3](http://php.net/manual/en/book.sqlite3.php) or [pdo_sqlite](http://php.net/manual/en/ref.pdo-sqlite.php) for SQLite databases
|
||||
- [pgsql](http://php.net/manual/en/book.pgsql.php) or [pdo_pgsql](http://php.net/manual/en/ref.pdo-pgsql.php) for PostgreSQL 10 or later databases
|
||||
- [mysqli](http://php.net/manual/en/book.mysqli.php) or [pdo_mysql](http://php.net/manual/en/ref.pdo-mysql.php) for MySQL 8.0.7 or later databases
|
||||
- [mysqli](http://php.net/manual/en/book.mysqli.php) or [pdo_mysql](http://php.net/manual/en/ref.pdo-mysql.php) for MySQL/Percona 8.0.11 or later databases
|
||||
- Privileges either to create and run systemd services, or to run cron jobs
|
||||
|
||||
It is also be possible to run The Arsse on other operating systems (including Windows) and with other Web servers, but the configuration required to do so is not documented here.
|
||||
|
|
|
|||
|
|
@ -6,14 +6,14 @@
|
|||
<dt>dbDriver identifier</dt>
|
||||
<dd>mysql</dd>
|
||||
<dt>Minimum version</dt>
|
||||
<dd>8.0.7</dd>
|
||||
<dd>8.0.11</dd>
|
||||
<dt>Configuration</dt>
|
||||
<dd><a href="/en/Configuring_The_Arsse#page_Database-settings">General</a>, <a href="/en/Configuring_The_Arsse#page_Database-settings-specific-to-MySQL">Specific</a></dd>
|
||||
</dl>
|
||||
|
||||
While MySQL can be used as a database for The Arsse, this is **not recommended** due to MySQL's technical limitations. It is fully functional, but may fail with some newsfeeds where other database systems do not. Additionally, it is particularly important before upgrading from one version of The Arsse to the next to back up your database: a failure in a database upgrade can corrupt your database much more easily than when using other database systems.
|
||||
|
||||
Please note that as of this writing MariaDB cannot be used in place of MySQL as it lacks features of MySQL 8 which The Arsse requires.
|
||||
Please note that as of this writing MariaDB cannot be used in place of MySQL as it lacks features of MySQL 8 which The Arsse requires. The awkwardly-named _Percona Server for MySQL_, on the other hand, should work, though this has not been tested.
|
||||
|
||||
# Set-up
|
||||
|
||||
|
|
|
|||
|
|
@ -2,7 +2,7 @@ The Arsse supports the following database backends:
|
|||
|
||||
- SQLite 3.8.3 and later
|
||||
- PostgreSQL 10 and later
|
||||
- MySQL 8.07 and later
|
||||
- MySQL 8.0.11 and later
|
||||
|
||||
All of the above are supported both via their PDO driver extensions as well as their native PHP extensions. One or the other is selected based on availability in your PHP installation.
|
||||
|
||||
|
|
|
|||
|
|
@ -2,10 +2,6 @@
|
|||
|
||||
# About
|
||||
|
||||
The NextCloud News protocol was the first supported by The Arsse, and has been supported in full since version 0.3.0.
|
||||
|
||||
It allows organizing newsfeeds into single-level folders, and supports a wide range of operations on newsfeeds, folders, and articles.
|
||||
|
||||
<dl>
|
||||
<dt>Supported since</dt>
|
||||
<dd>0.1.0</dd>
|
||||
|
|
@ -17,6 +13,10 @@ It allows organizing newsfeeds into single-level folders, and supports a wide ra
|
|||
<dd><a href="https://github.com/nextcloud/news/blob/master/docs/externalapi/Legacy.md">Version 1.2</a></dd>
|
||||
</dl>
|
||||
|
||||
The NextCloud News protocol was the first supported by The Arsse, and has been supported in full since version 0.3.0.
|
||||
|
||||
It allows organizing newsfeeds into single-level folders, and supports a wide range of operations on newsfeeds, folders, and articles.
|
||||
|
||||
# Differences
|
||||
|
||||
- Article GUID hashes are not hashes like in NCN; they are integers rendered as strings
|
||||
|
|
|
|||
|
|
@ -2,10 +2,6 @@
|
|||
|
||||
# About
|
||||
|
||||
The Arsse supports not only the Tiny Tiny RSS protocol, but also extensions required by the FeedReader client and the more commonly supported `getCompactHeadlines` extension.
|
||||
|
||||
It allows organizing newsfeeds into nested folders, and supports an odd patchwork subset of Tiny Tiny RSS' full capabilities. The FeedReader extensions round out the protocol with significantly more features. Unlike TT-RSS itself, API access is always enabled with The Arsse.
|
||||
|
||||
<dl>
|
||||
<dt>Supported since</dt>
|
||||
<dd>0.2.0</dd>
|
||||
|
|
@ -17,6 +13,10 @@ It allows organizing newsfeeds into nested folders, and supports an odd patchwor
|
|||
<dd><a href="https://git.tt-rss.org/git/tt-rss/wiki/ApiReference">Main</a>, <a href="https://git.tt-rss.org/fox/tt-rss/wiki/SearchSyntax">search syntax</a>, <a href="https://github.com/jangernert/FeedReader/blob/master/data/tt-rss-feedreader-plugin/README.md">FeedReader extensions</a>, <a href="https://github.com/hrk/tt-rss-newsplus-plugin/blob/master/README.md">News+ extension</a></dd>
|
||||
</dl>
|
||||
|
||||
The Arsse supports not only the Tiny Tiny RSS protocol, but also extensions required by the FeedReader client and the more commonly supported `getCompactHeadlines` extension.
|
||||
|
||||
It allows organizing newsfeeds into nested folders, and supports an odd patchwork subset of Tiny Tiny RSS' full capabilities. The FeedReader extensions round out the protocol with significantly more features. Unlike with TT-RSS itself, API access is always enabled with The Arsse.
|
||||
|
||||
# Missing features
|
||||
|
||||
The Arsse does not currently support the entire protocol. Notably missing features include manipulation of the special "Published" newsfeed, as well as searching. The full list of missing features is as follows:
|
||||
|
|
|
|||
|
|
@ -2,10 +2,6 @@
|
|||
|
||||
# About
|
||||
|
||||
The Fever protocol is a basic protocol which has historically been popular with iOS and macOS clients.
|
||||
|
||||
It allows marking articles as read or starred, but does not allow adding or modifying newsfeeds. Moreover, instead of being classified into folders, newfeeds may belong to multiple groups, which do not nest.
|
||||
|
||||
<dl>
|
||||
<dt>Supported since</dt>
|
||||
<dd>0.8.0</dd>
|
||||
|
|
@ -17,6 +13,25 @@ It allows marking articles as read or starred, but does not allow adding or modi
|
|||
<dd><a href="https://web.archive.org/web/20161217042229/https://feedafever.com/api">"Public beta"</a> (at the Internet Archive)</dd>
|
||||
</dl>
|
||||
|
||||
# Differences
|
||||
The Fever protocol is a basic protocol which has historically been popular with iOS and macOS clients.
|
||||
|
||||
# Interaction with folders
|
||||
It allows marking articles as read or starred, but does not allow adding or modifying newsfeeds. Moreover, instead of being classified into folders, newfeeds may belong to multiple groups, which do not nest.
|
||||
|
||||
# Missing features
|
||||
|
||||
The Fever protocol is incomplete, unusual, _and_ a product of proprietary software which is no longer available. Conssequently some features have been omitted either out of necessity or because implementation details made the effort required too great.
|
||||
|
||||
- All feeds are considered "Kindling"
|
||||
- The "Hot Links" feature is not implemented; when requested, an empty array will be returned. As there is no way to classify a feed as a "Spark" in the protocol itself and no documentation exists on how link temperature was calculated, an implementation is unlikely to appear in the future
|
||||
- Favicons are not currently supported; all feeds have a simple blank image as their favicon unless the client finds the icons itself
|
||||
|
||||
# Special considerations
|
||||
|
||||
- Because of Fever's unusual and insecure authentication scheme, a Fever-specific password [must be created](/en/Getting_Started/Managing_Users) before a user can communicate via the Fever protocol
|
||||
- The Fever protocol does not allow for adding or modifying feeds. Another protocol or OPML importing must be used to manage feeds
|
||||
- Unlike other protocols supported by The Arsse, Fever uses "groups" (more commonly known as tags or labels) instead of folders to organize feeds. Currently OPML importing is the only means of managing groups
|
||||
|
||||
# Other notes
|
||||
|
||||
- The undocumented `group_ids`, `feed_ids`, and `as=unread` parameters are all supported
|
||||
- XML output is supported, but may not behave as Fever did. Its use by clients is discouraged
|
||||
|
|
|
|||
Loading…
Reference in a new issue