Skip to content

Add search engine setup documentation #8870

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Jun 3, 2025
Merged

Conversation

xingyaoww
Copy link
Collaborator

@xingyaoww xingyaoww commented Jun 3, 2025

  • This change is worth documenting at https://docs.all-hands.dev/
  • Include this change in the Release Notes. If checked, you must provide an end-user friendly description for your change below

End-user friendly description of the problem this fixes or functionality this introduces.

Adds documentation on how to set up the search engine functionality using Tavily API in OpenHands. This helps users understand how to enable web search capabilities for their agents.


Summarize what the PR does, explaining any non-trivial design decisions.

This PR adds:

  1. A new documentation page under "Advanced Configuration" that explains how to set up and use the Tavily search engine with OpenHands
  2. Updates the installation documentation to include a section about setting up the search engine
  3. Adds different instructions for self-hosted OpenHands vs. OpenHands Cloud

Link of any specific issues this addresses:

N/A


To run this PR locally, use the following command:

docker run -it --rm   -p 3000:3000   -v /var/run/docker.sock:/var/run/docker.sock   --add-host host.docker.internal:host-gateway   -e SANDBOX_RUNTIME_CONTAINER_IMAGE=docker.all-hands.dev/all-hands-ai/runtime:e983ac5-nikolaik   --name openhands-app-e983ac5   docker.all-hands.dev/all-hands-ai/openhands:e983ac5

@xingyaoww xingyaoww requested a review from neubig June 3, 2025 14:28
@xingyaoww xingyaoww marked this pull request as ready for review June 3, 2025 14:28
@xingyaoww xingyaoww requested a review from mamoodi as a code owner June 3, 2025 14:28
Copy link
Contributor

@neubig neubig left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM, thanks for adding!

@xingyaoww xingyaoww enabled auto-merge (squash) June 3, 2025 15:15
@xingyaoww xingyaoww merged commit 2f55cbb into main Jun 3, 2025
19 checks passed
@xingyaoww xingyaoww deleted the docs/add-search-engine-setup branch June 3, 2025 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants