diff --git a/src/pages/cli/_meta.json b/src/pages/cli/_meta.json index d80116b..13ce19a 100644 --- a/src/pages/cli/_meta.json +++ b/src/pages/cli/_meta.json @@ -6,5 +6,6 @@ "permissions": "Permissions", "plugins": "Plugins", "shell-completion": "Shell Completion", - "install-from-source": "Install from Source" + "install-from-source": "Install from Source", + "http-timeouts": "HTTP Timeouts" } diff --git a/src/pages/cli/http-timeouts.mdx b/src/pages/cli/http-timeouts.mdx new file mode 100644 index 0000000..943fbab --- /dev/null +++ b/src/pages/cli/http-timeouts.mdx @@ -0,0 +1,54 @@ +# Golem CLI HTTP Timeouts + +Golem CLI HTTP timeout behavior can be configured with environment variables. + +Durations use ISO-8601 format, for example `PT10S`, `PT1M`, or `PT2M30S`. + +## Service HTTP requests + +Used for general service API calls, including login and deploy-related calls. + +| Environment variable | Controls | Fallback default | +| --- | --- | --- | +| `GOLEM_HTTP_TIMEOUT` | Total request timeout | `PT120S` | +| `GOLEM_HTTP_CONNECT_TIMEOUT` | Connection setup timeout | `PT10S` | +| `GOLEM_HTTP_READ_TIMEOUT` | Response read timeout | `PT60S` | + +## Invoke requests + +Used for agent invocation HTTP requests. + +| Environment variable | Controls | Fallback default | +| --- | --- | --- | +| `GOLEM_HTTP_INVOKE_TIMEOUT` | Total request timeout | `none (unbounded)` | +| `GOLEM_HTTP_INVOKE_CONNECT_TIMEOUT` | Connection setup timeout | `none (unbounded)` | +| `GOLEM_HTTP_INVOKE_READ_TIMEOUT` | Response read timeout | `none (unbounded)` | + +## Health check requests + +Used for health-check HTTP requests. + +| Environment variable | Controls | Fallback default | +| --- | --- | --- | +| `GOLEM_HTTP_HEALTHCHECK_TIMEOUT` | Total request timeout | `PT2S` | +| `GOLEM_HTTP_HEALTHCHECK_CONNECT_TIMEOUT` | Connection setup timeout | `PT1S` | +| `GOLEM_HTTP_HEALTHCHECK_READ_TIMEOUT` | Response read timeout | `PT1S` | + +## File download requests + +Used for file downloads in app/manifest-related flows. + +| Environment variable | Controls | Fallback default | +| --- | --- | --- | +| `GOLEM_HTTP_FILE_DOWNLOAD_TIMEOUT` | Total request timeout | `PT120S` | +| `GOLEM_HTTP_FILE_DOWNLOAD_CONNECT_TIMEOUT` | Connection setup timeout | `PT10S` | +| `GOLEM_HTTP_FILE_DOWNLOAD_READ_TIMEOUT` | Response read timeout | `PT60S` | + +## Example + +```shell copy +export GOLEM_HTTP_TIMEOUT=PT120S +export GOLEM_HTTP_CONNECT_TIMEOUT=PT10S +export GOLEM_HTTP_READ_TIMEOUT=PT120S +golem deploy +```