Kristoffer Dalby
cb0e2e4476
various doc updates in prep for 0.23 ( #2091 )
...
* various doc updates in prep for 0.23
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
* add note discouraging postgresql
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
* Update docs/faq.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
* remove entry for glossary in doc
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
* fix typo
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
---------
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
2024-08-30 16:59:24 +02:00
Maja Bojarska
4d9021047f
Fix/improve documentation formatting ( #1575 )
...
* Fix docs formatting
* .prettierignore add docu
---------
Co-authored-by: ohdearaugustin <ohdearaugustin@users.noreply.github.com>
2024-03-22 19:55:20 +01:00
zx
b477e5f366
Update docker related doc ( #1421 )
2024-03-14 23:01:33 +01:00
Kristoffer Dalby
b60ee9db54
improve errors for missing directories ( #1765 )
...
* improve errors for missing directories
Fixes #1761
Updates #1760
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
* update container docs
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
* update changelog with /var changes
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
---------
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2024-02-17 13:36:19 +01:00
Kristoffer Dalby
c73e8476b9
make database configuration change breaking ( #1766 )
...
A lot of things are breaking in 0.23 so instead of having this
be a long process, just rip of the plaster.
Updates #1758
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2024-02-17 13:18:15 +01:00
JesseBot
f13cf64578
Docs: Update running-headscale-container.md - fix link to example config ( #1618 )
2023-11-29 15:10:21 +01:00
Andriy Kushnir (Orhideous)
6381d3660a
Add admonitions marking community-provided docs
2023-04-07 15:24:13 +02:00
Andriy Kushnir (Orhideous)
66c5f74d78
Add admonitions marking community-provided docs
2023-04-07 15:24:13 +02:00
Kristoffer Dalby
fb3e2dcf10
Rename namespace to user in docs
...
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-01-18 15:40:04 +01:00
manju-rn
a49a405413
Correction in the sample config file
...
Added the db_type in the sample config.yaml Without this entry, the container throws Unsupported DB error
`db_type: sqlite3`
2022-11-20 17:12:13 +01:00
Till Hoffmann
701f990a23
Unify code snippet comment location
2022-10-22 00:12:24 +02:00
Zhiyuan Zheng
073308f1a3
Fix the proposed noise private_key_path
...
As indicated by the comment, the default /var/lib/headscale path is not writable in the container. However the sample setting is not following that like `private_key_path`
2022-10-11 22:55:54 +08:00
Jamie Greeff
07dca79b20
Remove --rm flag from Docker example
...
It appears to be causing confusion for users on Discord when copying/pasting from the example here, if Headscale crashes on launch then the container will be removed and logs can't be viewed with `docker logs`.
2022-09-07 14:16:04 +01:00
Juan Font Alonso
4424a9abc0
Noise private key now a nested field in config
2022-08-21 10:42:23 +02:00
Juan Font Alonso
78a179c971
Minor update in docs
2022-08-14 16:53:54 +02:00
Niek van der Maas
6d296a195d
Update docs/running-headscale-container.md
...
Co-authored-by: Kristoffer Dalby <kradalby@kradalby.no>
2022-03-28 08:58:33 +02:00
Niek van der Maas
3272febfb3
Change publish interface
2022-03-26 13:33:31 +01:00
Niek van der Maas
7dae780be1
Update docs/running-headscale-container.md
...
Co-authored-by: Kristoffer Dalby <kradalby@kradalby.no>
2022-03-25 23:44:55 +01:00
Niek van der Maas
73f1c06f65
Fix long line
2022-03-25 07:46:01 +00:00
Niek van der Maas
8cee31d8d7
Fix prettier
2022-03-25 07:43:15 +00:00
Niek van der Maas
7e286c570e
Docker docs enhancements
...
While configuring a Docker setup I noticed that the docs could use some enhancements.
2022-03-22 13:45:30 +01:00
Yang Bin
537ecb8db0
docs: fixed /metrics endpoint 8080 → 9090, reference config-example.yaml
2022-03-17 09:25:42 +08:00
JJGadgets
897fa558b0
prettier: Docker docs
2022-01-06 17:25:07 +08:00
JJGadgets
d971cf1295
Improve Docker docs
...
- Fix URLs referring to files in this repository
- Better explain that we are creating the headscale directory and running the commands on the host Docker node
- Place instructions to download example config file to use as config file, as recommended steps.
2022-01-06 14:10:28 +08:00
Kristoffer Dalby
4edc96d14d
Make strongly strong
2022-01-02 19:54:37 +00:00
Kristoffer Dalby
6b7c74133d
Use markdown numbering so github gets it
2022-01-02 19:53:49 +00:00
Kristoffer Dalby
8da029bd14
Add missing links
2022-01-02 19:48:57 +00:00
Kristoffer Dalby
a11c6fd8b9
Fix formatting error in container doc
2022-01-02 20:08:18 +01:00
Kristoffer Dalby
f9e6722635
Rewrite main documentation
...
This commit starts restructuring the documentation and updating it to be
compliant with 0.12.x+ releases.
The main change is that the documentation has been rewritten for the
ground up, and hopefully simplified.
The documentation has been split into an official documentation for
running headscale as a binary under Linux with SystemD and a "community"
provided documentation for Docker.
This should make the two documents a lot easier to read and follow than
the mishmash document we had.
2022-01-02 19:11:36 +01:00
