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:
|
This might need a rebase/need other updates considering new updates that have gone into this docs in prep for 0.23 |
|
Warning Rate limit exceeded@kradalby has exceeded the limit for the number of commits or files that can be reviewed per hour. Please wait 29 minutes and 28 seconds before requesting another review. How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
