This FreshRSS extension uses the Fivefilters Readability.php library to extract the full text of an article. Most importantly, it does not require any docker containers or external services to work.
- Extracts full article content using Readability.php library by Fivefilters
- Works entirely client-side (no external services required)
- Preserves original formatting when possible
- PHP 8.1+
- ext-dom
- ext-xml
- ext-curl
- ext-mbstring
(verify by php -m
and php -v
in the webserver's terminal or check the phpinfo output)
-
Download the extension:
- Clone this repository or download the ZIP file and extract it
- The extension folder should be named
af_readability
-
Copy to FreshRSS extensions folder:
- Place the
af_readability
folder in your FreshRSSextensions
directory - Typical paths:
- Docker:
/usr/share/freshrss/extensions/
- Manual install:
/path/to/FreshRSS/extensions/
- Docker:
- Place the
-
Set proper permissions:
- Ensure the web server has read access to the extension files
- Example:
chown -R www-data:www-data /path/to/extensions/af_readability
- Log in to your FreshRSS instance as an administrator
- Navigate to the "System configuration" section in the admin panel
- Click on the "Extensions" tab
- Find "Af_Readability" in the list of available extensions
- Click the toggle switch to enable the extension
- Click "Save" to apply changes
- After activation, go back to the "Extensions" tab in System configuration
- Find "Af_Readability" in the list of active extensions
- Click the gear/settings icon next to the extension name
- Activate the checkbox for the feeds for which you want the plugin to fetch full article contents
- Click "Save" to apply your settings
- The extension processes NEW articles when they are first fetched
- Existing articles won't be automatically reprocessed
To reprocess existing articles:
- Go to "Manage" → "Archiving" → "Delete all articles" (consider this step carefully)
- Refresh your feeds to fetch articles again
- "Clear cache" won't reprocess existing articles
Some web servers temporarily block too many subsequent HTTP requests from the same IP address. In the case of af_readability, the plugin tries to fetch multiple URLs from all new feed items one after the other without delay. This is often the reason why some article contents are not displayed properly.
- If articles aren't showing full text:
- Ensure the extension is properly activated
- Try deleting and refetching articles as described above
- Check FreshRSS protocol for error messages related to the plugin
- ttrss-af_readability for Tiny Tiny RSS by Andrew Dolgov
- xExtension-Readable for FreshRSS by printfuck
Official FreshRSS documentation on writing extensions.