docs: add --mdns-domain flag documentation (#11933)
This commit is contained in:
committed by
GitHub
parent
7508839b70
commit
95d0d476e3
@@ -190,6 +190,7 @@ You can configure server settings for the `opencode serve` and `opencode web` co
|
|||||||
"port": 4096,
|
"port": 4096,
|
||||||
"hostname": "0.0.0.0",
|
"hostname": "0.0.0.0",
|
||||||
"mdns": true,
|
"mdns": true,
|
||||||
|
"mdnsDomain": "myproject.local",
|
||||||
"cors": ["http://localhost:5173"]
|
"cors": ["http://localhost:5173"]
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
@@ -200,6 +201,7 @@ Available options:
|
|||||||
- `port` - Port to listen on.
|
- `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`.
|
- `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.
|
- `mdns` - Enable mDNS service discovery. This allows other devices on the network to discover your OpenCode server.
|
||||||
|
- `mdnsDomain` - Custom domain name for mDNS service. Defaults to `opencode.local`. Useful for running multiple instances on the same network.
|
||||||
- `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`.
|
- `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).
|
[Learn more about the server here](/docs/server).
|
||||||
|
|||||||
@@ -18,12 +18,13 @@ opencode serve [--port <number>] [--hostname <string>] [--cors <origin>]
|
|||||||
|
|
||||||
#### Options
|
#### Options
|
||||||
|
|
||||||
| Flag | Description | Default |
|
| Flag | Description | Default |
|
||||||
| ------------ | ----------------------------------- | ----------- |
|
| --------------- | ----------------------------------- | ---------------- |
|
||||||
| `--port` | Port to listen on | `4096` |
|
| `--port` | Port to listen on | `4096` |
|
||||||
| `--hostname` | Hostname to listen on | `127.0.0.1` |
|
| `--hostname` | Hostname to listen on | `127.0.0.1` |
|
||||||
| `--mdns` | Enable mDNS discovery | `false` |
|
| `--mdns` | Enable mDNS discovery | `false` |
|
||||||
| `--cors` | Additional browser origins to allow | `[]` |
|
| `--mdns-domain` | Custom domain name for mDNS service | `opencode.local` |
|
||||||
|
| `--cors` | Additional browser origins to allow | `[]` |
|
||||||
|
|
||||||
`--cors` can be passed multiple times:
|
`--cors` can be passed multiple times:
|
||||||
|
|
||||||
|
|||||||
@@ -64,6 +64,12 @@ opencode web --mdns
|
|||||||
|
|
||||||
This automatically sets the hostname to `0.0.0.0` and advertises the server as `opencode.local`.
|
This automatically sets the hostname to `0.0.0.0` and advertises the server as `opencode.local`.
|
||||||
|
|
||||||
|
You can customize the mDNS domain name to run multiple instances on the same network:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
opencode web --mdns --mdns-domain myproject.local
|
||||||
|
```
|
||||||
|
|
||||||
### CORS
|
### CORS
|
||||||
|
|
||||||
To allow additional domains for CORS (useful for custom frontends):
|
To allow additional domains for CORS (useful for custom frontends):
|
||||||
|
|||||||
Reference in New Issue
Block a user