Plugins
fox edited this page 2 weeks ago

Tiny Tiny RSS supports many kinds of plugins: social plugins which share articles to various sites, article filter plugins which mangle feed-provided data on import (for example, inlining images or extracting full article text using Readability), hotkey plugins which alter the way keyboard shortcuts work, etc.

There are two kinds of plugins: user and system. User plugins are enabled in Preferences -> Plugins. System plugins require adding them to a config.php directive PLUGINS which is a comma-separated list of enabled system plugins, i.e.

define('PLUGINS', 'updater, digest, auth_remote, auth_internal');
  • system plugins are always enabled for all users
  • if multiple search plugins are loaded, only the first one is used

If you are interested in making plugins, see MakingPlugins and samples repositories for examples to get you started.

Installing plugins

Copy plugin folder to tt-rss/plugins.local then activate it in the settings panel. Plugin folder name should correspond to plugin class name defined in (plugin)/init.php, i.e. Af_ExamplePlugin should be copied to plugins.local/af_exampleplugin.

Plugins on Gogs

These plugins are maintained on this site but aren't bundled with tt-rss.

Filters duplicate images using perceptual image hashing

https://git.tt-rss.org/fox/ttrss-perceptual-image-hash

SMTP mailer plugin for tt-rss based on PHPMailer

https://git.tt-rss.org/fox/ttrss-mailer-smtp

Sends static files using nginx X-Accel-Redirect header (XSendfile)

https://git.tt-rss.org/fox/ttrss-nginx-xaccel

Shows (approximate) time it takes to read an article, combined mode only

https://git.tt-rss.org/fox/ttrss-time-to-read

A few more plugins can be found here.

Third party plugins

  • Third party plugins may be unmaintained and incompatible with newer tt-rss code (especially those from the old forums). Please report plugin-related problems to their developers.
  • See also: themes & plugins subforum.
  • Several more (old and unmaintained) plugins are on the old forums - if you fix them to run on newer tt-rss versions, please consider adopting and rehosting them.

We’re not responsible for third party plugins. Use at your own risk.

Feed data manipulation plugins

Enable embedded videos in feeds - videoframes

https://github.com/tribut/ttrss-videoframes

Configurable plugin to replace article stub with content from the linked URL's page

https://github.com/feediron/ttrss_plugin-feediron

Webcomics plugins

Comic plugin GU Comics, Married to the sea & Toothpaste for dinner

https://github.com/tribut/ttrss-comics

Full Feed for many newspaper websites

http://tt-rss.org/oldforum/viewtopic.php?f=22&t=1539

Cleanup Google News feed

http://tt-rss.org/oldforum/viewtopic.php?f=22&t=1606

Lint/tidy plugin to repair invalid feeds

https://github.com/Churten/tt-rss-ff-xmllint

Embed content from Tapastic rss streams

https://github.com/ldidry/af_tapastic.git

XML Start tag cleaner

http://tt-rss.org/oldforum/viewtopic.php?f=22&t=2626

Faking of referral for images (anti hotlinking protection).

https://github.com/Alekc/af_refspoof

API plugins

Fever API emulator

Simulates the Fever API for reading the RSS Feeds with your Fever clients.

https://github.com/DigitalDJ/tinytinyrss-fever-plugin

Other plugins

Favicon badge plugin

https://discourse.tt-rss.org/t/favicon-badge-plugin/1441

On-demand generation of QR-Codes for each article (that does not depend on external service).

https://github.com/jonrandoem/ttrss-qrcode