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] headscale documentation regarding docker usage displays outdated information compared to the source code of the page #1003

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

Originally created by @xeropresence on GitHub (Apr 19, 2025).

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

If you check visit https://headscale.net/stable/setup/install/container/ you will see following instructions for a docker-compose setup

https://i.imgur.com/WCaZM7p.png

version: "3.7"

services:
  headscale:
    image: headscale/headscale:<VERSION>
    restart: unless-stopped
    container_name: headscale
    ports:
      - "127.0.0.1:8080:8080"
      - "127.0.0.1:9090:9090"
    volumes:
      # Please change <CONFIG_PATH> to the fullpath of the config folder just created
      - <CONFIG_PATH>:/etc/headscale
    command: serve

If you click view source for this page the contents of the yaml file are

    version: "3.7"

    services:
      headscale:
        image: headscale/headscale:<VERSION>
        restart: unless-stopped
        container_name: headscale
        ports:
          - "127.0.0.1:8080:8080"
          - "127.0.0.1:9090:9090"
        volumes:
          # Please set <HEADSCALE_PATH> to the absolute path
          # of the previously created headscale directory.
          - <HEADSCALE_PATH>/config:/etc/headscale
          - <HEADSCALE_PATH>/lib:/var/lib/headscale
          - <HEADSCALE_PATH>/run:/var/run/headscale
        command: serve

as you can see the currently rendered setting is missing two crucial pieces from the volumes, these missing pieces cause the sqlite database to be reset upon restart.

Expected Behavior

Correct contents get rendered

Steps To Reproduce

Visit website

Environment

Chrome

Runtime environment

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

Debug information

N/A

Originally created by @xeropresence on GitHub (Apr 19, 2025). ### 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 If you check visit https://headscale.net/stable/setup/install/container/ you will see following instructions for a docker-compose setup https://i.imgur.com/WCaZM7p.png ``` version: "3.7" services: headscale: image: headscale/headscale:<VERSION> restart: unless-stopped container_name: headscale ports: - "127.0.0.1:8080:8080" - "127.0.0.1:9090:9090" volumes: # Please change <CONFIG_PATH> to the fullpath of the config folder just created - <CONFIG_PATH>:/etc/headscale command: serve ``` If you click view source for this page the contents of the yaml file are ``` version: "3.7" services: headscale: image: headscale/headscale:<VERSION> restart: unless-stopped container_name: headscale ports: - "127.0.0.1:8080:8080" - "127.0.0.1:9090:9090" volumes: # Please set <HEADSCALE_PATH> to the absolute path # of the previously created headscale directory. - <HEADSCALE_PATH>/config:/etc/headscale - <HEADSCALE_PATH>/lib:/var/lib/headscale - <HEADSCALE_PATH>/run:/var/run/headscale command: serve ``` as you can see the currently rendered setting is missing two crucial pieces from the volumes, these missing pieces cause the sqlite database to be reset upon restart. ### Expected Behavior Correct contents get rendered ### Steps To Reproduce Visit website ### Environment ```markdown Chrome ``` ### Runtime environment - [ ] Headscale is behind a (reverse) proxy - [ ] Headscale runs in a container ### Debug information N/A
adam added the bug label 2025-12-29 02:27:22 +01:00
adam closed this issue 2025-12-29 02:27:23 +01:00
adam commented 2025-12-29 02:27:23 +01:00
Author
Owner
Copy Link

@nblock commented on GitHub (Apr 19, 2025):

Thanks for bringing this up. There are two issues here:

  • The "sqlite database to be reset upon restart" got fixed in the development version of the docs via 24ad235917 and its rendered in the development version of the docs: https://headscale.net/development/setup/install/container/. It will be part of the docs for the next stable version.
  • The link from the docs back to the repository point to the main branch. This might not be optimal, but is probably not configurable per version and doc fixes should point towards main.
@nblock commented on GitHub (Apr 19, 2025): Thanks for bringing this up. There are two issues here: * The "sqlite database to be reset upon restart" got fixed in the development version of the docs via 24ad235917cda92f4cfc65e105dddcf75f8ddcf2 and its rendered in the *development* version of the docs: https://headscale.net/development/setup/install/container/. It will be part of the docs for the next stable version. * The link from the docs back to the repository point to the main branch. This might not be optimal, but is probably not configurable per version and doc fixes should point towards main.
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
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#1003
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?