summaryrefslogtreecommitdiff
path: root/Plugins.md
blob: 92207b0006f9bb28cdde69e5ab24309ab57c613f (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
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
# 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 &rarr; 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``` and then activate it in the settings panel. Note that 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``.

## Third party plugins master list

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.

Some additional plugins which are not bundled with tt-rss are available on [Gogs](https://git.tt-rss.org/fox).
Third party themes and plugins are also available on the [Themes & Plugins subforum](https://discourse.tt-rss.org/c/tiny-tiny-rss/themes-and-plugins).

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

## Social plugins

### Share to Evernote, Kindle and Pinboard

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

### Share to Facebook

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

### Share to Flattr

https://github.com/nhoening/ttrss-flattr

### Share to Instapaper, Facebook

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

### Share to Hootsuite

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

### Share to Tumblr

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

### Share to SemanticScuttle

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

### Share to Readability

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

### Send to Kindle with one click

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

## Keyboard shortcut plugins

### Example plugin to base other shortcut plugins on

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

## Feed data manipulation plugins

### Enable embedded videos in feeds~~ videoframes

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

### Configurable plugin to replace an article stub by content from the linked URL’s page

https://github.com/mbirth/ttrss\_plugin-af\_feedmod

### Comic plugin Ctrl+Alt+Del & Superosity

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

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

### Enlarge images in Flickr feeds

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

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

### getCompactHeadlines

Requested by the author of News+ (former GReader) Android app to allow
two way synchronization.

http://tt-rss.org/oldforum/viewtopic.php?f=22&t=2465&p=13986\#p13984

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

### Instapaper clean view plugin

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

### Plugin for Yourls

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

### Favicon badge plugin

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

### Open in background tab (Chrome/Opera only)

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

### Next-Prev Toolbar

Toolbar for easy access to feed functions

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

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

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