| title | Getting Started | ||
|---|---|---|---|
| description | Start html2rss-web locally, verify a working included feed from your self-hosted instance, and decide when to enable automatic generation or move to custom configs. | ||
| sidebar |
|
import Code from "astro/components/Code.astro";
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 - confirming the interface is working
- opening a first included feed URL
- deciding when to use automatic generation or custom configs
- Run html2rss-web with Docker: recommended first step
- Browse working feed examples: see what successful outputs look like
- Use automatic feed generation: enable direct feed creation from a page URL when you want that workflow
- 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" />
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.