8000 Update SSH config instructions and examples · coder/coder@9a80344 · GitHub
[go: up one dir, main page]
Skip to content

Commit 9a80344

Browse files
matifalimatifali
committed
Update SSH config instructions and examples
Change the SSH host entry format from "ssh coder.workspace" to "ssh workspace.coder" across CLI and documentation. This aligns the instructions with the updated domain structure, ensuring users follow the correct syntax when configuring and connecting via SSH. Additionally, update the SSH button component to use the workspace owner's name for generating the SSH command, further enhancing user interaction.
1 parent a19539c commit 9a80344

File tree

9 files changed

+12
-10
lines changed

9 files changed

+12
-10
lines changed

‎cli/configssh.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -235,7 +235,7 @@ func (r *RootCmd) configSSH() *serpent.Command {
235235
cmd := &serpent.Command{
236236
Annotations: workspaceCommand,
237237
Use: "config-ssh",
238-
Short: "Add an SSH Host entry for your workspaces \"ssh coder.workspace\"",
238+
Short: "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",
239239
Long: FormatExamples(
240240
Example{
241241
Description: "You can use -o (or --ssh-option) so set SSH options to be used for all your workspaces",

‎cli/testdata/coder_--help.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ SUBCOMMANDS:
1818
completion Install or update shell completion scripts for the
1919
detected or chosen shell.
2020
config-ssh Add an SSH Host entry for your workspaces "ssh
21-
coder.workspace"
21+
workspace.coder"
2222
create Create a workspace
2323
delete Delete a workspace
2424
dotfiles Personalize your workspace by applying a canonical

‎cli/testdata/coder_config-ssh_--help.golden

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ coder v0.0.0-devel
33
USAGE:
44
coder config-ssh [flags]
55

6-
Add an SSH Host entry for your workspaces "ssh coder.workspace"
6+
Add an SSH Host entry for your workspaces "ssh workspace.coder"
77

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

‎docs/manifest.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1091,7 +1091,7 @@
10911091
},
10921092
{
10931093
"title": "config-ssh",
1094-
"description": "Add an SSH Host entry for your workspaces \"ssh coder.workspace\"",
1094+
"description": "Add an SSH Host entry for your workspaces \"ssh workspace.coder\"",
10951095
"path": "reference/cli/config-ssh.md"
10961096
},
10971097
{

‎docs/reference/cli/config-ssh.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/reference/cli/index.md

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎docs/tutorials/testing-templates.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -103,9 +103,8 @@ jobs:
103103
- name: Create a test workspace and run some example commands
104104
run: |
105105
coder create -t $TEMPLATE_NAME --template-version ${{ steps.name.outputs.version_name }} test-${{ steps.name.outputs.version_name }} --yes
106-
coder config-ssh --yes
107106
# run some example commands
108-
ssh coder.test-${{ steps.name.outputs.version_name }} -- make build
107+
coder ssh test-${{ steps.name.outputs.version_name }} -- make build
109108
110109
- name: Delete the test workspace
111110
if: always()

‎site/src/modules/resources/AgentRow.tsx

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -196,6 +196,7 @@ export const AgentRow: FC<AgentRowProps> = ({
196196
<AgentSSHButton
197197
workspaceName={workspace.name}
198198
agentName={agent.name}
199+
workspaceOwnerName={workspace.owner_name}
199200
/>
200201
)}
201202
{proxy.preferredWildcardHostname !== "" &&

‎site/src/modules/resources/SSHButton/SSHButton.tsx

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,15 +22,17 @@ import { docs } from "utils/docs";
2222
interface AgentSSHButtonProps {
2323
workspaceName: string;
2424
agentName: string;
25+
workspaceOwnerName: string;
2526
}
2627

2728
export const AgentSSHButton: FC<AgentSSHButtonProps> = ({
2829
workspaceName,
2930
agentName,
31+
workspaceOwnerName,
3032
}) => {
3133
const paper = useClassName(classNames.paper, []);
3234
const { data } = useQuery(deploymentSSHConfig());
33-
const sshPrefix = data?.hostname_prefix;
35+
const sshSuffix = data?.hostname_suffix;
3436

3537
return (
3638
<Popover>
@@ -58,7 +60,7 @@ export const AgentSSHButton: FC<AgentSSHButtonProps> = ({
5860
/>
5961
<SSHStep
6062
helpText="Connect to the agent:"
61-
codeExample={`ssh ${sshPrefix}${workspaceName}.${agentName}`}
63+
codeExample={`ssh ${workspaceName}.${agentName}.${workspaceOwnerName}.${sshSuffix}`}
6264
/>
6365
</Stack>
6466
</ol>

0 commit comments

Comments
 (0)
0