pull/134/head
Mathias Fredriksson 1 year ago
parent d1d6b8bfaa
commit dc7e3f02fe

@ -16,8 +16,8 @@ e.g.
```tf ```tf
module "code-server" { module "code-server" {
source = "registry.coder.com/modules/code-server/coder" source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.main.id agent_id = coder_agent.main.id
} }
``` ```

@ -16,7 +16,7 @@ Customize the preselected parameter value:
```tf ```tf
module "aws-region" { module "aws-region" {
source = "registry.coder.com/modules/aws-region/coder" source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0" version = "1.0.0"
default = "us-east-1" default = "us-east-1"
} }
@ -36,14 +36,14 @@ Change the display name and icon for a region using the corresponding maps:
```tf ```tf
module "aws-region" { module "aws-region" {
source = "registry.coder.com/modules/aws-region/coder" source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0" version = "1.0.0"
default = "ap-south-1" default = "ap-south-1"
custom_names = { custom_names = {
"ap-south-1": "Awesome Mumbai!" "ap-south-1" : "Awesome Mumbai!"
} }
custom_icons = { custom_icons = {
"ap-south-1": "/emojis/1f33a.png" "ap-south-1" : "/emojis/1f33a.png"
} }
} }
@ -60,9 +60,9 @@ Hide the Asia Pacific regions Seoul and Osaka:
```tf ```tf
module "aws-region" { module "aws-region" {
source = "registry.coder.com/modules/aws-region/coder" source = "registry.coder.com/modules/aws-region/coder"
version = "1.0.0" version = "1.0.0"
exclude = [ "ap-northeast-2", "ap-northeast-3" ] exclude = ["ap-northeast-2", "ap-northeast-3"]
} }
provider "aws" { provider "aws" {

@ -13,7 +13,7 @@ This module adds a parameter with all Azure regions, allowing developers to sele
```tf ```tf
module "azure_region" { module "azure_region" {
source = "registry.coder.com/modules/azure-region/coder" source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0" version = "1.0.0"
default = "eastus" default = "eastus"
} }
@ -33,13 +33,13 @@ Change the display name and icon for a region using the corresponding maps:
```tf ```tf
module "azure-region" { module "azure-region" {
source = "registry.coder.com/modules/azure-region/coder" source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0" version = "1.0.0"
custom_names = { custom_names = {
"australia": "Go Australia!" "australia" : "Go Australia!"
} }
custom_icons = { custom_icons = {
"australia": "/icons/smiley.svg" "australia" : "/icons/smiley.svg"
} }
} }
@ -56,7 +56,7 @@ Hide all regions in Australia except australiacentral:
```tf ```tf
module "azure-region" { module "azure-region" {
source = "registry.coder.com/modules/azure-region/coder" source = "registry.coder.com/modules/azure-region/coder"
version = "1.0.0" version = "1.0.0"
exclude = [ exclude = [
"australia", "australia",

@ -13,8 +13,8 @@ Automatically install [code-server](https://github.com/coder/code-server) in a w
```tf ```tf
module "code-server" { module "code-server" {
source = "registry.coder.com/modules/code-server/coder" source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```
@ -40,8 +40,8 @@ Install the Dracula theme from [OpenVSX](https://open-vsx.org/):
```tf ```tf
module "code-server" { module "code-server" {
source = "registry.coder.com/modules/code-server/coder" source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
extensions = [ extensions = [
"dracula-theme.theme-dracula" "dracula-theme.theme-dracula"
@ -57,10 +57,10 @@ Configure VS Code's [settings.json](https://code.visualstudio.com/docs/getstarte
```tf ```tf
module "settings" { module "settings" {
source = "registry.coder.com/modules/code-server/coder" source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
extensions = [ "dracula-theme.theme-dracula" ] extensions = ["dracula-theme.theme-dracula"]
settings = { settings = {
"workbench.colorTheme" = "Dracula" "workbench.colorTheme" = "Dracula"
} }
@ -73,10 +73,10 @@ Just run code-server in the background, don't fetch it from GitHub:
```tf ```tf
module "settings" { module "settings" {
source = "registry.coder.com/modules/code-server/coder" source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
extensions = [ "dracula-theme.theme-dracula", "ms-azuretools.vscode-docker" ] extensions = ["dracula-theme.theme-dracula", "ms-azuretools.vscode-docker"]
} }
``` ```
@ -86,9 +86,9 @@ Just run code-server in the background, don't fetch it from GitHub:
```tf ```tf
module "settings" { module "settings" {
source = "registry.coder.com/modules/code-server/coder" source = "registry.coder.com/modules/code-server/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
offline = true offline = true
} }
``` ```

@ -13,8 +13,8 @@ Allow developers to optionally bring their own [dotfiles repository](https://dot
```tf ```tf
module "dotfiles" { module "dotfiles" {
source = "registry.coder.com/modules/dotfiles/coder" source = "registry.coder.com/modules/dotfiles/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```

@ -13,8 +13,8 @@ A file browser for your workspace.
```tf ```tf
module "filebrowser" { module "filebrowser" {
source = "registry.coder.com/modules/filebrowser/coder" source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```
@ -27,10 +27,10 @@ module "filebrowser" {
```tf ```tf
module "filebrowser" { module "filebrowser" {
source = "registry.coder.com/modules/filebrowser/coder" source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
folder = "/home/coder/project" folder = "/home/coder/project"
} }
``` ```
@ -38,9 +38,9 @@ module "filebrowser" {
```tf ```tf
module "filebrowser" { module "filebrowser" {
source = "registry.coder.com/modules/filebrowser/coder" source = "registry.coder.com/modules/filebrowser/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
database_path = ".config/filebrowser.db" database_path = ".config/filebrowser.db"
} }
``` ```

@ -15,7 +15,7 @@ We can use the simplest format here, only adding a default selection as the `atl
```tf ```tf
module "fly-region" { module "fly-region" {
source = "registry.coder.com/modules/fly-region/coder" source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0" version = "1.0.0"
default = "atl" default = "atl"
} }
@ -31,7 +31,7 @@ The regions argument can be used to display only the desired regions in the Code
```tf ```tf
module "fly-region" { module "fly-region" {
source = "registry.coder.com/modules/fly-region/coder" source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0" version = "1.0.0"
default = "ams" default = "ams"
regions = ["ams", "arn", "atl"] regions = ["ams", "arn", "atl"]
@ -46,14 +46,14 @@ Set custom icons and names with their respective maps.
```tf ```tf
module "fly-region" { module "fly-region" {
source = "registry.coder.com/modules/fly-region/coder" source = "registry.coder.com/modules/fly-region/coder"
version = "1.0.0" version = "1.0.0"
default = "ams" default = "ams"
custom_icons = { custom_icons = {
"ams" = "/emojis/1f90e.png" "ams" = "/emojis/1f90e.png"
} }
custom_names = { custom_names = {
"ams" = "We love the Netherlands!" "ams" = "We love the Netherlands!"
} }
} }
``` ```

@ -18,8 +18,8 @@ This module has a chance of conflicting with the user's dotfiles / the personali
```tf ```tf
module "git-commit-signing" { module "git-commit-signing" {
source = "registry.coder.com/modules/git-commit-signing/coder" source = "registry.coder.com/modules/git-commit-signing/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```

@ -13,8 +13,8 @@ Runs a script that updates git credentials in the workspace to match the user's
```tf ```tf
module "git-config" { module "git-config" {
source = "registry.coder.com/modules/git-config/coder" source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```
@ -27,9 +27,9 @@ TODO: Add screenshot
```tf ```tf
module "git-config" { module "git-config" {
source = "registry.coder.com/modules/git-config/coder" source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
allow_email_change = true allow_email_change = true
} }
``` ```
@ -40,11 +40,11 @@ TODO: Add screenshot
```tf ```tf
module "git-config" { module "git-config" {
source = "registry.coder.com/modules/git-config/coder" source = "registry.coder.com/modules/git-config/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
allow_username_change = false allow_username_change = false
allow_email_change = false allow_email_change = false
} }
``` ```

@ -30,12 +30,12 @@ module "jetbrains_gateway" {
```tf ```tf
module "jetbrains_gateway" { module "jetbrains_gateway" {
source = "registry.coder.com/modules/jetbrains-gateway/coder" source = "registry.coder.com/modules/jetbrains-gateway/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
folder = "/home/coder/example" folder = "/home/coder/example"
jetbrains_ides = ["GO", "WS"] jetbrains_ides = ["GO", "WS"]
default = "GO" default = "GO"
} }
``` ```

@ -16,15 +16,15 @@ Install the JF CLI and authenticate package managers with Artifactory using OAut
```tf ```tf
module "jfrog" { module "jfrog" {
source = "registry.coder.com/modules/jfrog-oauth/coder" source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
jfrog_url = "https://example.jfrog.io" jfrog_url = "https://example.jfrog.io"
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username" username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
package_managers = { package_managers = {
"npm": "npm", "npm" : "npm",
"go": "go", "go" : "go",
"pypi": "pypi" "pypi" : "pypi"
} }
} }
``` ```
@ -42,13 +42,13 @@ Configure the Python pip package manager to fetch packages from Artifactory whil
```tf ```tf
module "jfrog" { module "jfrog" {
source = "registry.coder.com/modules/jfrog-oauth/coder" source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
jfrog_url = "https://example.jfrog.io" jfrog_url = "https://example.jfrog.io"
username_field = "email" username_field = "email"
package_managers = { package_managers = {
"pypi": "pypi" "pypi" : "pypi"
} }
} }
``` ```
@ -69,16 +69,16 @@ The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extensio
```tf ```tf
module "jfrog" { module "jfrog" {
source = "registry.coder.com/modules/jfrog-oauth/coder" source = "registry.coder.com/modules/jfrog-oauth/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
jfrog_url = "https://example.jfrog.io" jfrog_url = "https://example.jfrog.io"
username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username" username_field = "username" # If you are using GitHub to login to both Coder and Artifactory, use username_field = "username"
configure_code_server = true # Add JFrog extension configuration for code-server configure_code_server = true # Add JFrog extension configuration for code-server
package_managers = { package_managers = {
"npm": "npm", "npm" : "npm",
"go": "go", "go" : "go",
"pypi": "pypi" "pypi" : "pypi"
} }
} }
``` ```

@ -14,15 +14,15 @@ Install the JF CLI and authenticate package managers with Artifactory using Arti
```tf ```tf
module "jfrog" { module "jfrog" {
source = "registry.coder.com/modules/jfrog-token/coder" source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
jfrog_url = "https://XXXX.jfrog.io" jfrog_url = "https://XXXX.jfrog.io"
artifactory_access_token = var.artifactory_access_token artifactory_access_token = var.artifactory_access_token
package_managers = { package_managers = {
"npm": "npm", "npm" : "npm",
"go": "go", "go" : "go",
"pypi": "pypi" "pypi" : "pypi"
} }
} }
``` ```
@ -40,15 +40,15 @@ For detailed instructions, please see this [guide](https://coder.com/docs/v2/lat
```tf ```tf
module "jfrog" { module "jfrog" {
source = "registry.coder.com/modules/jfrog-token/coder" source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
jfrog_url = "https://YYYY.jfrog.io" jfrog_url = "https://YYYY.jfrog.io"
artifactory_access_token = var.artifactory_access_token # An admin access token artifactory_access_token = var.artifactory_access_token # An admin access token
package_managers = { package_managers = {
"npm": "npm-local", "npm" : "npm-local",
"go": "go-local", "go" : "go-local",
"pypi": "pypi-local" "pypi" : "pypi-local"
} }
} }
``` ```
@ -73,16 +73,16 @@ The [JFrog extension](https://open-vsx.org/extension/JFrog/jfrog-vscode-extensio
```tf ```tf
module "jfrog" { module "jfrog" {
source = "registry.coder.com/modules/jfrog-token/coder" source = "registry.coder.com/modules/jfrog-token/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
jfrog_url = "https://XXXX.jfrog.io" jfrog_url = "https://XXXX.jfrog.io"
artifactory_access_token = var.artifactory_access_token artifactory_access_token = var.artifactory_access_token
configure_code_server = true # Add JFrog extension configuration for code-server configure_code_server = true # Add JFrog extension configuration for code-server
package_managers = { package_managers = {
"npm": "npm", "npm" : "npm",
"go": "go", "go" : "go",
"pypi": "pypi" "pypi" : "pypi"
} }
} }
``` ```

@ -15,8 +15,8 @@ A module that adds Jupyter Notebook in your Coder template.
```tf ```tf
module "jupyter-notebook" { module "jupyter-notebook" {
source = "registry.coder.com/modules/jupyter-notebook/coder" source = "registry.coder.com/modules/jupyter-notebook/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```

@ -15,8 +15,8 @@ A module that adds JupyterLab in your Coder template.
```tf ```tf
module "jupyterlab" { module "jupyterlab" {
source = "registry.coder.com/modules/jupyterlab/coder" source = "registry.coder.com/modules/jupyterlab/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```

@ -13,8 +13,8 @@ Run a script on workspace start that allows developers to run custom commands to
```tf ```tf
module "personalize" { module "personalize" {
source = "registry.coder.com/modules/personalize/coder" source = "registry.coder.com/modules/personalize/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```

@ -56,9 +56,9 @@ slackme npm run long-build
```tf ```tf
module "slackme" { module "slackme" {
source = "registry.coder.com/modules/slackme/coder" source = "registry.coder.com/modules/slackme/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
auth_provider_id = "slack" auth_provider_id = "slack"
} }
``` ```
@ -72,11 +72,11 @@ slackme npm run long-build
```tf ```tf
module "slackme" { module "slackme" {
source = "registry.coder.com/modules/slackme/coder" source = "registry.coder.com/modules/slackme/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
auth_provider_id = "slack" auth_provider_id = "slack"
slack_message = <<EOF slack_message = <<EOF
👋 Hey there from Coder! $COMMAND took $DURATION to execute! 👋 Hey there from Coder! $COMMAND took $DURATION to execute!
EOF EOF
} }

@ -15,8 +15,8 @@ Uses the [Coder Remote VS Code Extension](https://github.com/coder/vscode-coder)
```tf ```tf
module "vscode" { module "vscode" {
source = "registry.coder.com/modules/vscode-desktop/coder" source = "registry.coder.com/modules/vscode-desktop/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
} }
``` ```
@ -27,9 +27,9 @@ module "vscode" {
```tf ```tf
module "vscode" { module "vscode" {
source = "registry.coder.com/modules/vscode-desktop/coder" source = "registry.coder.com/modules/vscode-desktop/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
folder = "/home/coder/project" folder = "/home/coder/project"
} }
``` ```

@ -28,11 +28,11 @@ module "vscode-web" {
```tf ```tf
module "vscode-web" { module "vscode-web" {
source = "registry.coder.com/modules/vscode-web/coder" source = "registry.coder.com/modules/vscode-web/coder"
version = "1.0.0" version = "1.0.0"
agent_id = coder_agent.example.id agent_id = coder_agent.example.id
install_dir = "/home/coder/.vscode-web" install_dir = "/home/coder/.vscode-web"
folder = "/home/coder" folder = "/home/coder"
accept_license = true accept_license = true
} }
``` ```

Loading…
Cancel
Save