| title | Getting Started | ||
|---|---|---|---|
| description | Start html2rss-web locally, paste your own URL, enter one token, and open the generated feed. | ||
| sidebar |
|
import { Code } from "@astrojs/starlight/components";
This page points to the main onboarding flow.
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
- entering the token from your local setup
- choosing fallback or custom-config paths only when needed
- Run html2rss-web with Docker: recommended first step
- Use automatic feed generation: understand the normal direct page-URL workflow
- Use the included configs: fallback when the packaged catalog already covers your site
- Create Custom Feeds: write configs when you need more control
- Troubleshooting Guide: fix startup or extraction problems
If you are working directly with the gem instead of html2rss-web, start with:
<Code code={html2rss auto https://example.com/blog} lang="bash" />
For 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:
<Code code={html2rss auto https://example.com/blog --max-redirects 10 --max-requests 5} lang="bash" />
For config-driven runs, the same flags are available on html2rss feed.