Running Headscale In A Container Documentation Updates. #1659
Conversation
canardleteer
commented
Dec 18, 2023
canardleteer
commented
- read the CONTRIBUTING guidelines
- raised a GitHub issue or discussed it on the projects chat beforehand
- added unit tests
- added integration tests
- updated documentation if needed
- updated CHANGELOG.md
| 2. **(Strongly Recommended)** Download a copy of the [example configuration](https://github.com/juanfont/headscale/blob/main/config-example.yaml) from the headscale repository. | ||
|
|
||
| ```shell | ||
| touch ./config/db.sqlite | ||
| ``` | ||
|
|
||
| 3. **(Strongly Recommended)** Download a copy of the [example configuration](https://github.com/juanfont/headscale/blob/main/config-example.yaml) from the headscale repository. | ||
| The following instructions are for running against `headscale/headscale:latest`, if you are using an older version, you will want to make sure you're getting the correct version of a default configuration file from the [tags](https://github.com/juanfont/headscale/tags) matching your version. |
There was a problem hiding this comment.
There are admonition extension for such cases.
!!! warning "Strongly Recommended"
Download a copy of the [example configuration](https://github.com/juanfont/headscale/blob/main/config-example.yaml) from the headscale repository.
There was a problem hiding this comment.
While I make changes like these by re-basing on main, and adding those changes, I cannot validate the changes since make serve is not offered in the Makefile after a rebase on main (which is the validation step mentioned here). You can see those changes here in this branch if you'd like to take a look: https://github.com/canardleteer/headscale/blob/fix-docker-documentation-testing/docs/running-headscale-container.md
It does appear, than since my contribution, at least some of the changes proposed were added to the repository.
If those changes are fine as is, I can add them to this MR.
| # The default /var/lib/headscale path is not writable in the container | ||
| db_type: sqlite3 | ||
| db_path: /etc/headscale/db.sqlite | ||
| ``` | ||
|
|
||
| **(Advanced)** If you would like to hand craft a config file **instead** of downloading the example config file, create a blank `headscale` configuration in the headscale directory to edit: |
There was a problem hiding this comment.
!!! example "Advanced"
If you would like to hand craft a config file **instead** of downloading the example config file, create a blank `headscale` configuration in the headscale directory to edit:
