Skip to content

Commit 8189ede

Browse files
Copilotsgbaird
andcommitted
Move VS Code Configuration as subsection under General Setup and clarify device types
Co-authored-by: sgbaird <[email protected]>
1 parent 3ffd8f2 commit 8189ede

File tree

1 file changed

+14
-16
lines changed

1 file changed

+14
-16
lines changed

docs/tailscale-setup.md

Lines changed: 14 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
[Tailscale](https://tailscale.com/) is a "mesh VPN" that allows secure access to devices across different networks. It simplifies remote access and management of devices.
44

5-
The following covers [tailscale setup](#general-setup-instructions) for general-purpose machines (Linux, macOS, Windows, RPi OS) and SSH access, [instructions for remote desktop and SSH](#remote-desktop-and-ssh-on-windows) on Windows, [VS Code configuration](#vs-code-configuration) tips, and [setup for an OT-2 environment](#installing-and-auto-starting-tailscale-on-ot-2-opentrons) which requires special installation steps.
5+
The following covers [tailscale setup](#general-setup-instructions) for general-purpose Linux, macOS, and Raspberry Pi devices with SSH access, [instructions for remote desktop and SSH](#remote-desktop-and-ssh-on-windows) on Windows devices, and [setup for an OT-2 environment](#installing-and-auto-starting-tailscale-on-ot-2-opentrons) which requires special installation steps.
66

77
## General Setup Instructions
88

@@ -59,7 +59,20 @@ You also might want to ["disable key expiry"](https://tailscale.com/kb/1028/key-
5959

6060
![image](https://github.com/user-attachments/assets/23ad57b6-e39f-4694-86ee-7c5d685c763f)
6161

62+
### VS Code Configuration
6263

64+
Also, consider updating the default SSH username in VS Code settings (Ctrl+,), since it will be your PC's username by default (which may not correspond to the username on the device).
65+
66+
Within the tailscale sidebar interface, I found it useful to try to connect to the terminal first, go through the prompts, then click the "Attach VS Code" button and follow any prompts again. I've had some issues (https://github.com/AccelerationConsortium/ac-training-lab/issues/184#issuecomment-2719179967) with getting VS Code errors when trying to go directly to "Attach VS Code" for a new device. If you click "details" while it's loading, you will likely find that it's waiting on you to authenticate by accessing a particular link.
67+
68+
Additional resources:
69+
- https://www.reddit.com/r/Tailscale/comments/11c69q5/how_can_i_authenticate_a_headless_device/
70+
- https://tailscale.com/kb/1174/install-debian-bookworm
71+
- https://forums.raspberrypi.com/viewtopic.php?t=374609
72+
- https://tailscale.com/kb/1265/vscode-extension
73+
- https://tailscale.com/learn/how-to-ssh-into-a-raspberry-pi
74+
75+
---
6376
## Remote Desktop and SSH on Windows
6477

6578
[Tailscale SSH](https://tailscale.com/kb/1193/tailscale-ssh) isn't directly supported on Windows, and SSH on Windows machines can get a bit messy. However, you can still use Tailscale to set up remote desktop access or configure OpenSSH for VS Code compatibility.
@@ -148,21 +161,6 @@ _Based on https://github.com/AccelerationConsortium/ac-training-lab/issues/376_
148161

149162
---
150163

151-
## VS Code Configuration
152-
153-
Also, consider updating the default SSH username in VS Code settings (Ctrl+,), since it will be your PC's username by default (which may not correspond to the username on the RPi).
154-
155-
Within the tailscale sidebar interface, I found it useful to try to connect to the terminal first, go through the prompts, then click the "Attach VS Code" button and follow any prompts again. I've had some issues (https://github.com/AccelerationConsortium/ac-training-lab/issues/184#issuecomment-2719179967) with getting VS Code errors when trying to go directly to "Attach VS Code" for a new device. If you click "details" while it's loading, you will likely find that it's waiting on you to authenticate by accessing a particular link.
156-
157-
Additional resources:
158-
- https://www.reddit.com/r/Tailscale/comments/11c69q5/how_can_i_authenticate_a_headless_device/
159-
- https://tailscale.com/kb/1174/install-debian-bookworm
160-
- https://forums.raspberrypi.com/viewtopic.php?t=374609
161-
- https://tailscale.com/kb/1265/vscode-extension
162-
- https://tailscale.com/learn/how-to-ssh-into-a-raspberry-pi
163-
164-
---
165-
166164
## Installing and Auto-starting Tailscale on OT-2 (Opentrons)
167165

168166
**Note:** OT-2 runs a minimal [Buildroot-based system](https://github.com/Opentrons/buildroot) with a read-only root filesystem and limited network utilities. This guide works within those constraints.

0 commit comments

Comments
 (0)