Skip to content
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.

Sign up for GitHub

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

Place Configuration Options under Advanced Configuration #5316

Merged
merged 3 commits into from
Nov 28, 2024
Merged

Place Configuration Options under Advanced Configuration #5316

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
3422495
Place Configuration Options under Advanced Configuration
mamoodi Nov 28, 2024
42a117d
Update link to GUI mode
mamoodi Nov 28, 2024
51aefdf
Update example
mamoodi Nov 28, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 17 additions & 11 deletions docs/modules/usage/configuration-options.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
---
id: configuration-options
title: Configuration Options
sidebar_label: Configuration Options
---

# Configuration Options

This guide details all configuration options available for OpenHands, helping you customize its behavior and integrate it with other services.

:::note
If you are running in [GUI Mode](https://docs.all-hands.dev/modules/usage/how-to/gui-mode), the settings available in the Settings UI will always
take precedence.
:::

---

# Table of Contents
Expand Down Expand Up @@ -48,10 +47,10 @@ This guide details all configuration options available for OpenHands, helping yo
- [Confirmation Mode](#confirmation-mode)
- [Security Analyzer](#security-analyzer)


---

## Core Configuration

The core configuration options are defined in the `[core]` section of the `config.toml` file.

**API Keys**
Expand All @@ -61,7 +60,7 @@ The core configuration options are defined in the `[core]` section of the `confi
- Description: API key for E2B

- `modal_api_token_id`
- Type: `str`
- Type: `str`
- Default: `""`
- Description: API token ID for Modal

Expand Down Expand Up @@ -178,8 +177,11 @@ The core configuration options are defined in the `[core]` section of the `confi
- Description: JWT secret for authentication. Please set it to your own value.

## LLM Configuration

The LLM (Large Language Model) configuration options are defined in the `[llm]` section of the `config.toml` file.

To use these with the docker command, pass in `-e LLM_<option>`. Example: `-e LLM_NUM_RETRIES`.

**AWS Credentials**
Copy link
Collaborator

Choose a reason for hiding this comment

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

While this is accurate, we may want to choose an example that isn't available in the UI Settings. Like LLM_MAX_RETRIES maybe?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Updated per your suggestion. LLM_NUM_RETRIES. Thanks!

- `aws_access_key_id`
- Type: `str`
Expand Down Expand Up @@ -324,6 +326,7 @@ The LLM (Large Language Model) configuration options are defined in the `[llm]`
- Description: If model is vision capable, this option allows to disable image processing (useful for cost reduction)

## Agent Configuration

The agent configuration options are defined in the `[agent]` and `[agent.<agent_name>]` sections of the `config.toml` file.

**Microagent Configuration**
Expand Down Expand Up @@ -382,8 +385,11 @@ The agent configuration options are defined in the `[agent]` and `[agent.<agent_
- Description: A list of microagents to disable

## Sandbox Configuration

The sandbox configuration options are defined in the `[sandbox]` section of the `config.toml` file.

To use these with the docker command, pass in `-e SANDBOX_<option>`. Example: `-e SANDBOX_TIMEOUT`.

**Execution**
- `timeout`
- Type: `int`
Expand Down Expand Up @@ -436,8 +442,11 @@ The sandbox configuration options are defined in the `[sandbox]` section of the
- Description: BrowserGym environment to use for evaluation

## Security Configuration

The security configuration options are defined in the `[security]` section of the `config.toml` file.

To use these with the docker command, pass in `-e SECURITY_<option>`. Example: `-e SECURITY_CONFIRMATION_MODE`.

**Confirmation Mode**
- `confirmation_mode`
- Type: `bool`
Expand All @@ -450,10 +459,7 @@ The security configuration options are defined in the `[security]` section of th
- Default: `""`
- Description: The security analyzer to use


---

> **Note**: Adjust configurations carefully, especially for memory, security, and network-related settings to ensure optimal performance and security.
Please note that the configuration options may be subject to change in future versions of OpenHands. It's recommended to refer to the official documentation for the most up-to-date information.


16 changes: 5 additions & 11 deletions docs/sidebars.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,17 +44,6 @@ const sidebars: SidebarsConfig = {
},
],
},
{
type: 'category',
label: 'Configuration Options',
items: [
{
type: 'doc',
label: 'Overview',
id: 'usage/configuration-options',
},
],
},
{
type: 'category',
label: 'Advanced Configuration',
Expand Down Expand Up @@ -111,6 +100,11 @@ const sidebars: SidebarsConfig = {
label: 'Runtime Configuration',
id: 'usage/runtimes',
},
{
type: 'doc',
label: 'Configuration Options',
id: 'usage/configuration-options',
},
{
type: 'doc',
label: 'Custom Sandbox',
Expand Down
Loading