summaryrefslogtreecommitdiff
path: root/Home.md
blob: bf638d57461d94febb5d6bd8ae3d6007cbffb24d (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
% Tiny Tiny RSS

#### 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.jpg'></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.jpg'></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,
    -   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://play.google.com/store/apps/details?id=org.fox.ttrss) ([Apkmonk](https://www.apkmonk.com/app/org.fox.ttrss/), **[F-Droid](https://srv.tt-rss.org/fdroid/#org.fox.ttrss)**, [Source](https://git.tt-rss.org/fox/tt-rss-android))

## Demo

See [here](https://srv.tt-rss.org/tt-rss/) (login as ``demo``, ``demo``)

* Runs using [stock docker setup](https://git.tt-rss.org/fox/ttrss-docker-compose).
* Database is automatically restored every two hours.

## Get in touch

* **[Read the FAQ before asking questions](wiki/FAQ)**
* Join [community forums](https://discourse.tt-rss.org/) if you have any questions, comments or bug reports.
* Previous (phpbb) forum archive is available <a href="https://srv.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="https://weblate.tt-rss.org/engage/tt-rss/?utm_source=widget">
<img src="https://weblate.tt-rss.org/widgets/tt-rss/-/svg-badge.svg" alt="Translation status" />
</a>

## Requirements

* A modern web browser. This generally means recent Chrome or compatible. Firefox should also work.
* Dedicated web hosting account (i.e. a VDS or a physical server) running either Docker or [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, **[recommended](wiki/FAQ#what-should-i-use---mysql-or-postgresql)**) or [MySQL](http://www.mysql.com) (InnoDB is **required**).

## Download

Tiny Tiny RSS uses [continuous development](https://discourse.tt-rss.org/t/version-bump-for-ttrss/2655) model based on <a href="https://git.tt-rss.org/git/tt-rss/src/master">git master branch</a> which is considered stable. While new versions get tagged from time to time, please don't think of them in terms of software releases. If possible, you should always be running latest master branch code.

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.