Skip to content

Commit 743975e

Browse files
committed
docs: add workspace_apps documentation
Add comprehensive documentation for the new workspace_apps feature: - Explain how to configure which apps appear in workspace table - Provide example with both built-in and custom apps - Document valid app identifiers - Clarify default behavior when workspace_apps is not specified
1 parent d865441 commit 743975e

File tree

1 file changed

+36
-0
lines changed
  • docs/admin/templates/extending-templates

1 file changed

+36
-0
lines changed

docs/admin/templates/extending-templates/index.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -87,6 +87,42 @@ and can be hidden directly in the
8787
resource. You can arrange the display orientation of Coder apps in your template
8888
using [resource ordering](./resource-ordering.md).
8989

90+
#### Configuring workspace table apps
91+
92+
By default, all available apps (both built-in `display_apps` and custom `coder_app` resources) are shown as action buttons in the workspace table. You can customize which apps appear in the workspace table by using the `workspace_apps` attribute in the `coder_agent` resource:
93+
94+
```tf
95+
resource "coder_agent" "dev" {
96+
os = "linux"
97+
arch = "amd64"
98+
dir = "/workspace"
99+
100+
# Only show VS Code and a custom app in the workspace table
101+
workspace_apps = ["vscode", "my-custom-app"]
102+
103+
display_apps {
104+
vscode = true
105+
web_terminal = true
106+
}
107+
}
108+
109+
resource "coder_app" "my-custom-app" {
110+
agent_id = coder_agent.dev.id
111+
slug = "my-custom-app"
112+
display_name = "My Custom App"
113+
url = "http://localhost:8080"
114+
icon = "/icon/custom.svg"
115+
}
116+
```
117+
118+
In this example, even though both VS Code and Web Terminal are enabled in `display_apps`, only VS Code and the custom app will appear as action buttons in the workspace table. All apps remain accessible from the workspace detail page.
119+
120+
The `workspace_apps` list can contain:
121+
- Built-in app identifiers: `"vscode"`, `"vscode_insiders"`, `"web_terminal"`, `"ssh_helper"`, `"port_forwarding_helper"`
122+
- Custom app slugs from `coder_app` resources
123+
124+
If `workspace_apps` is not specified, all available apps are shown in the workspace table (default behavior).
125+
90126
### Coder app examples
91127

92128
<div class="tabs">

0 commit comments

Comments
 (0)