docs: align botasaurus + auto fallback + web release model#1136
Merged
gildesmarais merged 6 commits intomainfrom May 1, 2026
Merged
docs: align botasaurus + auto fallback + web release model#1136gildesmarais merged 6 commits intomainfrom
gildesmarais merged 6 commits intomainfrom
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
Updates the documentation site to reflect new html2rss strategy behavior (Botasaurus + auto fallback) and the html2rss-web Docker release/tagging model, while simplifying some high-level onboarding copy.
Changes:
- Document default
autostrategy fallback order (faraday -> botasaurus -> browserless) and addBOTASAURUS_SCRAPER_URLguidance across strategy/CLI/troubleshooting docs. - Switch recommended
html2rss-webDocker image usage from:latestto the major-version tag:1, and document the tagging scheme. - Simplify web-app onboarding and deployment wording; update Watchtower guidance to emphasize “updates follow the tag”.
Reviewed changes
Copilot reviewed 20 out of 20 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| src/data/docker.ts | Updates the canonical webImage tag used by generated Compose snippets to html2rss/web:1. |
| src/content/docs/web-application/reference/versioning-and-releases.mdx | Replaces rolling-release wording with a versioned Docker tag model and recommended tag usage. |
| src/content/docs/web-application/reference/env-variables.mdx | Clarifies BUILD_TAG/GIT_SHA as release metadata set by published images. |
| src/content/docs/web-application/index.mdx | Simplifies overview copy and streamlines the recommended flow steps. |
| src/content/docs/web-application/how-to/use-automatic-feed-generation.mdx | Adjusts UI flow text and reframes strategy behavior as backend-default-driven. |
| src/content/docs/web-application/how-to/deployment.mdx | Updates deployment guidance to use html2rss/web:1 and refreshes reverse proxy / ops notes. |
| src/content/docs/web-application/how-to/automatic-updates.mdx | Emphasizes Watchtower updates follow the selected Docker tag (major-version tag guidance). |
| src/content/docs/web-application/getting-started.mdx | Simplifies local verification steps and reduces repeated onboarding prose. |
| src/content/docs/troubleshooting/troubleshooting.mdx | Updates troubleshooting guidance for browser-based strategies and adds Botasaurus-related errors. |
| src/content/docs/ruby-gem/reference/strategy.mdx | Documents auto default fallback chain and adds a Botasaurus strategy reference section. |
| src/content/docs/ruby-gem/reference/cli-reference.mdx | Adds default auto strategy behavior, Botasaurus CLI examples, and BOTASAURUS env requirements. |
| src/content/docs/ruby-gem/how-to/handling-dynamic-content.mdx | Generalizes “dynamic content” guidance to browser-based strategies (Browserless/Botasaurus). |
| src/content/docs/ruby-gem/how-to/custom-http-requests.mdx | Notes request.botasaurus.* as strategy-specific request controls alongside Browserless. |
| src/content/docs/ruby-gem/how-to/advanced-features.mdx | Updates strategy advice to “static vs browser-based extraction” framing. |
| src/content/docs/index.mdx | Simplifies landing-page onboarding phrasing and removes some feed-directory emphasis. |
| src/content/docs/getting-started.mdx | Updates getting-started description and adds a pointer to the Strategy reference. |
| src/content/docs/creating-custom-feeds.mdx | Tightens copy and reframes escalation guidance to “browser-based strategy when needed”. |
| src/content/docs/common-use-cases.mdx | Simplifies use-case narrative and replaces removed sections with a shorter “Next Steps”. |
| src/components/docs/DockerComposeSnippet.astro | Removes explicit BUILD_TAG/GIT_SHA entries and inherits the new webImage tag in snippets. |
| examples/deployment/docker-compose.yml | Updates the example deployment image tag from :latest to :1. |
Comment on lines
+51
to
+56
| <Code | ||
| code={` | ||
| CADDY_HOST=yourdomain.com | ||
| HTML2RSS_SECRET_KEY=<openssl rand -hex 32> | ||
| HEALTH_CHECK_TOKEN=<strong bearer token> | ||
| BROWSERLESS_IO_API_TOKEN=<browserless token> |
Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Why
This docs update tracks the Botasaurus strategy introduction in html2rss core:
and new default
autostrategy::autowith fallback selection & raise on empty feed html2rss#358Validation