summaryrefslogtreecommitdiffhomepage
path: root/packages/web/src
diff options
context:
space:
mode:
authorDax Raad <[email protected]>2026-01-12 15:59:17 -0500
committerDax Raad <[email protected]>2026-01-12 15:59:17 -0500
commitf0912ee838e72b4bedd567d0110fa840820ddf18 (patch)
treeb3ef60dbac6e9d7489533d6df4ede9cfca358614 /packages/web/src
parent983f8ffecaa5aae9ecb4f22593c3ed91fc00f5bf (diff)
downloadopencode-f0912ee838e72b4bedd567d0110fa840820ddf18.tar.gz
opencode-f0912ee838e72b4bedd567d0110fa840820ddf18.zip
core: rename OPENCODE_PASSWORD to OPENCODE_SERVER_PASSWORD for clearer authentication configuration
Diffstat (limited to 'packages/web/src')
-rw-r--r--packages/web/src/content/docs/cli.mdx47
-rw-r--r--packages/web/src/content/docs/server.mdx4
2 files changed, 26 insertions, 25 deletions
diff --git a/packages/web/src/content/docs/cli.mdx b/packages/web/src/content/docs/cli.mdx
index 11a1d60d1..d1d11ed70 100644
--- a/packages/web/src/content/docs/cli.mdx
+++ b/packages/web/src/content/docs/cli.mdx
@@ -358,7 +358,7 @@ Start a headless OpenCode server for API access. Check out the [server docs](/do
opencode serve
```
-This starts an HTTP server that provides API access to opencode functionality without the TUI interface. Set `OPENCODE_PASSWORD` to enable HTTP basic auth (username `opencode`).
+This starts an HTTP server that provides API access to opencode functionality without the TUI interface. Set `OPENCODE_SERVER_PASSWORD` to enable HTTP basic auth (username defaults to `opencode`).
#### Flags
@@ -454,7 +454,7 @@ Start a headless OpenCode server with a web interface.
opencode web
```
-This starts an HTTP server and opens a web browser to access OpenCode through a web interface. Set `OPENCODE_PASSWORD` to enable HTTP basic auth (username `opencode`).
+This starts an HTTP server and opens a web browser to access OpenCode through a web interface. Set `OPENCODE_SERVER_PASSWORD` to enable HTTP basic auth (username defaults to `opencode`).
#### Flags
@@ -551,27 +551,28 @@ The opencode CLI takes the following global flags.
OpenCode can be configured using environment variables.
-| Variable | Type | Description |
-| ------------------------------------- | ------- | ----------------------------------------------------- |
-| `OPENCODE_AUTO_SHARE` | boolean | Automatically share sessions |
-| `OPENCODE_GIT_BASH_PATH` | string | Path to Git Bash executable on Windows |
-| `OPENCODE_CONFIG` | string | Path to config file |
-| `OPENCODE_CONFIG_DIR` | string | Path to config directory |
-| `OPENCODE_CONFIG_CONTENT` | string | Inline json config content |
-| `OPENCODE_DISABLE_AUTOUPDATE` | boolean | Disable automatic update checks |
-| `OPENCODE_DISABLE_PRUNE` | boolean | Disable pruning of old data |
-| `OPENCODE_DISABLE_TERMINAL_TITLE` | boolean | Disable automatic terminal title updates |
-| `OPENCODE_PERMISSION` | string | Inlined json permissions config |
-| `OPENCODE_DISABLE_DEFAULT_PLUGINS` | boolean | Disable default plugins |
-| `OPENCODE_DISABLE_LSP_DOWNLOAD` | boolean | Disable automatic LSP server downloads |
-| `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | boolean | Enable experimental models |
-| `OPENCODE_DISABLE_AUTOCOMPACT` | boolean | Disable automatic context compaction |
-| `OPENCODE_DISABLE_CLAUDE_CODE` | boolean | Disable reading from `.claude` (prompt + skills) |
-| `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | boolean | Disable reading `~/.claude/CLAUDE.md` |
-| `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | boolean | Disable loading `.claude/skills` |
-| `OPENCODE_CLIENT` | string | Client identifier (defaults to `cli`) |
-| `OPENCODE_ENABLE_EXA` | boolean | Enable Exa web search tools |
-| `OPENCODE_PASSWORD` | string | Enable basic auth for `serve`/`web` (user `opencode`) |
+| Variable | Type | Description |
+| ------------------------------------- | ------- | ------------------------------------------------- |
+| `OPENCODE_AUTO_SHARE` | boolean | Automatically share sessions |
+| `OPENCODE_GIT_BASH_PATH` | string | Path to Git Bash executable on Windows |
+| `OPENCODE_CONFIG` | string | Path to config file |
+| `OPENCODE_CONFIG_DIR` | string | Path to config directory |
+| `OPENCODE_CONFIG_CONTENT` | string | Inline json config content |
+| `OPENCODE_DISABLE_AUTOUPDATE` | boolean | Disable automatic update checks |
+| `OPENCODE_DISABLE_PRUNE` | boolean | Disable pruning of old data |
+| `OPENCODE_DISABLE_TERMINAL_TITLE` | boolean | Disable automatic terminal title updates |
+| `OPENCODE_PERMISSION` | string | Inlined json permissions config |
+| `OPENCODE_DISABLE_DEFAULT_PLUGINS` | boolean | Disable default plugins |
+| `OPENCODE_DISABLE_LSP_DOWNLOAD` | boolean | Disable automatic LSP server downloads |
+| `OPENCODE_ENABLE_EXPERIMENTAL_MODELS` | boolean | Enable experimental models |
+| `OPENCODE_DISABLE_AUTOCOMPACT` | boolean | Disable automatic context compaction |
+| `OPENCODE_DISABLE_CLAUDE_CODE` | boolean | Disable reading from `.claude` (prompt + skills) |
+| `OPENCODE_DISABLE_CLAUDE_CODE_PROMPT` | boolean | Disable reading `~/.claude/CLAUDE.md` |
+| `OPENCODE_DISABLE_CLAUDE_CODE_SKILLS` | boolean | Disable loading `.claude/skills` |
+| `OPENCODE_CLIENT` | string | Client identifier (defaults to `cli`) |
+| `OPENCODE_ENABLE_EXA` | boolean | Enable Exa web search tools |
+| `OPENCODE_SERVER_PASSWORD` | string | Enable basic auth for `serve`/`web` |
+| `OPENCODE_SERVER_USERNAME` | string | Override basic auth username (default `opencode`) |
---
diff --git a/packages/web/src/content/docs/server.mdx b/packages/web/src/content/docs/server.mdx
index a123acb15..7229e09b2 100644
--- a/packages/web/src/content/docs/server.mdx
+++ b/packages/web/src/content/docs/server.mdx
@@ -35,10 +35,10 @@ opencode serve --cors http://localhost:5173 --cors https://app.example.com
### Authentication
-Set `OPENCODE_PASSWORD` to protect the server with HTTP basic auth. The username is always `opencode`, and the password is the value of `OPENCODE_PASSWORD`. This applies to both `opencode serve` and `opencode web`.
+Set `OPENCODE_SERVER_PASSWORD` to protect the server with HTTP basic auth. The username defaults to `opencode`, or set `OPENCODE_SERVER_USERNAME` to override it. This applies to both `opencode serve` and `opencode web`.
```bash
-OPENCODE_PASSWORD=your-password opencode serve
+OPENCODE_SERVER_PASSWORD=your-password opencode serve
```
---