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

[Bug] Dead link to container docs in 0.23.0 changelog, possible buggy documentation #887

New Issue
Closed
opened 2025-12-29 02:25:17 +01:00 by adam · 1 comment
adam commented 2025-12-29 02:25:17 +01:00
Owner
Copy Link

Originally created by @neingeist on GitHub (Dec 16, 2024).

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

Originally created by @neingeist on GitHub (Dec 16, 2024). ### Is this a support request? - [X] This is not a support request ### Is there an existing issue for this? - [X] 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 :smile: ### Expected Behavior A. fixed changelog B. Review :smile: ### Steps To Reproduce - See above - ### Environment ```markdown - OS: Linux - Headscale version: 0.23.x - Tailscale version: not relevant ``` ### Runtime environment - [ ] Headscale is behind a (reverse) proxy - [X] Headscale runs in a container ### Anything else? _No response_
adam added the bugdocumentation labels 2025-12-29 02:25:17 +01:00
adam closed this issue 2025-12-29 02:25:17 +01:00
adam commented 2025-12-29 02:25:17 +01:00
Author
Owner
Copy Link

@github-actions[bot] commented on GitHub (Mar 18, 2025):

This issue is stale because it has been open for 90 days with no activity.

@github-actions[bot] commented on GitHub (Mar 18, 2025): This issue is stale because it has been open for 90 days with no activity.
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 bug documentation
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#887
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?