starred/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2026-01-12 04:10:32 +01:00
Code Issues 98 Packages Projects Releases 10 Wiki Activity

[Feature] documentation for Android auth with auth key #1031

New Issue
Closed
opened 2025-12-29 02:27:49 +01:00 by adam · 2 comments
adam commented 2025-12-29 02:27:49 +01:00
Owner
Copy Link

Originally created by @Erisa on GitHub (May 21, 2025).

Originally assigned to: @nblock on GitHub.

Use case

Users who create an auth key may want to connect to the Android client using this auth key.

Description

This requires a specific set of steps:
https://github.com/tailscale/tailscale/issues/16001#issuecomment-2893653230

  • Go to Tailscale settings, tap Accounts
  • Touch 3 dots on top right and select "Use an alternate server"
  • Enter your Headscale server URL, it will boot you back to the main screen. If login prompts open, close it and continue
  • Go back to 3 dots thing and set "Use an auth key"
  • Enter your auth key generated from Headscale
  • If needed, tap "Connect" on the main screen. You should now be connected to your Headscale tailnet.

Here's a video of me performing those steps on version 1.82:

https://github.com/user-attachments/assets/24153e29-610e-47e4-ac3b-94daff7b5350

Contribution

  • I can write the design doc for this feature
  • I can contribute this feature

How can it be implemented?

Add the steps on auth key authentication to this page: https://headscale.net/stable/usage/connect/android/

Originally created by @Erisa on GitHub (May 21, 2025). Originally assigned to: @nblock on GitHub. ### Use case Users who create an auth key may want to connect to the Android client using this auth key. ### Description This requires a specific set of steps: https://github.com/tailscale/tailscale/issues/16001#issuecomment-2893653230 - Go to Tailscale settings, tap Accounts - Touch 3 dots on top right and select "Use an alternate server" - Enter your Headscale server URL, it will boot you back to the main screen. If login prompts open, close it and continue - Go back to 3 dots thing and set "Use an auth key" - Enter your auth key generated from Headscale - If needed, tap "Connect" on the main screen. You should now be connected to your Headscale tailnet. Here's a video of me performing those steps on version 1.82: https://github.com/user-attachments/assets/24153e29-610e-47e4-ac3b-94daff7b5350 ### Contribution - [ ] I can write the design doc for this feature - [ ] I can contribute this feature ### How can it be implemented? Add the steps on auth key authentication to this page: https://headscale.net/stable/usage/connect/android/
adam added the enhancementno-stale-botdocumentation labels 2025-12-29 02:27:49 +01:00
adam closed this issue 2025-12-29 02:27:49 +01:00
adam commented 2025-12-29 02:27:50 +01:00
Author
Owner
Copy Link

@DerpgonCz commented on GitHub (Jun 21, 2025):

Not gonna lie, but this finally made the damn thing working. It is impossible to do via "alternate server" alone, because it just does not open the page - and if it does (about 1/50 tries), registering the device (either via UI (Headplane for me) or CLI) and going back to the application does absolutely nothing.

@DerpgonCz commented on GitHub (Jun 21, 2025): Not gonna lie, but this finally made the damn thing working. It is impossible to do via "alternate server" alone, because it just does not open the page - and if it does (about 1/50 tries), registering the device (either via UI (Headplane for me) or CLI) and going back to the application does absolutely nothing.
adam commented 2025-12-29 02:27:50 +01:00
Author
Owner
Copy Link

@drawk-cab commented on GitHub (Aug 3, 2025):

+1 to this, I couldn't get anything to happen without a pre-registered auth key.

@drawk-cab commented on GitHub (Aug 3, 2025): +1 to this, I couldn't get anything to happen without a pre-registered auth key.
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
CLI
DERP
DNS
Nix
OIDC
SSH
bug
database
documentation
duplicate
enhancement
faq
good first issue
grants
help wanted
might-come
needs design doc
needs investigation
no-stale-bot
out of scope
performance
policy 📝
pull-request
Mirrored from GitHub Pull Request
 question
regression
routes
stale
tags
tailscale-feature-gap
well described ❤️
wontfix
No Label documentation enhancement no-stale-bot
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#1031
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?