synced/coder
1
0
Fork 0
mirror of https://github.com/coder/coder.git synced 2025-07-23 21:32:07 +00:00
Code Issues Packages Projects Releases Wiki Activity

feat: add customizable upgrade message on client/server version mismatch (#11587)

Browse Source
This commit is contained in:
Jon Ayers
2024-01-30 17:11:37 -06:00
committed by GitHub
parent adbb025e74
commit 0c30dde9b5
16 changed files with 191 additions and 20 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/api/general.md generated
View File

@ -56,6 +56,7 @@ curl -X GET http://coder-server:8080/api/v2/buildinfo \
"agent_api_version": "string",
"dashboard_url": "string",
"external_url": "string",
"upgrade_message": "string",
"version": "string",
"workspace_proxy": true
}
@ -157,6 +158,7 @@ curl -X GET http://coder-server:8080/api/v2/deployment/config \
"autobuild_poll_interval": 0,
"browser_only": true,
"cache_directory": "string",
"cli_upgrade_message": "string",
"config": "string",
"config_ssh": {
"deploymentName": "string",

5
docs/api/schemas.md generated
View File

@ -1445,6 +1445,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
"agent_api_version": "string",
"dashboard_url": "string",
"external_url": "string",
"upgrade_message": "string",
"version": "string",
"workspace_proxy": true
}
@ -1457,6 +1458,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
| `agent_api_version` | string | false | | Agent api version is the current version of the Agent API (back versions MAY still be supported). |
| `dashboard_url` | string | false | | Dashboard URL is the URL to hit the deployment's dashboard. For external workspace proxies, this is the coderd they are connected to. |
| `external_url` | string | false | | External URL references the current Coder version. For production builds, this will link directly to a release. For development builds, this will link to a commit. |
| `upgrade_message` | string | false | | Upgrade message is the message displayed to users when an outdated client is detected. |
| `version` | string | false | | Version returns the semantic version of the build. |
| `workspace_proxy` | boolean | false | | |
@ -2131,6 +2133,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
"autobuild_poll_interval": 0,
"browser_only": true,
"cache_directory": "string",
"cli_upgrade_message": "string",
"config": "string",
"config_ssh": {
"deploymentName": "string",
@ -2497,6 +2500,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
"autobuild_poll_interval": 0,
"browser_only": true,
"cache_directory": "string",
"cli_upgrade_message": "string",
"config": "string",
"config_ssh": {
"deploymentName": "string",
@ -2758,6 +2762,7 @@ AuthorizationObject can represent a "set" of objects, such as: all workspaces in
| `autobuild_poll_interval` | integer | false | | |
| `browser_only` | boolean | false | | |
| `cache_directory` | string | false | | |
| `cli_upgrade_message` | string | false | | |
| `config` | string | false | | |
| `config_ssh` | [codersdk.SSHConfig](#codersdksshconfig) | false | | |
| `dangerous` | [codersdk.DangerousConfig](#codersdkdangerousconfig) | false | | |

10
docs/cli/server.md generated
View File

@ -73,6 +73,16 @@ Block peer-to-peer (aka. direct) workspace connections. All workspace connection
Whether Coder only allows connections to workspaces via the browser.
### --cli-upgrade-message
| | |
| ----------- | --------------------------------------- |
| Type | <code>string</code> |
| Environment | <code>$CODER_CLI_UPGRADE_MESSAGE</code> |
| YAML | <code>client.cliUpgradeMessage</code> |
The upgrade message to display to users when a client/server mismatch is detected. By default it instructs users to update using 'curl -L https://coder.com/install.sh | sh'.
### --cache-dir
| | |