Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/Kombustor/rss-fulltext-proxy
Get full-text content for any RSS-feed.
https://github.com/Kombustor/rss-fulltext-proxy
fulltext rss tinytinyrss
Last synced: 20 days ago
JSON representation
Get full-text content for any RSS-feed.
- Host: GitHub
- URL: https://github.com/Kombustor/rss-fulltext-proxy
- Owner: Kombustor
- License: mit
- Created: 2019-07-17T05:03:39.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-09-18T10:23:26.000Z (about 2 months ago)
- Last Synced: 2024-09-18T13:54:03.508Z (about 2 months ago)
- Topics: fulltext, rss, tinytinyrss
- Language: TypeScript
- Size: 719 KB
- Stars: 108
- Watchers: 4
- Forks: 9
- Open Issues: 21
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://greenkeeper.io/)
# RSS Fulltext Proxy 📃
Can "proxy"/mirror any RSS Feed to fetch full-text Content.
Allows integration into any feed reader, without plugins or further configuration required.
## Deployment
### Using Docker (recommended)
1. Download and modify the docker-compose.yml file to your liking.
2. Run `docker-compose up -d`
### Manually
1. Clone the repository: `git clone https://github.com/Kombustor/rss-fulltext-proxy.git`
2. Change working path: `cd rss-fulltext-proxy`
3. Install dependencies: `npm install`
4. Compile: `npm run build`
5. Run: `node dist/server.js`
> Note: You have to set the environment variables described in [Configuration](#Configuration) yourself, and you have to start a local redis server.
## Configuration
The application is easily configurable with environment variables.
| Name | Type | Default | Description |
|----------------------|--------|-------------------|----------------------------------------------------|
| PORT | number | 3000 | The port the webserver listens on. |
| REDIS_URL | string | redis://127.0.0.1 | The redis connection URL for caching. |
| CACHE_EXPIRY_SECONDS | number | 900 | The number of seconds for cache entries to expire. |
## Usage
We have to define two query parameters:
| Identifier | Description |
|------------|----------------------------------------|
| feed | The original feed URL to proxy. |
| selectors | URL-encoded string[] of CSS-selectors. |
#### Example:
- Feed URL: `http://rss.sueddeutsche.de/rss/Topthemen`
- Query Selectors of relevant HTML elements: `["figure.asset-image", "section.body > p, section.body > h3"]`
- URL-encoded selectors using [this](https://www.urlencoder.org/) website: `%5B%22figure.asset-image%22%2C%20%22section.body%20%3E%20p%2C%20section.body%20%3E%20h3%22%5D`
- The URL we are adding to our feed reader is: `http://host:post/?feed=http://rss.sueddeutsche.de/rss/Topthemen&selectors=%5B%22figure.asset-image%22%2C%20%22section.body%20%3E%20p%2C%20section.body%20%3E%20h3%22%5D`
- We are getting full-text RSS content for this feed. 🔥
A collection of selectors can be found on the [wiki page](https://github.com/Kombustor/rss-fulltext-proxy/wiki/Selectors-Collection).
If you create or improve a selector, feel free to open a pull request to add it to the wiki page.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
### TODO
- Make redis optional.
- Add common templates for easier usage.
- Unit tests.
- Linting.
- Add option to clear cache.
- Tutorial on how to choose selectors.
- Webinterface to visually select elements that should be included/removed.
- Support websites which don't provide a RSS feed.
## License
[MIT](https://choosealicense.com/licenses/mit/)