Skip to content

docs: troubleshooting.mdx says the desktop app uses OPENCODE_PORT for its local server — nothing reads it #117

Closed

Description

@dezren39

Problem

The English troubleshooting guide tells users debugging a desktop "Connection Failed" dialog to check OPENCODE_PORT:

  • packages/web/src/content/docs/troubleshooting.mdx:132 — "If you have OPENCODE_PORT set in your environment, the desktop app will try to use that port for the local server."
  • :134 — "Unset OPENCODE_PORT (or pick a free port) and restart."

Nothing in this repo reads OPENCODE_PORT. A user who follows this section will unset (or change) a variable that has no effect, while the actual port sources — the server.port config covered in the section directly above (:126-128), or the desktop sidecar's own choice — go unexamined for the case the guide attributes to the env var.

Evidence (verified this run, main 0bb248b075)

Why it matters

Troubleshooting docs are read by users who are already stuck. A step that cannot change anything burns the one restart cycle the user is willing to try, and misattributes the cause: a port clash from a stale OPENCODE_PORT is presented as a live possibility in v2 when the variable is v1 residue.

Acceptance criteria

Pick one direction and apply it consistently:

  1. Align the docs with v2: remove the OPENCODE_PORT passage from troubleshooting.mdx (English source; translations follow the usual docs-locale-sync flow), keeping the working advice (the server.port/server.hostname config section above it). Or:
  2. Implement it: make the desktop read OPENCODE_PORT when choosing its local server port, with a test showing the spawned server binds the requested port.

Filed-only: implement-vs-remove needs a maintainer decision (mirroring #103/#105), so no fix is attempted here. Single-repo: the guide and the desktop app live only in this repo.

Activity

  1. added a commit that references this issue on Oct 23, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions