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.
modules/.sample
Muhammad Atif Ali e8bd011e61
add a template module and boilerplate (#30)
* add a template module and boilerplate

* add CONTRIBUTING.md (#31)

* Update .sample/README.md

Co-authored-by: Ben Potter <me@bpmct.net>

* swap screenshot and code sample

---------

Co-authored-by: Ben Potter <me@bpmct.net>
2 years ago
..
README.md add a template module and boilerplate (#30) 2 years ago
main.tf add a template module and boilerplate (#30) 2 years ago
run.sh add a template module and boilerplate (#30) 2 years ago

README.md

display_name description icon maintainer_github verified tags
MODULE_NAME Describe what this module does ../.icons/<A_RELEVANT_ICON>.svg GITHUB_USERNAME false
community

MODULE_NAME

<-- Describes what this module does -->

<-- Add a screencast or screenshot here -->

module "MODULE_NAME" {
    source = "https://registry.coder.com/modules/MODULE_NAME"
}

Examples

Example 1

Install the Dracula theme from OpenVSX:

module "MODULE_NAME" {
    source = "https://registry.coder.com/modules/MODULE_NAME"
    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 file:

module "MODULE_NAME" {
    source = "https://registry.coder.com/modules/MODULE_NAME"
    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:

module "MODULE_NAME" {
    source = "https://registry.coder.com/modules/MODULE_NAME"
    agent_id = coder_agent.example.id
    offline = true
}