Skip to content

Commit b2f8466

Browse files
sharkymarkmatifali
andauthored
docs: document display_apps feature to hide/show built-in coder_app resources (#9714)
* docs: display_apps feature to hide/show terminal, vscode desktop, port-forwarding, etc. * Update docs/templates/index.md Co-authored-by: Muhammad Atif Ali <atif@coder.com> * Update docs/templates/index.md Co-authored-by: Muhammad Atif Ali <atif@coder.com> --------- Co-authored-by: Muhammad Atif Ali <atif@coder.com>
1 parent ab08b2c commit b2f8466

File tree

2 files changed

+23
-0
lines changed

2 files changed

+23
-0
lines changed

docs/images/display-apps.png

25.1 KB
Loading

docs/templates/index.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -411,6 +411,29 @@ By default, all templates allow developers to connect over SSH and a web
411411
terminal. See [Configuring Web IDEs](../ides/web-ides.md) to learn how to give
412412
users access to additional web applications.
413413

414+
Template administrators can hide apps like the web-based Terminal or VS Code
415+
Desktop with the
416+
[`display_apps`](https://registry.terraform.io/providers/coder/coder/0.11.2/docs/resources/agent#display_apps)
417+
configuration in the
418+
[`coder_agent`](https://registry.terraform.io/providers/coder/coder/latest/docs/resources/agent)
419+
resource. For example, the following configuration block will hide all default
420+
Coder apps except the web terminal.
421+
422+
```hcl
423+
display_apps {
424+
vscode = false
425+
vscode_insiders = false
426+
ssh_helper = false
427+
port_forwarding_helper = false
428+
web_terminal = true
429+
}
430+
```
431+
432+
Example use cases for `display_apps` are JetBrains users or zero-trust
433+
deployments who do not want nor should have access to a local VS Code IDE.
434+
435+
![display-apps](../images/display-apps.png)
436+
414437
### Data source
415438

416439
When a workspace is being started or stopped, the `coder_workspace` data source

0 commit comments

Comments
 (0)