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.
3.5 KiB
3.5 KiB
This page assumes you have completed the server setup.
Enable the API in FreshRSS
- Under the section “Authentication”, enable the option “Allow API access (required for mobile apps)”.
- Under the section “Profile”, fill-in the field “API password (e.g., for mobile apps)”.
- Every user must define an API password.
- The reason for an API-specific password is that it may be used in less safe situations than the main password, and does not grant access to as many things.
Testing
- Under the section “Profile”, click on the link like
https://rss.example.net/api/
next to the field “API password”. - Click on first link “Check full server configuration”:
- If you get PASS then you are done, all is good: you may proceed to step 6.
- If you get Bad Request! or Not Found, then your server probably does not accept slashes
/
that are escaped%2F
. Proceed to step 5. - If you get any other error message, proceed to step 5.
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
.- With Apache, remember the directive
AllowEncodedSlashes On
- Or use a client that does not escape slashes (such as EasyRSS), in which case proceed to step 6.
- With Apache, remember the directive
- If you get Service Unavailable!, then check from step 1 again.
- With Apache:
- If you get FAIL getallheaders!, the combination of your PHP version and your Web server does not provide access to
getallheaders
- Update to PHP 5.4+, or use PHP as module instead of CGI. Otherwise turn on Apache
mod_rewrite
:- Allow
FileInfo
in.htaccess
: see the server setup again. - Enable
mod_rewrite
:- With Debian / Ubuntu:
sudo a2enmod rewrite
- With Debian / Ubuntu:
- Allow
- Update to PHP 5.4+, or use PHP as module instead of CGI. Otherwise turn on Apache
- If you get FAIL getallheaders!, the combination of your PHP version and your Web server does not provide access to
- With nginx:
- If you get Bad Request!, check your server
PATH_INFO
configuration. - If you get File not found!, check your server
fastcgi_split_path_info
.
- If you get Bad Request!, check your server
- If you get FAIL 64-bit or GMP extension!, then your PHP version does not pass the requirement of being 64-bit and/or have PHP GMP extension.
- The easiest is to add the GMP extension. On Debian / Ubuntu:
sudo apt install php-gmp
- The easiest is to add the GMP extension. On Debian / Ubuntu:
- Update and try again from step 3.
- If you get
Compatible clients
-
On the same FreshRSS API page, note the adress given under “Your API address”, like
https://freshrss.example.net/api/greader.php
- You will type it in a client, together with your FreshRSS username, and the corresponding special API password.
-
Pick a client supporting a Google Reader-like API. Selection:
- Android
- News+ with News+ Google Reader extension (Closed source)
- FeedMe 3.5.3+ (Closed source)
- EasyRSS (Open source, F-Droid)
- Linux
- FeedReader 2.0+ (Open source)
- Android