[Template] SSH Linux - Add support for deploying Coder on existing Linux systems (bare-metal installation)#605

IamTaoChen · 2025-12-15T06:59:42Z

Description

A draft that allow user connect existing linux system though coder by ssh

Type of Change

Template Information

Path:registry/IamTaoChen/templates/ssh-linux

Testing & Validation

Tests pass (bun test)
Code formatted (bun fmt)
Changes tested locally

Related Issues

IamTaoChen · 2025-12-17T09:51:15Z

I'm not sure if this is needed by others and suitable, so it's just a draft

matifali · 2025-12-17T10:48:31Z

Thanks for the contribution @IamTaoChen. Please move this to your own namespace. Follow the instructions here: https://coder.com/docs/about/contributing/templates

Copilot

Pull request overview

This PR introduces a new Coder template that enables provisioning of existing Linux systems as Coder workspaces via SSH. The template supports both password and SSH key authentication methods, allowing users to deploy the Coder agent on bare-metal or pre-existing Linux installations without creating new infrastructure.

Key Changes

SSH-based deployment template with configurable authentication (password or SSH key)
Dynamic application selection (VS Code Desktop, VS Code Web, Cursor)
Automated agent lifecycle management with startup/stop provisioners

Reviewed changes

Copilot reviewed 3 out of 5 changed files in this pull request and generated 6 comments.

Show a summary per file

File	Description
registry/IamTaoChen/templates/ssh-linux/main.tf	Terraform configuration defining SSH connection, agent deployment, and application modules
registry/IamTaoChen/templates/ssh-linux/README.md	Template documentation covering prerequisites, architecture, parameters, and usage
registry/IamTaoChen/README.md	Author profile and template registry metadata
registry/IamTaoChen/.images/avatar.png	Author avatar image (binary)
.icons/linux.svg	Linux/Tux icon for template display

Copilot · 2025-12-17T11:54:21Z

registry/IamTaoChen/templates/ssh-linux/README.md

@@ -0,0 +1,66 @@
+---
+display_name: Deploy Coder on existing Linux System
+description: Provision an existing Linux system as a by deploying the Coder agent via SSH with this example template.


Grammatical error: "as a by deploying" should be "as a workspace by deploying" or simply "by deploying".

Copilot · 2025-12-17T11:54:21Z

registry/IamTaoChen/templates/ssh-linux/README.md

+
+1. Create a new workspace in Coder using this template.
+2. Fill in the parameters with your Linux system's details.
+3. Start the workspace—Coden will connect via SSH and deploy the agent.


Typo: "Coden" should be "Coder".

Copilot · 2025-12-17T11:54:22Z

registry/IamTaoChen/README.md

+
+### ssh-linux
+
+Provision an existing Linux system as a by deploying the Coder agent via SSH with this example template.


Grammatical error: "as a by deploying" should be "as a workspace by deploying" or simply "by deploying".

Copilot · 2025-12-17T11:54:22Z

registry/IamTaoChen/templates/ssh-linux/main.tf

+resource "random_integer" "vs_code_port"{
+ min = 54000
+ max = 55999
+}


The random_integer resource for vs_code_port is defined but only conditionally used when "VS Code Web" is selected. Consider moving this resource inside a conditional count or using a dynamic approach to avoid creating unnecessary resources when VS Code Web is not selected.

Copilot · 2025-12-17T11:54:22Z

registry/IamTaoChen/templates/ssh-linux/main.tf

