You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
70 lines
1.4 KiB
Markdown
70 lines
1.4 KiB
Markdown
---
|
|
display_name: MODULE_NAME
|
|
description: Describe what this module does
|
|
icon: ../.icons/<A_RELEVANT_ICON>.svg
|
|
maintainer_github: GITHUB_USERNAME
|
|
verified: false
|
|
tags: [helper]
|
|
---
|
|
|
|
# MODULE_NAME
|
|
|
|
<!-- Describes what this module does -->
|
|
|
|
```hcl
|
|
module "MODULE_NAME" {
|
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
|
version = "1.0.0"
|
|
}
|
|
```
|
|
|
|
<!-- Add a screencast or screenshot here put them in .images directory -->
|
|
|
|
## Examples
|
|
|
|
### Example 1
|
|
|
|
Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
|
|
|
|
```hcl
|
|
module "MODULE_NAME" {
|
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
|
version = "1.0.0"
|
|
agent_id = coder_agent.example.id
|
|
extensions = [
|
|
"dracula-theme.theme-dracula"
|
|
]
|
|
}
|
|
```
|
|
|
|
Enter the `<author>.<name>` into the extensions array and code-server will automatically install on start.
|
|
|
|
### Example 2
|
|
|
|
Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarted/settings#_settingsjson) file:
|
|
|
|
```hcl
|
|
module "MODULE_NAME" {
|
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
|
version = "1.0.0"
|
|
agent_id = coder_agent.example.id
|
|
extensions = [ "dracula-theme.theme-dracula" ]
|
|
settings = {
|
|
"workbench.colorTheme" = "Dracula"
|
|
}
|
|
}
|
|
```
|
|
|
|
### Example 3
|
|
|
|
Run code-server in the background, don't fetch it from GitHub:
|
|
|
|
```hcl
|
|
module "MODULE_NAME" {
|
|
source = "registry.coder.com/modules/MODULE_NAME/coder"
|
|
version = "1.0.0"
|
|
agent_id = coder_agent.example.id
|
|
offline = true
|
|
}
|
|
```
|