Skip to content

config-ssh.md

Latest commit

 

History

History
141 lines (95 loc) · 4.83 KB

config-ssh.md

File metadata and controls

141 lines (95 loc) · 4.83 KB
Raw
title config-ssh
description Add an SSH Host entry for your workspaces "ssh workspace.coder"

Add an SSH Host entry for your workspaces "ssh workspace.coder"

Usage

coder config-ssh [flags]

Description

  - You can use -o (or --ssh-option) so set SSH options to be used for all your
workspaces:

     $ coder config-ssh -o ForwardAgent=yes

  - You can use --dry-run (or -n) to see the changes that would be made:

     $ coder config-ssh --dry-run

Options

--ssh-config-file
Type string
Environment $CODER_SSH_CONFIG_FILE
Default ~/.ssh/config

Specifies the path to an SSH config.

--coder-binary-path
Type string
Environment $CODER_SSH_CONFIG_BINARY_PATH

Optionally specify the absolute path to the coder binary used in ProxyCommand. By default, the binary invoking this command ('config ssh') is used.

-o, --ssh-option
Type string-array
Environment $CODER_SSH_CONFIG_OPTS

Specifies additional SSH options to embed in each host stanza.

-n, --dry-run
Type bool
Environment $CODER_SSH_DRY_RUN

Perform a trial run with no changes made, showing a diff at the end.

--use-previous-options
Type bool
Environment $CODER_SSH_USE_PREVIOUS_OPTIONS

Specifies whether or not to keep options from previous run of config-ssh.

--ssh-host-prefix
Type string
Environment $CODER_CONFIGSSH_SSH_HOST_PREFIX

Override the default host prefix.

--hostname-suffix
Type string
Environment $CODER_CONFIGSSH_HOSTNAME_SUFFIX

Override the default hostname suffix.

--wait
Type yes|no|auto
Environment $CODER_CONFIGSSH_WAIT
Default auto

Specifies whether or not to wait for the startup script to finish executing. Auto means that the agent startup script behavior configured in the workspace template is used.

--disable-autostart
Type bool
Environment $CODER_CONFIGSSH_DISABLE_AUTOSTART
Default false

Disable starting the workspace automatically when connecting via SSH.

--no-wildcard
Type bool
Environment $CODER_CONFIGSSH_NO_WILDCARD
Default false

Generate an individual host entry for each workspace instead of a wildcard host block. This allows third-party tools and SSH clients to discover workspaces by reading the config file.

--force-unix-filepaths
Type bool
Environment $CODER_CONFIGSSH_UNIX_FILEPATHS

By default, 'config-ssh' uses the os path separator when writing the ssh config. This might be an issue in Windows machine that use a unix-like shell. This flag forces the use of unix file paths (the forward slash '/').

-y, --yes
Type bool

Bypass confirmation prompts.