Skip to content

Latest commit

 

History

History
63 lines (42 loc) · 2.57 KB

File metadata and controls

63 lines (42 loc) · 2.57 KB
title Turn Any Website Into an RSS Feed
description Run html2rss-web with Docker, paste your own page URL, enter one token, and open the generated feed.

Run html2rss-web with Docker, paste your own page URL, enter one access token, and open the generated feed from your own instance.

Start Here

Recommended path: Run html2rss-web with Docker

That guide is the canonical onboarding flow for:

  • starting a local instance
  • creating a generated feed from your own page URL
  • entering the token from your local setup
  • choosing the fallback or advanced path only when needed

What is html2rss?

html2rss is a toolkit for turning websites into feeds.

Most people should start with the web application:

  • html2rss-web: the self-hosted web interface and feed server
  • html2rss gem: the Ruby engine, CLI, and lower-level config workflow

Choose Your Path

I want a working instance first

  1. Run html2rss-web with Docker: recommended starting path
  2. Use the included configs: fallback guide when the packaged feed set already covers your site

I need more control

  1. Creating Custom Feeds: write and test your own configs
  2. Selectors Reference: learn the matching rules
  3. Strategy Reference: choose the right extraction strategy for static vs JavaScript-heavy pages

I'm building or integrating

  1. Ruby Gem Reference: full API documentation
  2. Advanced Features: custom HTTP requests and advanced extraction
  3. Contribute to Core: help improve the engine

What People Use It For

  • follow blogs and news sites without social media algorithms
  • track product updates and release notes
  • monitor job postings from company websites
  • subscribe to forums and communities that do not publish feeds
  • follow local news without repeated manual checking

Practical Notes

  • Start with Docker, not a public instance.
  • Start with your own listing, newsroom, changelog, or updates URL.
  • Automatic page-to-feed generation is the normal path.
  • Use included configs when the packaged catalog already covers your site.
  • Move to custom configs when you need a stable, reviewable setup.

Need help? Continue to the troubleshooting guide or join GitHub Discussions.