Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Bug] "Getting started" doc suggests one tailnet per user #2335

Open
2 of 4 tasks
samuelallan72 opened this issue Jan 9, 2025 · 0 comments · May be fixed by #2358
Open
2 of 4 tasks

[Bug] "Getting started" doc suggests one tailnet per user #2335

samuelallan72 opened this issue Jan 9, 2025 · 0 comments · May be fixed by #2358
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@samuelallan72
Copy link

Is this a support request?

  • This is not a support request

Is there an existing issue for this?

  • I have searched the existing issues

Current Behavior

On https://headscale.net/stable/usage/getting-started/ , under "Manage users", there is this sentence:

In headscale, a node (also known as machine or device) is always assigned to a specific user, a tailnet.

This wording suggests that a user is equivalent to a tailnet; ie. one tailnet per user. This however, is not correct for headscale.

Expected Behavior

The wording should be clear that a headscale server provides a single global tailnet, and all users are in the same tailnet.

It would also be nice to be clearer about what the concept of a user is, in the context of headscale - this has confused me a bit.

Steps To Reproduce

.

Environment

.

Runtime environment

  • Headscale is behind a (reverse) proxy
  • Headscale runs in a container

Anything else?

No response

@samuelallan72 samuelallan72 added the bug Something isn't working label Jan 9, 2025
@samuelallan72 samuelallan72 changed the title [Bug] "Getting started" doc suggests one user per tailnet [Bug] "Getting started" doc suggests one tailnet per user Jan 9, 2025
@nblock nblock added the documentation Improvements or additions to documentation label Jan 9, 2025
nblock added a commit to nblock/headscale that referenced this issue Jan 21, 2025
Separate the term "tailnet" from user and be more explicit about
providing a single tailnet.

Also be more explicit about users. Refer to "headscale users" when
mentioning commandline invocations and use the term "local users" when
discussing unix accounts.

Fixes: juanfont#2335
@nblock nblock linked a pull request Jan 21, 2025 that will close this issue
6 tasks
@nblock nblock added this to the v0.25.0 milestone Jan 21, 2025
nblock added a commit to nblock/headscale that referenced this issue Jan 24, 2025
Separate the term "tailnet" from user and be more explicit about
providing a single tailnet.

Also be more explicit about users. Refer to "headscale users" when
mentioning commandline invocations and use the term "local users" when
discussing unix accounts.

Fixes: juanfont#2335
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants