|
2 | 2 |
|
3 | 3 | [](https://app.travis-ci.com/damoeb/rss-proxy)
|
4 | 4 |
|
5 |
| -RSS-proxy 2+ allows you to do create an ATOM or JSON feed of almost static/dynamic websites or feeds (web to feed), |
6 |
| -just by analyzing just the HTML structure. It is an alternative UI to [feedless](https://github.com/damoeb/feedless) with the intent for minimalistic self-hosting with a reduced feature set of feedless. |
7 |
| -If you want feature like fulltext feeds, aggregation, persistence, authentication and others, checkout [feedless](https://github.com/damoeb/feedless/blob/master/docs/third-party-migration.md) |
| 5 | +RSS-proxy allows you to do create an ATOM or JSON feed of any static website or feeds (web to feed), |
| 6 | +just by analyzing just the HTML structure. It is an alternative UI to [feedless](https://github.com/damoeb/feedless) with a reduced feature set. |
| 7 | +If you want advanced features like fulltext feeds, aggregation, persistence, authentication and others, checkout [feedless](https://github.com/damoeb/feedless/blob/master/docs/third-party-migration.md) |
8 | 8 |
|
9 | 9 | 
|
10 | 10 |
|
11 |
| -## Quickstart using docker-compose |
| 11 | +## Features |
| 12 | +- Web to Feed |
| 13 | +- Feed to Feed: pipe existing native feeds through `rss-proxy` to filter them |
| 14 | +- [Filters](https://github.com/damoeb/feedless/blob/master/docs/filters.md) |
| 15 | +- Self Hosting |
12 | 16 |
|
13 |
| -Version 2 comes with more complexity so its easier to run it from [docker-compose](https://docs.docker.com/compose/install/). If you run the proxy behind a reverse proxy, |
14 |
| -make sure you set the request header "X-Real-IP" (see [nginx.con](docs/nginx.conf)) for IP throttling. |
| 17 | +## Advanced Features |
| 18 | +If you look for features below, you have to use [feedless](https://github.com/damoeb/feedless), the successor of `rss-proxy` |
| 19 | +- Feed Aggregation |
| 20 | +- Authentication and multi-tenancy |
| 21 | +- JavaScript Support (prerendering) |
| 22 | +- Fulltext Feeds and other content enrichments |
| 23 | +- Persistence |
| 24 | +- CLI |
| 25 | +- GraphQL API |
| 26 | +- Plugins |
15 | 27 |
|
16 |
| -In `docker-compose.yml` change `APP_PUBLIC_URL` accordingly which is the outfacing public url. |
| 28 | + |
| 29 | +## Quickstart using docker |
| 30 | +If you have [docker](https://docs.docker.com/install/) or [podman](https://podman.io/getting-started/installation) installed, do this |
17 | 31 |
|
18 | 32 | ```
|
19 |
| -wget https://raw.githubusercontent.com/damoeb/rss-proxy/master/chrome.json |
20 |
| -wget https://raw.githubusercontent.com/damoeb/rss-proxy/master/docker-compose.yml |
21 |
| -docker-compose up |
| 33 | +docker pull damoeb/rss-proxy:2 |
| 34 | +docker run -p 3000:3000 -e APP_API_GATEWAY_URL=https://foo.bar -it damoeb/rss-proxy |
22 | 35 | ```
|
23 | 36 |
|
24 |
| -Then open [localhost:8080](http://localhost:8080) in the browser. |
| 37 | +`APP_API_GATEWAY_URL` is your outfacing url, which will be used as host for feeds you create. |
25 | 38 |
|
| 39 | +Then open [localhost:8080](http://localhost:8080) in the browser. |
26 | 40 |
|
27 |
| -## Quickstart Version 1 using docker |
28 | 41 |
|
29 |
| -Since v2 is still beta, this is the quickstart for version 1. If you have [docker](https://docs.docker.com/install/) or [podman](https://podman.io/getting-started/installation) installed, |
30 |
| -Start rss-proxy like this. |
| 42 | +## Legacy Version 1 |
| 43 | +If you are interested in running the first prototype, this is how you do it. |
31 | 44 |
|
32 | 45 | ```
|
33 |
| -docker pull damoeb/rss-proxy |
34 |
| -docker run -p 3000:3000 -it damoeb/rss-proxy |
| 46 | +docker pull damoeb/rss-proxy:1 |
| 47 | +docker run -p 3000:3000 -it damoeb/rss-proxy:1 |
35 | 48 | ```
|
36 | 49 |
|
37 | 50 | Then open [localhost:3000](http://localhost:3000) in the browser.
|
38 | 51 |
|
39 |
| -## Features |
40 |
| -- Web to Feed |
41 |
| -- Dynamic Rendering using headless chromium |
42 |
| -- Filters |
43 |
| -- Feed Format Conversion Any -> ATOM/JSON |
44 |
| - |
45 |
| -## Migration from version 1 |
46 |
| -Version 2 supports the old version 1 urls, though this is optional. You can deactivate this feature by removing the 'legacy' profile in docker-compose.yml. |
47 |
| - |
48 |
| -## Changelog |
49 |
| - |
50 |
| -See [changelog](changelog.md). |
51 |
| - |
52 |
| - |
53 |
| -## Related Projects |
54 |
| - |
55 |
| -* [rss-bridge](https://github.com/RSS-Bridge/rss-bridge) |
56 |
| -* [rss-guard](https://github.com/martinrotter/rssguard) |
57 |
| - |
58 | 52 | ## License
|
59 | 53 |
|
60 | 54 | This project uses the following license: [GNU GPLv3](https://www.gnu.org/licenses/gpl-3.0.en.html).
|
0 commit comments