html2rss-web

html2rss-web turns website sources into RSS/JSON feeds.

Quickstart

Test drive the app with these steps:

1. Download docker-compose.quickstart.yml
2. docker compose -f docker-compose.quickstart.yml up -d
3. Open http://localhost:4000/ in your browser
4. When prompted for a token, use CHANGE_ME_ADMIN_TOKEN

Important

This is a first-run demo path, not a production-ready setup.

Continue with the Getting Started and deployment guides for real setup.

Development (Dev Container Only)

All local development and test execution should run inside the repository Dev Container.

make setup
make dev
make ready

Local html2rss gem coupling

Feature branches that depend on an unreleased html2rss API may pin the gem from GitHub in Gemfile (for example gem 'html2rss', github: 'html2rss/html2rss', branch: 'feat/feed-result-api'). That pin is for CI and branch review until the upstream gem change is published: revert to the released RubyGems version before merging to main. Do not leave a sibling path: '../html2rss' pin active for CI.

Development and Contributing

• Contributing guidelines: https://html2rss.github.io/get-involved/contributing
• Docker image: https://hub.docker.com/r/html2rss/web
• Discussions: https://github.com/orgs/html2rss/discussions
• Sponsor: https://github.com/sponsors/gildesmarais