summaryrefslogtreecommitdiff
path: root/Plugins.md
blob: e99eb7fc430302132a699b2341101cd10055aafa (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
% 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 <code>config.php</code> directive <code>PLUGINS</code> which is a comma-separated list of enabled system plugins, i.e.

```php
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](wiki/MakingPlugins) and [samples](https://git.tt-rss.org/git/tt-rss-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

#### Migrates user articles using neutral format

https://git.tt-rss.org/fox/ttrss-data-migration

A few more plugins can be found [here](https://git.tt-rss.org/fox).

## 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](https://discourse.tt-rss.org/c/tiny-tiny-rss/themes-and-plugins).
* Several more (old and unmaintained) plugins are on [the old forums](https://tt-rss.org/oldforum/viewforum.php?f=22) - 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.**

### Sharing plugins

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

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

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

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

#### Adds support for sharing links with Shaarli to tt-rss

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

#### Convert DOI and other links to Sci-Hub links in TT-Rss

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

### 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

#### A simple plugin to assist in the display of images from NASA's Astronomy Picture of the Day feed in TT-RSS

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

### 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

#### Send XMPP notifications via Prosody mod_post_msg

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