impl: support for Toolbox 2.7 #135
Open
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
With the new TBX API we can update the title of a UI page without recreating the page and using hacks to force TBX to update the internal state.
Used by the Toolbox 2.7
We still need to switch from the coder setup page back to the main screen once the coder cli and the rest api poller is initialized.
Similar with the initial setup page we can use the new TBX API to update the title of the uri handling page without recreating it and using hacks to force TBX to update the internal state.
TBX 2.7 API prioritizes connection status to the remote TBX agent over the workspace status. This would mean that a running workspace would be listed as disconnected instead of ready. This is confusing as it only happens for running workspaces and on top of that we also have a green badge that is rendered by TBX when the agent connection is established.
A new API was added to allow proxy authentication
The new TBX 2.7 API allows us to change the message displayed while loading the workspaces from "Loading environments" to "Loading workspaces"
The new TBX 2.7 api exposes basic auth credentials for proxy.
The new API introduced in TBX 2.7, and HTTP proxy authentication works flawlessly. However, SOCKS5 proxy authentication does not appear to be properly supported in the current TBX implementation. While users can configure a SOCKS5 proxy with basic authentication, Toolbox fails to authenticate successfully. Coder uses OkHttp as the HTTP client, which in turn delegates SOCKS5 authentication to the JVM (java.net.SocksSocketImpl). We can configure a java.net .Authenticator with the credentials exposed by the new TBX API. However, since the Authenticator is set globally, doing so would affect all plugins — including TBX itself — which may not be desirable.
Introduces support for Toolbox 2.7
matifali
approved these changes
Jun 28, 2025
| @@ -144,6 +150,10 @@ mitmproxy can do HTTP and SOCKS5 proxying. To configure one or the other: | |||
| 5. Before authenticating to the Coder deployment we need to tell the plugin where can we find mitmproxy | |||
| certificates. In Coder's Settings page, set the `TLS CA path` to `~/.mitmproxy/mitmproxy-ca-cert.pem` | |||
|
|
|||
| > ⚠️ Note: Coder Toolbox plugin handles only HTTP/HTTPS proxy authentication. | |||
There was a problem hiding this comment.
Suggested change
| > ⚠️ Note: Coder Toolbox plugin handles only HTTP/HTTPS proxy authentication. | |
| > [!NOTE] | |
| > Coder Toolbox plugin handles only HTTP/HTTPS proxy authentication. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Things that were changed or added to TBX 2.7:
Support for Proxy Authentication
The new API introduced in TBX 2.7, and HTTP proxy authentication works flawlessly. However, SOCKS5 proxy authentication does not appear to be properly supported in the current TBX implementation.
While users can configure a SOCKS5 proxy with basic authentication, Toolbox fails to authenticate successfully. Coder uses OkHttp as the HTTP client, which in turn delegates SOCKS5 authentication to the JVM (java.net.SocksSocketImpl). We can configure a java.net.Authenticator with the credentials exposed by the new TBX API. However, since the Authenticator is set globally, doing so would affect all plugins — including TBX itself — which may not be desirable.
Customizable messages while loading the workspaces
The new TBX 2.7 API allows us to change the message displayed while loading the workspaces from "Loading environments" to "Loading workspaces"
UI pages with customizable titles
Support for custom aliases in the URI handling protocol