summaryrefslogtreecommitdiff
path: root/Home.md
blob: 3194da6d8014fd26d164e20390883d623b8d2e3b (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
### Tiny Tiny RSS is a free and open source web-based news feed (RSS/Atom) reader and aggregator

<a href='https://tt-rss.org/images/ttrss/18.12/1812-shot5.png'>
    <img src='https://tt-rss.org/images/ttrss/18.12/1812-shot5_small.png'></a>
<a href='https://tt-rss.org/images/ttrss/18.12/1812-shot1.png'>
    <img src='https://tt-rss.org/images/ttrss/18.12/1812-shot1_small.png'></a>    

### Sponsored by

<a href="https://knoji.com">Knoji: Retail Discounts</a>

<a href="https://bluepromocode.com">BluePromoCode.com</a>

## Features

-   Server-side AJAX-powered application, user only needs a web browser.
-   Free software, licensed under [GNU
    GPLv3](http://www.gnu.org/copyleft/gpl.html)
-   Self-hosted: control your own data and protect your privacy instead of relying on [third party services](https://duckduckgo.com/?q=if+it%27s+free+you+are+the+product&t=h_&ia=web)
-   Supports
    -   [feed aggregation / syndication](wiki/GeneratedFeeds),
    -   [keyboard shortcuts](wiki/KeyboardShortcuts),
    -   OPML import/export,
    -   multiple ways to share stuff: via RSS feeds, using plugins to
        various social sites, sharing by URL, etc,
    -   [sharing arbitrary content through tt-rss](wiki/ShareAnything),
    -   internationalization,
    -   [Plugins](wiki/Plugins) and [themes](wiki/Themes),
    -   embedding full article content via readability and site-specific plugins,
    -   detecting and filtering duplicate articles,
    -   podcasts,
    -   [flexible article filtering](wiki/ContentFilters),
    -   [JSON-based API](wiki/ApiReference),
    -   and much more…
-   Official [Android client](https://tt-rss.org/tt-rss-android) ([Apkmonk](https://www.apkmonk.com/app/org.fox.ttrss/)) ([F-Droid repo](https://discourse.tt-rss.org/t/f-droid-repository-for-tt-rss/1321))

## Get in touch

* **[Read the FAQ before asking questions](wiki/FAQ)**
* Join [community forums](https://discourse.tt-rss.org/) or [jabbber group chat](https://discourse.tt-rss.org/t/come-idle-with-us-on-jabber-xmpp/1886) if you have any questions, comments or bug reports.
* Previous (phpbb) forum archive is available <a href="https://tt-rss.org/oldforum/">here</a>.

## Contributing

* If you're interested in contributing code, check [this page](https://git.tt-rss.org/git/tt-rss/src/master/CONTRIBUTING.md). 
* If you want to help translate tt-rss to your language, go [here](https://weblate.tt-rss.org/projects/).

<a href="http://weblate.tt-rss.org/engage/tt-rss/?utm_source=widget">
<img src="http://weblate.tt-rss.org/widgets/tt-rss/-/svg-badge.svg" alt="Translation status" />
</a>

## Requirements

* A modern web browser. As of 2018, this generally means recent Firefox (ESR is fine) or Chrome.
* Dedicated web hosting account (i.e. a VDS or a physical server) running [LAMP](http://en.wikipedia.org/wiki/LAMP_(software_bundle)) stack.

Everything else, including but not limited to, shared hosting accounts, windows and other 
alternative OSes, NAS boxes, PaaS services of any kind, alternative web browsers (or old browser versions), 
is not supported. That is, it may work for you but if you run into problems you are on your own.

Additionally, you will need:

-   PHP version **5.6** or newer ([detailed PHP requirements](wiki/PhpCompatibilityNotes))
-   [PostgreSQL](http://www.postgresql.org) (**9.1** or newer) or
    [MySQL](http://www.mysql.com) - InnoDB is required.

While you can use either database, PostgreSQL should run tt-rss significantly faster and is, in general, 
a much more reliable choice. Also, some minor features are exclusive to PostgreSQL.

**Important:** only InnoDB database engine is supported on MySQL. While you technically can force tt-rss schema under MyISAM you will experience various glitches due to missing functionality (foreign keys, cascade deletes, etc.).

## Download

Tiny Tiny RSS uses a rolling release model based on <a href="https://git.tt-rss.org/git/tt-rss/src/master">git master branch</a> which is considered stable.

**Note:** if you can't check out from main git repository (one common reason is Cloudflare disliking your IP), try using Gitlab mirror [here](https://gitlab.com/gothfox/tt-rss).

There’s no warranty. If it breaks you get to keep both parts.

Please read the [installation guide](wiki/InstallationNotes) and [updating feeds](wiki/UpdatingFeeds) before installing.