Skip to content

Commit 7a586bb

Browse files
daharoniclaude
andcommitted
Clarify bench naming in getting started guide
Add a dedicated section explaining where the bench name is used (hostname, config, runner name, runner labels, dashboard) and guidance on picking unique, descriptive names. Replace generic hil-bench-01 examples with samd51-bench-01 throughout. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
1 parent 2ff7516 commit 7a586bb

1 file changed

Lines changed: 32 additions & 8 deletions

File tree

docs/getting-started.md

Lines changed: 32 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -43,10 +43,34 @@ computer (available for Windows, macOS, and Linux).
4343
5. Click **Choose Storage** → select your SD card.
4444
6. Click **Next**, then click **Edit Settings** when prompted.
4545

46-
### 2c. Customize OS settings (important)
46+
### 2c. Choose a bench name
47+
48+
Before flashing, pick a **unique bench name** for this Pi. The name is used in several
49+
places:
50+
51+
- **Pi hostname** — so you can `ssh` to it by name (e.g. `ssh pi@my-bench.local`)
52+
- **`bench_name`** in `/etc/hil-bench/config.yaml` — identifies this bench in logs and
53+
health reports
54+
- **GitHub Actions runner name** — how the runner appears in your org's runner list
55+
- **Runner labels** — the name is split on hyphens and added as labels (e.g.
56+
`samd51-bench-03` adds labels `samd51`, `bench`, `03`)
57+
- **Supabase dashboard** — if using the optional dashboard, this is the bench identifier
58+
59+
Pick something descriptive that won't collide with other benches. Good examples:
60+
61+
| Name | When to use |
62+
|------|-------------|
63+
| `samd51-bench-01` | First SAMD51 bench |
64+
| `miniscope-hil-east` | Location-based naming |
65+
| `dev-bench-alice` | Personal dev bench |
66+
67+
Avoid generic names like `hil-bench-01` — if your lab has multiple benches, they'll
68+
collide.
69+
70+
### 2d. Customize OS settings (important)
4771

4872
In the **General** tab:
49-
- **Set hostname**: e.g. `hil-bench-01`
73+
- **Set hostname**: use your chosen bench name (e.g. `samd51-bench-01`)
5074
- **Set username and password**: e.g. `pi` / pick a strong password
5175
- **Configure wireless LAN**: enter your WiFi SSID and password (skip if using Ethernet)
5276
- **Set locale settings**: your timezone and keyboard layout
@@ -71,8 +95,8 @@ Click **Save**, then **Yes** to flash. Wait for it to finish and verify.
7195
From your computer:
7296

7397
```bash
74-
# If you set the hostname to hil-bench-01:
75-
ping hil-bench-01.local
98+
# If you set the hostname to samd51-bench-01:
99+
ping samd51-bench-01.local
76100

77101
# Or scan your network (install nmap if needed):
78102
nmap -sn 192.168.1.0/24 | grep -i raspberry
@@ -84,13 +108,13 @@ Pi's IP address.
84108
### SSH in
85109

86110
```bash
87-
ssh pi@hil-bench-01.local
111+
ssh pi@samd51-bench-01.local
88112
# Enter the password you set in Pi Imager
89113
```
90114

91115
> **Tip**: If you plan to SSH frequently, copy your public key now:
92116
> ```bash
93-
> ssh-copy-id pi@hil-bench-01.local
117+
> ssh-copy-id pi@samd51-bench-01.local
94118
> ```
95119
96120
---
@@ -172,15 +196,15 @@ cd hil-bench-controller
172196
Without GitHub Actions runner (you can add it later):
173197
174198
```bash
175-
sudo ./bootstrap/bootstrap_pi.sh hil-bench-01
199+
sudo ./bootstrap/bootstrap_pi.sh samd51-bench-01
176200
```
177201
178202
With GitHub Actions runner registration:
179203
180204
```bash
181205
# Generate a runner registration token at:
182206
# https://github.com/organizations/<your-org>/settings/actions/runners/new
183-
sudo ./bootstrap/bootstrap_pi.sh hil-bench-01 YOUR_TOKEN your-github-org
207+
sudo ./bootstrap/bootstrap_pi.sh samd51-bench-01 YOUR_TOKEN your-github-org
184208
```
185209
186210
The bootstrap script runs these steps in order (each is idempotent):

0 commit comments

Comments
 (0)