diff options
| author | opencode-agent[bot] <219766164+opencode-agent[bot]@users.noreply.github.com> | 2025-12-31 11:11:20 -0600 |
|---|---|---|
| committer | GitHub <[email protected]> | 2025-12-31 11:11:20 -0600 |
| commit | c42bd492eae1178dae438e8509ddfb942ca116dc (patch) | |
| tree | 6e13775c09d568be470f8b6d1fa801014248debd /packages | |
| parent | 840fe030ab6f2c026bbb14b4ddddc0ed2a352bb3 (diff) | |
| download | opencode-c42bd492eae1178dae438e8509ddfb942ca116dc.tar.gz opencode-c42bd492eae1178dae438e8509ddfb942ca116dc.zip | |
docs: new configurable CORS option (#6522)
Co-authored-by: opencode-agent[bot] <opencode-agent[bot]@users.noreply.github.com>
Diffstat (limited to 'packages')
| -rw-r--r-- | packages/web/src/content/docs/cli.mdx | 22 | ||||
| -rw-r--r-- | packages/web/src/content/docs/config.mdx | 4 | ||||
| -rw-r--r-- | packages/web/src/content/docs/server.mdx | 19 |
3 files changed, 28 insertions, 17 deletions
diff --git a/packages/web/src/content/docs/cli.mdx b/packages/web/src/content/docs/cli.mdx index 4fe1d6103..329ce2ee7 100644 --- a/packages/web/src/content/docs/cli.mdx +++ b/packages/web/src/content/docs/cli.mdx @@ -362,11 +362,12 @@ This starts an HTTP server that provides API access to opencode functionality wi #### Flags -| Flag | Description | -| ------------ | --------------------- | -| `--port` | Port to listen on | -| `--hostname` | Hostname to listen on | -| `--mdns` | Enable mDNS discovery | +| Flag | Description | +| ------------ | ------------------------------------------ | +| `--port` | Port to listen on | +| `--hostname` | Hostname to listen on | +| `--mdns` | Enable mDNS discovery | +| `--cors` | Additional browser origin(s) to allow CORS | --- @@ -457,11 +458,12 @@ This starts an HTTP server and opens a web browser to access OpenCode through a #### Flags -| Flag | Description | -| ------------ | --------------------- | -| `--port` | Port to listen on | -| `--hostname` | Hostname to listen on | -| `--mdns` | Enable mDNS discovery | +| Flag | Description | +| ------------ | ------------------------------------------ | +| `--port` | Port to listen on | +| `--hostname` | Hostname to listen on | +| `--mdns` | Enable mDNS discovery | +| `--cors` | Additional browser origin(s) to allow CORS | --- diff --git a/packages/web/src/content/docs/config.mdx b/packages/web/src/content/docs/config.mdx index aa0a85320..24b822cc4 100644 --- a/packages/web/src/content/docs/config.mdx +++ b/packages/web/src/content/docs/config.mdx @@ -132,7 +132,8 @@ You can configure server settings for the `opencode serve` and `opencode web` co "server": { "port": 4096, "hostname": "0.0.0.0", - "mdns": true + "mdns": true, + "cors": ["http://localhost:5173"] } } ``` @@ -142,6 +143,7 @@ Available options: - `port` - Port to listen on. - `hostname` - Hostname to listen on. When `mdns` is enabled and no hostname is set, defaults to `0.0.0.0`. - `mdns` - Enable mDNS service discovery. This allows other devices on the network to discover your OpenCode server. +- `cors` - Additional origins to allow for CORS when using the HTTP server from a browser-based client. Values must be full origins (scheme + host + optional port), eg `https://app.example.com`. [Learn more about the server here](/docs/server). diff --git a/packages/web/src/content/docs/server.mdx b/packages/web/src/content/docs/server.mdx index 2568ade35..a61d7bae1 100644 --- a/packages/web/src/content/docs/server.mdx +++ b/packages/web/src/content/docs/server.mdx @@ -13,16 +13,23 @@ The `opencode serve` command runs a headless HTTP server that exposes an OpenAPI ### Usage ```bash -opencode serve [--port <number>] [--hostname <string>] +opencode serve [--port <number>] [--hostname <string>] [--cors <origin>] ``` #### Options -| Flag | Description | Default | -| ------------ | --------------------- | ----------- | -| `--port` | Port to listen on | `4096` | -| `--hostname` | Hostname to listen on | `127.0.0.1` | -| `--mdns` | Enable mDNS discovery | `false` | +| Flag | Description | Default | +| ------------ | ----------------------------------- | ----------- | +| `--port` | Port to listen on | `4096` | +| `--hostname` | Hostname to listen on | `127.0.0.1` | +| `--mdns` | Enable mDNS discovery | `false` | +| `--cors` | Additional browser origins to allow | `[]` | + +`--cors` can be passed multiple times: + +```bash +opencode serve --cors http://localhost:5173 --cors https://app.example.com +``` --- |