FAQs
Frequently asked questions about OpenHands
Getting Started
I’m new to OpenHands. Where should I start?
- Quick start: Use OpenHands Cloud to get started quickly with GitHub, GitLab, and Slack integrations.
- Run on your own: If you prefer to run it on your own hardware, follow our Getting Started guide.
- First steps: Complete the start building tutorial to learn the basics.
Can I use OpenHands for production workloads?
OpenHands is meant to be run by a single user on their local workstation. It is not appropriate for multi-tenant deployments where multiple users share the same instance. There is no built-in authentication, isolation, or scalability.
If you’re interested in running OpenHands in a multi-tenant environment, check out the source-available, commercially-licensed OpenHands Cloud Helm Chart.
Using OpenHands for work? We’d love to chat! Fill out this short form to join our Design Partner program, where you’ll get early access to commercial features and the opportunity to provide input on our product roadmap.
Safety and Security
It’s doing stuff without asking, is that safe?
Generally yes, but with important considerations. OpenHands runs all code in a secure, isolated Docker container (called a “sandbox”) that is separate from your host system. However, the safety depends on your configuration:
What’s protected:
- Your host system files and programs (unless you mount them using this feature)
- Host system resources
- Other containers and processes
Potential risks to consider:
- The agent can access the internet from within the container.
- If you provide credentials (API keys, tokens), the agent can use them.
- Mounted files and directories can be modified or deleted.
- Network requests can be made to external services.
For detailed security information, see our Runtime Architecture, Security Configuration, and Hardened Docker Installation documentation.
File Storage and Access
Where are my files stored?
Your files are stored in different locations depending on how you’ve configured OpenHands:
Default behavior (no file mounting):
- Files created by the agent are stored inside the runtime Docker container.
- These files are temporary and will be lost when the container is removed.
- The agent works in the
/workspace
directory inside the runtime container.
When you mount your local filesystem (following this):
- Your local files are mounted into the container’s
/workspace
directory. - Changes made by the agent are reflected in your local filesystem.
- Files persist after the container is stopped.
Be careful when mounting your filesystem - the agent can modify or delete any files in the mounted directory.
Development Tools and Environment
How do I get the dev tools I need?
OpenHands comes with a basic runtime environment that includes Python and Node.js. It also has the ability to install any tools it needs, so usually it’s sufficient to ask it to set up its environment.
If you would like to set things up more systematically, you can:
- Use setup.sh: Add a setup.sh file file to your repository, which will be run every time the agent starts.
- Use a custom sandbox: Use a custom docker image to initialize the sandbox.
Something’s not working. Where can I get help?
- Search existing issues: Check our GitHub issues to see if others have encountered the same problem.
- Join our community: Get help from other users and developers:
- Check our troubleshooting guide: Common issues and solutions are documented in Troubleshooting.
- Report bugs: If you’ve found a bug, please create an issue and fill in as much detail as possible.