Files
tt-rss.github.io/docs/Plugins.md
T
2025-11-10 04:18:03 +00:00

4.5 KiB

layout, title, parent
layout title parent
default Plugins Features

Table of contents

{: .no_toc .text-delta }

  • TOC {:toc}

About plugins

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 global configuration directive PLUGINS which is a comma-separated list of enabled system plugins, e.g.

putenv('TTRSS_PLUGINS=auth_internal, other_plugin');

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 Making-Plugins, https://github.com/topics/tt-rss-plugin, https://github.com/topics/ttrss-plugins, etc.

Installing plugins

{: .note }

First party plugins can be added via built-in plugin installer in Preferences → 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.

First party plugins (maintained as part of the project but not bundled with tt-rss)

https://github.com/orgs/tt-rss/repositories?q=tt-rss-plugin+sort%3Aname-asc

Third party plugins

{: .warning }

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

{: .note }

Third-party plugins may be unmaintained and incompatible with newer tt-rss code. Please report plugin-related problems to their developers.

{: .note }

This list is old (related issue). Consider discovering plugins via alternate methods (e.g. https://github.com/topics/tt-rss-plugin, https://github.com/topics/ttrss-plugins, etc.).

Sharing plugins

{: .no_toc }

A Tiny Tiny RSS plugin to post to a Wallabag v2 instance

{: .no_toc }

https://github.com/joshp23/ttrss-to-wallabag-v2

A plugin for Tiny Tiny RSS, to shorten urls via Yourls

{: .no_toc }

https://github.com/joshp23/tt-rss-yourls

{: .no_toc }

https://github.com/joshp23/tt-rss-shaarli

{: .no_toc }

https://github.com/joshp23/ttrss-to-Sci-Hub

Feed data manipulation plugins

{: .no_toc }

Enable embedded videos in feeds - videoframes

{: .no_toc }

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

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

{: .no_toc }

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

A simple plugin to assist in the display of images from NASA's Astronomy Picture of the Day feed in tt-rss

{: .no_toc }

https://github.com/joshp23/TTRSS-APOD-Fix

Webcomics plugins

{: .no_toc }

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

{: .no_toc }

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

Lint/tidy plugin to repair invalid feeds

{: .no_toc }

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

Embed content from Tapastic rss streams

{: .no_toc }

https://github.com/ldidry/af_tapastic

API plugins

{: .no_toc }

FreshRSS / Google Reader API Support

{: .no_toc }

Use any RSS app or client that supports FreshRSS or the Google Reader API.

https://github.com/eric-pierce/freshapi

Fever API emulator

{: .no_toc }

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

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

Other plugins

{: .no_toc }

Generate QR codes from article links, with xhr support and no disk cache

{: .no_toc }

https://github.com/GregThib/ttrss-qrcodegen

Send XMPP notifications via Prosody mod_post_msg

{: .no_toc }

https://github.com/joshp23/ttrss-notify-xmpp-prosody

Plugins for alternative navigation and night mode

{: .no_toc }

Set of plugins to (1) use cursor keys for a tree-style article navigation; (2) change to a minimal set of hotkeys; (3) toggle night mode for custom themes; (4) change the sort order of unread articles to Oldest first.

https://github.com/ltGuillaume/FeedMei/tree/master/plugins.local/