https://filebrowser.org

We should document the behavior when we update a module in such a way that it breaks existing templates. Examples are.

1. Adding/removing/renaming required variables.
2. Updating default values of any variable.
3. etc

Suggestions

• use versioning, so that if someone uses

module "jfrog" {
    source                   = "https://registry.coder.com/modules/jfrog"
	version                  = "1.0"
    agent_id                 = coder_agent.main.id
    jfrog_url                = "https://YYY.jfrog.io"
    ...
}

• more ideas

cc: @bpmct, @kylecarbs

A module that adds a discord community link as an external coder_app.

Allow specifying a custom display_name

I am looking for a way to modify where the filebrowser.db is stored.
Currently, it looks like it is saving in my working dir.

I would like it to save in ~/.config/... but it is saving as /workspace/repo/filebrowser.db, which is my coder_agent.dir.

I think this should be the relevant configuration from my template for this issue.

locals {
  folder_name = try(trimsuffix(element(split("/", data.coder_parameter.repo.value), length(split("/", data.coder_parameter.repo.value)) - 1), ".git"), "")
  repo_owner_name = try(element(split("/", data.coder_parameter.repo.value), length(split("/", data.coder_parameter.repo.value)) - 2), "")
  repo_host = try(one(regex("^(?:https?:\\/\\/)?(?:[^@\\/\\n]+@)?(?:www\\.)?([^:\\/\\n]+)", data.coder_parameter.repo.value)), "")
  root_dir = "/workspace"
  project_dir = "${local.root_dir}/${local.folder_name}"
}

resource "coder_agent" "main" {
  arch                   = data.coder_provisioner.me.arch
  os                     = data.coder_provisioner.me.os
  dir                    = local.project_dir
  startup_script_timeout = 180
}

# A file browser for your workspace
module "filebrowser" {
  source = "https://registry.coder.com/modules/filebrowser"
  agent_id = coder_agent.main.id
  folder = local.root_dir
}

Test each of the submitted modules individually and ensure screenshots and examples have been added

• code-server @kylecarbs I assume you have tested code-server
  • test
  • screenshots
  • examples
• vscode-server
  • test
  • screenshots
  • examples
• JupyterLab
  • test
  • screenshots
  • examples
• KasmVNC
  • test
  • screenshots
  • examples
• GCP regions
  • test
  • screenshots
  • examples
• AWS regions
  • test
  • screenshots
  • examples
• Azure regions
  • test
  • screenshots
  • examples
• Fly.io regions
  • test
  • screenshots
  • examples
• VS Code Desktop
  • test
  • screenshots
  • examples
• JetBrains Gateway
  • test
  • screenshots
  • examples
• JFrog
  • test
  • screenshots
  • examples
• Personalize
  • test
  • screenshots
  • examples
• Dotfiles
  • test
  • screenshots
  • examples
• git clone
  • test
  • screenshots
  • examples
• git config
  • test
  • screenshots
  • examples

cc: @bpmct, @stirby, @kylecarbs, please add/update the list if you contribute

We already have them in gcp-linux

As discussed in #55, we should have a versioning system to control breaking changes and new behavior of modules.

Some coder_apps can not be hosted on a sub path and require subdomain = true. We should add a property to metadata to filter those apps on registry.coder.com
examples,

1. VS Code Web
2. JupyterLab
   cc: @bpmct @kylecarbs

Must have

