Tailscale integration setup misuses Tailscale terminology

[KlfJoat]

The problem

The Tailscale integration setup is unclear in two ways. I muddled through them, but in the interest of making this as easy as possible for people, I think the wording needs to be clearer.

For reference, I have a Tailscale Personal account.

1) "Tailnet"

The integration asks for the "Tailnet" name, and prompts users that the name is at the top of the Tailscale Admin panel, next to the logo.

However, in my account, that is not the "Tailnet name". That is the Organization name. My Tailnet name is on the DNS tab of the Admin panel.

What the integration wants is the "Organization name". The language should be updated to properly reflect that terminology.

2) "API key"

The HA Tailscale integration asks for an "API key" available at https://login.tailscale.com/admin/settings/keys.

There are two keys that I can create here as of today. One is named an "Auth key", the other is named an "API access token".

A novice user is going to be looking for the phrase the integration uses, "API key", and be split... One item says "key" the other item says "API".

It would be best if the integration matched the terminology used by Tailscale and requested users enter an "API access token".

Why care?

I know these terminology issues are small potatoes. But they are the kind of quality-of-life items that make things easier for users. In each case, I had to read and think about which one the integration really wanted. But ideally I wouldn't have to think, I'd just grab the info from the matching name.

(Actually ideally, I could just log into Tailscale somehow and the integration would grab the info it needs, but I understand that's not possible.)

What version of Home Assistant Core has the issue?

core-2024.12.1

What was the last working version of Home Assistant Core?

No response

What type of installation are you running?

Home Assistant OS

Integration causing the issue

tailscale

Link to integration documentation on our website

https://www.home-assistant.io/integrations/tailscale/

Diagnostics information

No response

Example YAML snippet

No response

Anything in the logs that might be useful for us?

No response

Additional information

No response

[home-assistant]

Hey there @frenck, mind taking a look at this issue as it has been labeled with an integration (tailscale) you are listed as a code owner for? Thanks!

Code owner commands

Code owners of tailscale can trigger bot actions by commenting:

• @home-assistant close Closes the issue.
• @home-assistant rename Awesome new title Renames the issue.
• @home-assistant reopen Reopen the issue.
• @home-assistant unassign tailscale Removes the current integration label and assignees on the issue, add the integration domain after the command.
• @home-assistant add-label needs-more-information Add a label (needs-more-information, problem in dependency, problem in custom component) to the issue.
• @home-assistant remove-label needs-more-information Remove a label (needs-more-information, problem in dependency, problem in custom component) on the issue.

_{^{(message by CodeOwnersMention)}}

---

tailscale documentation
tailscale source
_{^{(message by IssueLinks)}}

[frenck]

Thanks for this feedback @KlfJoat!

Things have changed over the years, and I agree with you that we need to adjust to it at this moment in time.

../Frenck