Getting Started
This page points to the main onboarding flow.
Start Here
Section titled “Start Here”If you want the recommended path, go to Run html2rss-web with Docker.
That guide is the canonical setup flow for:
- running
html2rss-weblocally - creating a feed from your own page URL
- using the demo token first
- moving to production setup only after first success
- choosing fallback or custom-config paths only when needed
Quick Shortcuts
Section titled “Quick Shortcuts”- Run html2rss-web with Docker: recommended first step
- Use automatic feed generation: understand the normal direct page-URL workflow
- Use the Feed Directory: fallback when the Feed Directory already covers your site
- Create Custom Feeds: write configs when you need more control
- Troubleshooting Guide: fix startup or extraction problems
Using the Ruby CLI
Section titled “Using the Ruby CLI”If you are working directly with the gem instead of html2rss-web, start with:
html2rss auto https://example.com/blogFor strategy behavior and manual overrides, see the Strategy reference.
If the target site is unusually redirect-heavy or needs extra follow-up requests, the CLI also supports:
html2rss auto https://example.com/blog --max-redirects 10 --max-requests 5For config-driven runs, the same flags are available on html2rss feed.