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.
Get Started
Section titled βGet StartedβStart with Getting Started to:
- run your own local instance
- use the demo token
- open a generated feed from your own instance
What The Web App Gives You
Section titled βWhat The Web App Gives Youβ- Web interface: direct feed creation from page URLs
- Access-controlled generation:
POST /api/v1/feedsexpects 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.
Recommended Flow
Section titled βRecommended Flowβ- Getting Started: run the app locally in 10 minutes
- Deployment & Production: move to a stable, production-ready setup
- Create Custom Feeds: build stable extraction rules when needed
Feature Guides
Section titled βFeature GuidesβOnce your instance is running, learn how to use its core features:
- Use automatic feed generation: create feeds from page URLs
- Use included configs: use the built-in Feed Directory as a fallback
- Monitoring: keep your instance healthy
For Integrations
Section titled βFor Integrationsβ- OpenAPI:
/openapi.yamlon your instance, orpublic/openapi.yamlin the repo - API metadata:
/api/v1 - Config schema for the core gem:
html2rss-config.schema.json