Skip to content

Web Application

html2rss-web is the recommended way to get started. Run the quickstart demo first, create one generated feed, then move to the real deployment setup when you want stable URLs of generated feeds, production secrets, explicit tokens, or monitoring.

Start with Getting Started to:

  • run your own local instance
  • use the demo token
  • open a generated feed from your own instance
  • Web interface: direct feed creation from page URLs
  • Access-controlled generation: POST /api/v1/feeds expects the token configured on your instance
  • Included Feed Directory: packaged fallback feeds you can use immediately from your own deployment
  • Config-based extension path: move to custom feeds when you need reviewable rules
  • Caching and HTTP handling: shipped as part of the deployment
  • Generated API contract: OpenAPI is published at /openapi.yaml

The scraping and feed-building engine is provided by the Ruby gem html2rss.

  1. Getting Started: run the app locally in 10 minutes
  2. Deployment & Production: move to a stable, production-ready setup
  3. Create Custom Feeds: build stable extraction rules when needed

Once your instance is running, learn how to use its core features: