upvote-rss  by johnwarne

Generate rich RSS feeds from social aggregation sites

Created 7 months ago
260 stars

Top 97.7% on SourcePulse

GitHubView on GitHub
Project Summary

Summary

Upvote RSS is a self-hosted tool that generates customizable RSS feeds from popular social aggregation websites like Reddit, Hacker News, and Lemmy instances. It targets users who prefer a low-volume, curated content consumption experience within their existing RSS readers. The primary benefit is the ability to filter and enrich content from these platforms, delivering highly personalized feeds with features like embedded media, AI summaries, and top comments.

How It Works

The project leverages PHP to fetch and parse content from various social platforms. It offers configurable filtering options, including score thresholds, posts per day, and NSFW filtering, to tailor feed content. For enhanced content extraction and summarization, it supports integration with external services like Readability.js, Mercury Parser, and multiple AI models (Ollama, OpenAI, Gemini, Anthropic, Mistral, DeepSeek) via API keys or local instances. Caching is implemented to improve performance, with options for filesystem or Redis caching.

Quick Start & Requirements

  • Installation: Docker is the preferred method. A docker run command or docker-compose.yml is provided. Manual installation requires PHP >= 8.1.
  • Prerequisites: For Reddit feeds, Reddit API credentials (client ID, client secret, username) are required and can be set via environment variables. Optional integrations for AI summaries and advanced parsing require API keys or URLs for respective services (Ollama, OpenAI, etc.).
  • Setup: Docker setup is generally quick. Manual setup depends on PHP environment configuration.
  • Links: Docker examples are in the README.

Highlighted Details

  • Supports Reddit, Hacker News, and Lemmy instances.
  • Integrates with multiple AI providers for article summarization.
  • Offers advanced filtering options (score, posts per day, custom domains).
  • Can embed media (videos, images, galleries) and include top comments.

Maintenance & Community

The project is described as "pretty low-maintenance" by the author, who plans to add more platforms and AI summarizer options as time permits. Bug reports are accepted with the expectation of eventual addressing. No specific community links (Discord, Slack) or major contributor/sponsorship details are provided in the README.

Licensing & Compatibility

  • License: MIT License.
  • Compatibility: The MIT license generally permits commercial use and linking with closed-source projects.

Limitations & Caveats

The project's maintenance is dependent on the author's limited free time, which may affect the pace of new feature development and bug fixes. Some websites may require JavaScript rendering, necessitating the use of a Browserless instance for optimal content parsing. The quality of AI summaries depends on the chosen model and configuration.

Health Check
Last Commit

2 weeks ago

Responsiveness

1 day

Pull Requests (30d)
0
Issues (30d)
4
Star History
29 stars in the last 30 days

Explore Similar Projects

Feedback? Help us improve.