Updated crawl4ai docs

[D-K-P]

Summary by CodeRabbit

• New Features

  • Enabled proxy support for the web crawler, allowing it to operate through specified proxy servers using configurable settings.

• Documentation

  • Updated the guide with a new "Using Proxies" section that details how to set up proxy configurations via environment variables.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 60c1e2c

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The pull request updates the Python web crawler to support proxy configurations. The documentation now includes a new "Using Proxies" section with guidance on setting proxy-related environment variables. In the task code, the run method in the convertUrlToMarkdown function is modified to pass proxy settings to the Python script via an env object. Additionally, the Python script (crawl-url.py) is updated to retrieve and apply these proxy settings during the instantiation of AsyncWebCrawler.

Changes

File(s)	Change Summary
docs/guides/python/python-crawl4ai.mdx	Added a new "Using Proxies" section explaining proxy services and environment variable configuration.
Task code (e.g., convertUrlToMarkdown)	Modified the run method to include an env object carrying proxy variables; updated python.runScript to accept the env.
crawl-url.py	Updated to retrieve PROXY_URL, PROXY_USERNAME, and PROXY_PASSWORD from environment variables and configure the proxy.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant TaskCode as convertUrlToMarkdown.run
    participant PythonRunner as python.runScript
    participant Crawler as crawl-url.py / AsyncWebCrawler

    User->>TaskCode: Trigger task execution
    TaskCode->>PythonRunner: Call python.runScript(env) with proxy variables
    PythonRunner->>Crawler: Execute crawl-url.py with provided env
    Crawler->>Crawler: Read PROXY_URL (and credentials if any)
    Crawler->>Crawler: Configure BrowserConfig with proxy settings
    Crawler-->>PythonRunner: Return execution response
    PythonRunner-->>TaskCode: Forward response to task code

Loading

Suggested reviewers

• nicktrn

Poem

Oh, what a change under the digital sky,
The rabbit hops through code, oh so spry.
With proxies in place, our paths are clear,
A hop, a skip, no worries here!
🐇✨ Cheers to a swift, secure new gear!

Hop on and code on, my dear!

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

🧹 Nitpick comments (2)

docs/guides/python/python-crawl4ai.mdx (2)

25-25: Clarify the new feature bullet for proxy support.
The addition of "Proxy support" in the Features list is clear. Consider linking directly to the "Using Proxies" section (if supported by your documentation framework) to improve navigation.

---

29-40: Detailed proxy configuration instructions added.
The documentation clearly outlines the popular proxy services and the necessary environment variables (PROXY_URL, PROXY_USERNAME, and PROXY_PASSWORD). A couple of minor suggestions:

• Consider rewording "and add them in the Trigger.dev dashboard:" to "and add them to the Trigger.dev dashboard:" for improved grammatical clarity.
• Verify the punctuation around the example URL in PROXY_URL to ensure consistency.

📜 Review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 282cc06 and 60c1e2c.

📒 Files selected for processing (1)

• docs/guides/python/python-crawl4ai.mdx (3 hunks)

🧰 Additional context used

🪛 LanguageTool

docs/guides/python/python-crawl4ai.mdx

[uncategorized] ~41-~41: Loose punctuation mark.
Context: ...he Trigger.dev dashboard: - PROXY_URL: The URL of your proxy server (e.g., `ht...

(UNLIKELY_OPENING_PUNCTUATION)

⏰ Context from checks skipped due to timeout of 90000ms (1)

• GitHub Check: Analyze (javascript-typescript)

🔇 Additional comments (1)

docs/guides/python/python-crawl4ai.mdx (1)

27-28: New "Using Proxies" section header added.
This new section header nicely isolates the proxy configuration details from the rest of the document, enhancing readability and organization.