diff options
| author | 2022-02-27 21:50:28 +0100 | |
|---|---|---|
| committer | 2022-02-27 21:50:28 +0100 | |
| commit | 639f8eea84ddee767ab115b61091a1c7e3dcdbf8 (patch) | |
| tree | ccaf589a1a435f4f4c95cd04820e76b77bce4096 /docs | |
| parent | c45e5ba85c253ebf05c060ce5ffa9ad2b725410a (diff) | |
Documentation improved: mobile access (#4235)
* Update 06_Mobile_access.md
* Readme: Windows + MacOS
* fix markdown
* Update docs/en/users/06_Mobile_access.md
Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
* Update docs/en/users/06_Mobile_access.md
Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
* MacOS -> macOS
* Update 06_Mobile_access.md
* Update docs/en/users/06_Mobile_access.md
Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/developers/06_GoogleReader_API.md | 4 | ||||
| -rw-r--r-- | docs/en/users/06_Mobile_access.md | 23 | ||||
| -rw-r--r-- | docs/fr/users/06_Mobile_access.md | 2 |
3 files changed, 23 insertions, 6 deletions
diff --git a/docs/en/developers/06_GoogleReader_API.md b/docs/en/developers/06_GoogleReader_API.md index 970ce824f..ebfa6cc7e 100644 --- a/docs/en/developers/06_GoogleReader_API.md +++ b/docs/en/developers/06_GoogleReader_API.md @@ -30,8 +30,8 @@ Then point your mobile application to the `greader.php` address (e.g. `https://f |[FocusReader](https://play.google.com/store/apps/details?id=allen.town.focus.reader) |Android |Closed Source(Free) | |[FeedReader 2.0+](https://jangernert.github.io/FeedReader/) |Linux |[GPLv3](https://github.com/jangernert/FeedReader/blob/master/LICENSE) | |[Newsboat 2.24+](https://newsboat.org/) |Linux |[MIT](https://github.com/newsboat/newsboat/blob/master/LICENSE) | -|[Vienna RSS](http://www.vienna-rss.com/) |MacOS |[Apache-2.0](https://github.com/ViennaRSS/vienna-rss/blob/master/LICENCE.md) | -|[Reeder](https://www.reederapp.com/) |MacOS, iOS |Closed Source | +|[Vienna RSS](http://www.vienna-rss.com/) |macOS |[Apache-2.0](https://github.com/ViennaRSS/vienna-rss/blob/master/LICENCE.md) | +|[Reeder](https://www.reederapp.com/) |macOS, iOS |Closed Source | |[FreshRSS-Notify](https://addons.mozilla.org/firefox/addon/freshrss-notify-webextension/) |Firefox |Open Source | ## Google Reader compatible API diff --git a/docs/en/users/06_Mobile_access.md b/docs/en/users/06_Mobile_access.md index 91271e771..1795cf962 100644 --- a/docs/en/users/06_Mobile_access.md +++ b/docs/en/users/06_Mobile_access.md @@ -1,6 +1,23 @@ This page assumes you have completed the [server setup](../admins/03_Installation.md). -# Enable the API in FreshRSS +# Mobile Access + +You can access FreshRSS on mobile devices via browser and via mobile apps. + + +## Access via Browser + +The FreshRSS user interface is optimized for both small and large screens. The content will fit nicely on small mobile device screens as well. + + +## Access via Mobile App + +FreshRSS supports access from mobile / native apps for Linux, Android, iOS, Windows and macOS, via two distinct APIs: Google Reader API (best), and Fever API (limited features and less efficient). + +A list of known apps is available on the [FreshRSS GitHub page](https://github.com/FreshRSS/FreshRSS#apis--native-apps). + + +### Enable the API in FreshRSS 1. Under the section “Authentication”, enable the option “Allow API access (required for mobile apps)”. 2. Under the section “Profile”, fill-in the field “API password (e.g., for mobile apps)”. @@ -11,7 +28,7 @@ See the [page about the Google Reader compatible API](../developers/06_GoogleRea See the [page about the Fever compatible API](../developers/06_Fever_API.md) for more details. -# Testing +### Testing 1. Under the section “Profile”, click on the link like `https://rss.example.net/api/` next to the field “API password”. 2. Click on first link “Check full server configuration”: @@ -20,7 +37,7 @@ See the [page about the Fever compatible API](../developers/06_Fever_API.md) for * If you get any other error message, proceed to step 5. -# Fix server configuration +### Fix server configuration * Click on the second link “Check partial server configuration (without `%2F` support)”: * If you get `PASS`, then the problem is indeed that your server does not accept slashes `/` that are escaped `%2F`. diff --git a/docs/fr/users/06_Mobile_access.md b/docs/fr/users/06_Mobile_access.md index 8bd0ebd8d..3156a2ace 100644 --- a/docs/fr/users/06_Mobile_access.md +++ b/docs/fr/users/06_Mobile_access.md @@ -62,7 +62,7 @@ possibilité. * Linux * [FeedReader 2.0+](https://jangernert.github.io/FeedReader/) (Libre) * [Newsboat 2.24+](https://newsboat.org/) (Libre) - * MacOS + * macOS * [Vienna RSS](http://www.vienna-rss.com/) (Libre) * [Reeder](https://www.reederapp.com/) (Commercial) * iOS |