+ connection{
+ type = "ssh"
+ host = data.coder_parameter.host.value
+ user = data.coder_parameter.username.value
+ port = data.coder_parameter.port.value
+ password = local.ssh_password
+ private_key = local.ssh_private_key
+ timeout = "5m"


Security concern: SSH credentials (password or private key) are stored in Terraform state and passed as environment variables. Consider adding documentation warning users about this security implication, especially for production use. Users should be aware that these credentials will be stored in the Terraform state file.

I want to use the ssh-key pair which generate by coder but I don't know how to read the private_key

Copilot · 2025-12-17T11:54:23Z

registry/IamTaoChen/templates/ssh-linux/main.tf

+ " sleep 5",
+ " kill -KILL \"$PID\" || true",
+ " fi",
+ " rm -r ${local.coder_cache_dir}",


Potential bug: The agent cleanup on stop removes the entire cache directory with rm -r ${local.coder_cache_dir}. This will delete debug logs and potentially other workspace-specific data. Consider only removing the PID file or being more selective about what gets cleaned up, especially if users want to preserve logs for troubleshooting.

I want to rm all. this debug.log is valid while deploying failed

IamTaoChen · 2025-12-17T11:56:35Z

After #606 merge, can add KasmVNC into apps

Copilot

Pull request overview

Copilot reviewed 3 out of 5 changed files in this pull request and generated 4 comments.

Copilot · 2025-12-17T12:13:58Z

registry/IamTaoChen/templates/ssh-linux/main.tf

+ order = 1
+ validation{
+ regex = "^[a-zA-Z0-9:.%\\-]+$"
+ error = "Please enter a valid hostname, IPv4, or IPv6 address."


The validation error message could be more helpful by providing examples of valid formats. Consider updating to: "Please enter a valid hostname, IPv4, or IPv6 address. Examples: example.com, 192.168.1.1, or fe80::1"
Suggested change
error="Please enter a valid hostname, IPv4, or IPv6 address."
error="Please enter a valid hostname, IPv4, or IPv6 address. Examples: example.com, 192.168.1.1, or fe80::1"

Copilot · 2025-12-17T12:13:58Z

registry/IamTaoChen/templates/ssh-linux/main.tf

+ " kill -TERM \"$PID\" || true",
+ " sleep 5",
+ " kill -KILL \"$PID\" || true",


The kill command sequence may fail silently if the process doesn't exist or has already exited. The kill -0 check is good, but between the check and the actual kill, the process could exit. Additionally, kill -KILL after a 5-second sleep may be too aggressive. Consider adding error handling and potentially increasing the grace period, or checking if the process is still running before sending SIGKILL.
Suggested change
" kill -TERM \"$PID\" || true",
" sleep 5",
" kill -KILL \"$PID\" || true",
" kill -TERM \"$PID\" 2>/dev/null || echo \"Warning: failed to send SIGTERM to process $PID\" >&2",
" for i in $(seq 1 10); do",
" if ! kill -0 \"$PID\" 2>/dev/null; then",
" break",
" fi",
" sleep 1",
" done",
" if kill -0 \"$PID\" 2>/dev/null; then",
" kill -KILL \"$PID\" 2>/dev/null || echo \"Warning: failed to send SIGKILL to process $PID\" >&2",
" fi",

Copilot · 2025-12-17T12:13:59Z

registry/IamTaoChen/templates/ssh-linux/README.md

+
+1. Create a new workspace in Coder using this template.
+2. Fill in the parameters with your Linux system's details.
+3. Start the workspace—Codenr will connect via SSH and deploy the agent.


Typographical error: "Codenr" should be "Coder".
Suggested change
3. Start the workspace—Codenr will connect via SSH and deploy the agent.
3. Start the workspace—Coder will connect via SSH and deploy the agent.

Copilot · 2025-12-17T12:13:59Z

registry/IamTaoChen/templates/ssh-linux/main.tf

+ "cat > $coder_sh << 'EOF'",
+ "${coder_agent.main.init_script}",
+ "EOF",
+ "chmod +x $coder_sh",
+ "echo \"$(date) : create $coder_sh\" >> ${local.coder_cache_dir}/debug.log",
+ "nohup env CODER_AGENT_TOKEN='${coder_agent.main.token}' $coder_sh > $log_file 2>&1 &",


Security concern: The CODER_AGENT_TOKEN is being passed as a plain environment variable in the remote-exec command. This exposes the token in process listings and logs on the remote system. Consider using a more secure method to pass the token, such as writing it to a file with restricted permissions first, or using Coder's built-in secure token handling mechanisms.
Suggested change
"cat > $coder_sh << 'EOF'",
"${coder_agent.main.init_script}",
"EOF",
"chmod +x $coder_sh",
"echo \"$(date) : create $coder_sh\" >> ${local.coder_cache_dir}/debug.log",
"nohup env CODER_AGENT_TOKEN='${coder_agent.main.token}' $coder_sh > $log_file 2>&1 &",
"token_file=${local.coder_cache_dir}/coder_token",
"cat > $coder_sh << 'EOF'",
"${coder_agent.main.init_script}",
"EOF",
"chmod +x $coder_sh",
"umask 177 && printf '%s' '${coder_agent.main.token}' > \"$token_file\"",
"chmod 600 \"$token_file\"",
"echo \"$(date) : create $coder_sh and token file $token_file\" >> ${local.coder_cache_dir}/debug.log",
"nohup sh -c 'export CODER_AGENT_TOKEN=$(cat \"$1\"); exec \"$2\"' sh \"$token_file\"\"$coder_sh\" > $log_file 2>&1 &",

IamTaoChen added 3 commits December 15, 2025 14:47

try to deploy coder on existed linux system
0976d62

fix deploy scripts
32ebb21

make display_apps.vscode_insiders =false
17bb5cf

IamTaoChen changed the title ~~try to deploy coder on existed linux system~~[Template] SSH Linux - Add support for deploying Coder on existing Linux systems (bare-metal installation)Dec 15, 2025

IamTaoChen added 3 commits December 16, 2025 03:18

add count for deploy_coder_agent
cafa17a

kill agent while workspace stopped
de7bfff

fix count
1cc00d2

relocation
a5df5b7

matifali requested a review from Copilot December 17, 2025 11:50

Copilotstarted reviewing on behalf of matifali December 17, 2025 11:50 View session

run 'bun fmt'
a6483f1

IamTaoChen marked this pull request as ready for review December 17, 2025 11:53

Merge branch 'main' into ssh-linux
235cd8d

CopilotAI reviewed Dec 17, 2025
View reviewed changes

IamTaoChen added 2 commits December 17, 2025 19:59

fix spell
4561e43

add 'Security Considerations' into README.md
025c544

IamTaoChen requested a review from Copilot December 17, 2025 12:08

Copilotstarted reviewing on behalf of IamTaoChen December 17, 2025 12:09 View session

CopilotAI reviewed Dec 17, 2025
View reviewed changes

optimize msg
17497a6

matifali requested a review from DevelopmentCats December 17, 2025 13:16


		### ssh-linux

		Provision an existing Linux system as a by deploying the Coder agent via SSH with this example template.

	error="Please enter a valid hostname, IPv4, or IPv6 address."
	error="Please enter a valid hostname, IPv4, or IPv6 address. Examples: example.com, 192.168.1.1, or fe80::1"

-" kill -TERM \"$PID\" || true",
-" sleep 5",
-" kill -KILL \"$PID\" || true",
+" kill -TERM \"$PID\" 2>/dev/null || echo \"Warning: failed to send SIGTERM to process $PID\" >&2",
+" for i in $(seq 1 10); do",
+" if ! kill -0 \"$PID\" 2>/dev/null; then",
+" break",
+" fi",
+" sleep 1",
+" done",
+" if kill -0 \"$PID\" 2>/dev/null; then",
+" kill -KILL \"$PID\" 2>/dev/null || echo \"Warning: failed to send SIGKILL to process $PID\" >&2",
+" fi",

	3. Start the workspace—Codenr will connect via SSH and deploy the agent.
	3. Start the workspace—Coder will connect via SSH and deploy the agent.

[Template] SSH Linux - Add support for deploying Coder on existing Linux systems (bare-metal installation)#605

Are you sure you want to change the base?

[Template] SSH Linux - Add support for deploying Coder on existing Linux systems (bare-metal installation) #605

Conversation

IamTaoChen commented Dec 15, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Type of Change

Template Information

Testing & Validation

Related Issues

Uh oh!

IamTaoChen commented Dec 17, 2025

Uh oh!

matifali commented Dec 17, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Key Changes

Reviewed changes

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChenDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChenDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChenDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChenDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChenDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChen commented Dec 17, 2025

Uh oh!

CopilotAI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChenDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

IamTaoChenDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

CopilotAIDec 17, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

IamTaoChen commented Dec 15, 2025•
edited
Loading