• coder_app to open workspace in Gateway (coder/jetbrains-coder#289)

Should have

• Variables/icons for various IDEs

@matifali feel free to expand

• Test
• Add default
• Allow choosing a subset of regions

Example template to enable RDP on Windows and expose a link with instructions to connect (external coder_app to point to the readme of the repo).

Down the road, we can improve this by improving in-product features such as coder_app and template READMEs (making them extensible via modules).

• Test on AWS Windows
• Test on Azure Windows
• Test on GCP Windows

https://neko.m1k1o.net/#/

A module that can automatically login a user to coder deployment inside a workspace.
We have a nice workaround here

# Automatically authenticate the user if they are not already logged in
if ! coder list >/dev/null 2>&1; then
  set +x; coder login --token=$CODER_USER_TOKEN --url=$CODER_DEPLOYMENT_URL
else
  echo "You are already authenticated with Coder"
fi

• Test coder_parameter with and without default
• Test all example cases
• Test coder_script based modules
• Test if coder_apps are healthy and accessible.

We can have a test deployment for testing modules and use ci to create and update templates using modules and test using a workspace.

Describe the contribution process for community modules.

This is currently a part of README.md

cc: @kylecarbs and @bpmct for suggestions to move it to a separate file.

After coder/terraform-provider-coder#181, a Full Name field is available under data.coder_workspace.me.owner_name. We can use this to set git config --user.name ${data.coder_workspace.me.owner_name} in git-config module.

This needs a minimum version of Coder v2.7.0 and coder-terraform-provider v0.13.0. We need to check if the Coder is on the correct version.

I am currently getting the following issue when trying to install multiple extension using the code-server module:

Installing code-server! 
################################################
🥳 code-server has been installed in /tmp/code-server 
🧩 Installing extension ms-azuretools.vscode-docker,codezombiech.gitignore... Extension 'ms-azuretools.vscode-docker,codezombiech.gitignore' not found. Make sure you use the full extension ID, including the publisher, e.g.: ms-dotnettools.csharp Failed Installing Extensions: ms-azuretools.vscode-docker,codezombiech.gitignore

my module terraform code is the following:

module "code-server" { 
    source = "https://registry.coder.com/modules/code-server" 
    agent_id = coder_agent.main.id 
    settings = { "workbench.colorTheme" = "Default Dark+" } 
    extensions = [ "ms-azuretools.vscode-docker", "codezombiech.gitignore" ]
 }

Specifically, I am looking to output the DOTFILES_URI to reference as metadata.

Docs for reference: https://saturncloud.io/blog/terraform-how-to-output-a-field-from-a-module/

Hi,
I am using the code server module and the settings are not being ported over to the code-server user space
Here is the tf module for my template:

module "code-server" { 
  source = "https://registry.coder.com/modules/code-server" 
  agent_id = coder_agent.main.id 
  folder = "/home/coder/workspace/repo" 
  settings = { "workbench.colorTheme" = "Default Light Modern", "workbench.iconTheme" = "vscode-icons", "files.autoSave" = "onFocusChange", "editor.rulers" = "[80,120]", "update.mode" = "none", } 
  extensions = [ "ms-azuretools.vscode-docker", "sugatoray.vscode-git-extension-pack", "golang.Go", "ms-python.python", "redhat.vscode-yaml", "timonwong.shellcheck", "garlicbreadcleric.pandoc-markdown-syntax", "zaaack.markdown-editor", "hashicorp.terraform", "ms-kubernetes-tools.vscode-kubernetes-tools" ]
 }

After a little investigating into this script: https://github.com/coder/modules/blob/main/code-server/run.sh
Looking at the logs of my workspace "⚙️ Creating settings file..." is never outputted which means

if [ ! -f ~/.local/share/code-server/Machine/settings.json ]; then

is returning true.

Not sure why this is as when I destroy the workspace it should be gone and recreating it still causes this issue.

If a module relies on a new feature in Coder, we should have a way to detect/prevent it from being used on old versions

Add AWS regions with

• Friendly names
• Location flag emojis as icon

Hi,

I created the 2 exoscale modules for the registry.
I set verified to false because I wasn´t sure how to verify.

Is is possible to verify a module?

Moreover you have a bug on the registry website.
In the modules overview our exoscale modules are not verified.
But in the detailed module view it is. It seems that you set a condition wrong there.

• README.md
  • Frontmatter
  • Introduction
  • Examples
  • Screenshots
• run.sh (optional) [required for modules which uses coder_script]
• main.tf

This will remove the requirement for an admin-level access token in Artifactory. We can use coder/coder#9996 + JFrog's OAuth "integrations"

Context: coder/coder#9116

How can we specify the order in which modules run?

For example, I want the Personalize module to run after my Dotfiles have been fully cloned as I have a personalization script in my dotfiles.

Discussion started here: https://discord.com/channels/747933592273027093/1157627766607454288

Basically, the git-clone module doesn't take into account that a volume might have already generated the directory path and with such a volume in place, the cloning of the repo will never happen.

The advantages with using a volume are a workspace (container) can be stopped and restarted ( to be updated or to save resources or just to get a fresh container running) and the dev can basically continue where she left off. Without a volume, the cloning, installing, building, etc. etc. all has to happen again, before the dev can continue. Also, if the dev had made changes to the repo and didn't push them to origin, before restarting the workspace, all changes would be lost.

I'll put in a PR to fix.

Scott

Create a module that installs kasmvnc if it doesn't exist and starts it.

Must have

• coder_app
• coder_script (coder/coder#9584)

Nice to have

• Variable to specify kasmvnc version
• Variable to skip install (assumes it's already in the image)
• Variable for path of kasmvnc (e.g. in home dir?)

References

• A generic script I made to install kasmVNC on an Ubuntu Focal VM: https://gist.github.com/bpmct/4e51d7092089f278c91f53e344749b6c
• KasmVNC Kubernetes templates: https://github.com/sharkymark/v2-templates

Basically we should replicate what we do for our dogfood template for dotfiles

• coder_parameter
• coder_script

The following READMEs could benefit from screenshots

• VS Code Web (with copilot or live share in browser)
• AWS Regions
• Azure Regions
• kasmVNC
• Juypyter
• GCP Region
• Fly Region
• JFrog
• Personalize
• VS Code Desktop

Script to detect if user.name and user.email is set. If not, use the username and email from the Coder user

Install and authenticate the JFrog CLI using the user's email!

This parameter changed names and is no longer matching as per the documentation.

git clone module to detect if repo exists and clone it

Nice to have

• Support forking instead of clone with gh CLI (we could support other clouds down the road).

This is different than code-server: code serve-web:

• Variable to accept license (user must put true as a variable, default is false)
• coder_app
• coder_script

Figuring out all of the flag emojis and friendly names for GCP regions is difficult. Let's make a module that has all of these

• Output with local of all modules
• coder_parameter

Should have

• User can specify via a module variable a subset of regions they want to support ["us-east-1", "us-east-2"]
• User can disable the parameter and just consume the local? idk why they would want this but why not

While testing I noticed that

• JetBrains Gateway module fails if no default is set.
• Azure regions module sets the default region to eastus if no default is set.
• AWS regions module sets the default region to us-east-1 if no default is set.

Ideal behavior should be that setting the default to null should set the default of coder_paramter to null so that the user is forced to choose a value from the list.

Create a general template for modules. This will probably require some ideation as we add several. This is just a dump of some initial ideas, but we can consider this issue closed when we are happy with a template that works across 5-10 modules.

• Requirements and prerequisites for module (e.g. OS, architecture)
• Frontmatter with tags (e.g. ide)
• Screenshots section or GIF demo
• Compatible templates?

Use city names for each region, like GCP and AWS regions modules.

It would be nice if we can list city names for each region. e.g.,

1. Europe (France)
2. Europe (Netherlands)
3. Australia (Sydney)
4. Australia (Melbourne)

Reference:
https://azure.microsoft.com/en-us/explore/global-infrastructure/geographies/#geographies

Module: vault-github
Coder Version: 2.4.0
Vault Version: 1.15.3
Issue: Error with ghu_ prefixed GitHub App token during workspace startup; ghp_ personal access tokens work fine.

Error Message on Workspace Startup:

Error authenticating: Error making API request.
URL: PUT http://192.168.1.105:8200/v1/auth/github/login
Code: 500. Errors:
* user is not part of required org

Configuration:

• Installed and configured the vault-github module in a Coder template.
• Engaged GitHub authentication and established GitHub organization in Vault settings.

Discovery:

• Authentication with GitHub App tokens (ghu_ prefix) fails upon workspace initialization.
• Authentication using personal access tokens (ghp_ prefix) performs correctly.

Steps to Reproduce:

1. Set up the vault-github module in Coder template.

   module "vault" {
     source     = "https://registry.coder.com/modules/vault-github"
     agent_id   = coder_agent.dev.id
     vault_addr = "http://192.168.1.105:8200"
     coder_github_auth_id   = "primary-github"
   }

2. Activated GitHub authentication and set the GitHub organization in Vault.

   vault auth enable github
   vault write auth/github/config organization=photonq-org

3. Encountered an error when starting the workspace using a GitHub App token.

   vault login -method=github token=ghu_MyGitHubAppAccessToken

4. Successfully logged in with a personal access token.

   vault login -method=github token=ghp_MyPersonalAccessToken

Question:
Is additional configuration required within HashiCorp Vault to enable authentication using GitHub App tokens (ghu_ prefix) as they produce an error stating the user is not part of the required organization?

Add fmt and lint checks and related make commands.

Would probably require a rustdesk server

Must have

• Auto-installs Jupyter with pip (if not installed)
• Starts JupyterLab
• coder_app
• coder_script

Should have

• Variable to specify version
• Variable to specify whether they want notebook or lab lets create a separate module for legacy Jupyter notebooks

https://jupyter-notebook.readthedocs.io/en/stable/

This can happen if data coder_external_auth is providing an empty token.
Related coder/coder#11367

Open question: Can we reduce complexity of exectrace templates via a module? https://coder.com/docs/v2/latest/templates/process-logging

We should do this so all users are using the latest version of modules.
depends on #122

I am cloning a repo with the git-clone module.

module "git-clone" {
 source = "https://registry.coder.com/modules/git-clone"
 agent_id = coder_agent.main.id
 url = https://git-domain/test-repo
 path = "/home/coder/workspace" 
}

Instead of the code being cloned to /home/coder/workspace/ I want it to be cloned to /home/coder/workspace/test-repo.

Possible solution would be to change the tf here: https://github.com/coder/modules/blob/main/git-clone/main.tf

Maybe creating an optional var enable_basename and if set to true does something like this:
CLONE_PATH : var.path != "" ? join("/", [var.path, basename(var.url)]) : join("/", ["~", basename(var.url)]),

A module that adds an external coder_app with a slack workspace/channel link.

It should allow specifying a custom app dispay_name