Skip to content

index.mdx

Latest commit

 

History

History
69 lines (46 loc) · 2.93 KB

index.mdx

File metadata and controls

69 lines (46 loc) · 2.93 KB
title Turn Any Website Into an RSS Feed
description Run html2rss-web with Docker, verify a working included feed from your self-hosted instance, then consciously enable automatic generation or move to custom configs when you need more control.

Run html2rss-web with Docker, verify a working included feed from your self-hosted instance, and only then decide whether to enable automatic generation or move to custom configs.

Start Here

Recommended path: Run html2rss-web with Docker

That guide is the canonical onboarding flow for:

  • starting a local instance
  • verifying the web interface
  • opening a first included feed URL
  • deciding when to consciously enable automatic generation or move to custom configs

How It Works

  1. Run your own local instance with Docker
  2. Open a built-in feed URL from your own instance
  3. Copy the feed URL into your reader

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: use real embedded feeds from your own instance
  3. Browse working feed examples: see what working outputs look like

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.
  • Use an included feed to verify the deployment first.
  • Enable automatic generation only when you want the direct page-URL workflow and are ready to allow it on your self-hosted instance.
  • Move to custom configs when you need a stable, reviewable setup.

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