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] Dead link to container docs in 0.23.0 changelog, possible buggy documentation #2304

Open
3 of 4 tasks
neingeist opened this issue Dec 16, 2024 · 0 comments
Open
3 of 4 tasks
Labels
bug Something isn't working documentation Improvements or additions to documentation

Comments

@neingeist
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

A. The changelog contains a dead link to the container docs:

https://github.com/juanfont/headscale/blob/main/CHANGELOG.md?plain=1#L256
points to https://github.com/juanfont/headscale/blob/main/docs/running-headscale-container.md

That leads to a 404.

B. The changelog and the correct docs at https://github.com/juanfont/headscale/blob/main/docs/setup/install/container.md are confusing or seem lacking or even incorrect when it comes to /var/lib/headscale or /var/run/headscale. The example config uses these directories, but the changelog says these are not created anymore while the container docs do not hint about creating a volume for it (despite mentioning confusingly to "alternatively" mount them from the host system. alternatively to what?) I think this needs a review 😄

Expected Behavior

A. fixed changelog
B. Review

😄

Steps To Reproduce

  • See above -

Environment

- OS: Linux
- Headscale version: 0.23.x
- Tailscale version: not relevant

Runtime environment

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

Anything else?

No response

@neingeist neingeist added the bug Something isn't working label Dec 16, 2024
@nblock nblock added the documentation Improvements or additions to documentation label Dec 17, 2024
nblock added a commit to nblock/headscale that referenced this issue Dec 17, 2024
@nblock nblock mentioned this issue Dec 17, 2024
6 tasks
nblock added a commit to nblock/headscale that referenced this issue Dec 17, 2024
nblock added a commit that referenced this issue Dec 17, 2024
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

No branches or pull requests

2 participants