Commit Graph

154 Commits

Author SHA1 Message Date
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 d9f52efe70 Fix typo 2022-01-02 23:17:48 +00:00
Kristoffer Dalby 81c60939c9 Add vertical line for breathing 2022-01-02 19:55:38 +00: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 1d01103b67 Link to example config from docs 2022-01-02 19:43:06 +00:00
Kristoffer Dalby 5df100539c Remove outdated configuration page in favour of config-example 2022-01-02 19:42:35 +00:00
Kristoffer Dalby 11c86acbe3 update case in readme 2022-01-02 19:39:51 +00:00
Kristoffer Dalby 86f36f9a43 Lowercase markdown docs 2022-01-02 19:39:03 +00:00
Kristoffer Dalby 80d196cbfd Remove DNS file, it will be merged into example configuration 2022-01-02 19:37:48 +00:00
Kristoffer Dalby 3ce3ccb559 Reorder tls docs 2022-01-02 19:36:50 +00:00
Kristoffer Dalby a11c6fd8b9 Fix formatting error in container doc 2022-01-02 20:08:18 +01:00
Kristoffer Dalby a75c5a4cff Add eradme to examples 2022-01-02 20:08:04 +01:00
Kristoffer Dalby 8d504c35bf Move kubernetes to kustomize, since thats what it is 2022-01-02 20:06:32 +01:00
Kristoffer Dalby 8a07a63b1c Write disclaimer in kubernetes example 2022-01-02 20:06:21 +01:00
Kristoffer Dalby 74fd5de43d Move kubernetes example under docs 2022-01-02 20:04:35 +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
Kristoffer Dalby 4b44aa2180
Add note about outdated docs until we fix them 2021-12-28 10:16:20 +01:00
Michael Ko. Gajda 0c13d9da15 Fix format with prettier 2021-12-04 18:51:09 +01:00
Kristoffer Dalby 969bcf17c4
Merge branch 'main' into feature/github_templates 2021-12-04 10:55:43 +00:00
ZiYuan c046ffbceb
fix typo
Remove redundant quotation: `ephemeral_node_inactivity_timeout": "30m"` => `ephemeral_node_inactivity_timeout: "30m"`
2021-12-01 14:50:08 +08:00
Michael Ko. Gajda 48fc93bbdc Add simple overview README for docs 2021-11-29 14:36:47 +01:00
Kristoffer Dalby e167be6d64 Remove generate private key step from docs 2021-11-28 09:18:24 +00:00
Kristoffer Dalby c63c259d31 Switch wgkey for types/key
We dont seem to need the wireguard key anymore, we generate a key on
startup based on the new library and the users fetch it from /key.

Clean up app.go and update docs
2021-11-26 23:28:06 +00:00
lion24 e91f72fe4c
Running.md: fix missing backslash (\)
* This would cause otherwise the command to abort after the first statement of the docker command ;)
2021-11-20 23:31:49 +01:00
ItalyPaleAle 7bc2f41b33 Run prettier 💄 2021-11-15 15:37:40 -08:00
Alessandro (Ale) Segala a10388b709
Merge branch 'main' into docker-distroless 2021-11-15 15:19:06 -08:00
Alessandro (Ale) Segala 7d77acd88e
Docs for debug container 2021-11-13 22:16:37 +00:00
Kristoffer Dalby 6b3114ad6f Run prettier 2021-11-13 08:11:55 +00:00
Alessandro (Ale) Segala 3b34c7b89a
Removed / from docker commands in docs
Essentially reverts 6076656373
2021-11-09 16:23:36 +00:00
Alessandro (Ale) Segala 6076656373 Updated docs 2021-11-07 18:57:37 +00:00
Kristoffer Dalby b75e8ae2bd
Merge branch 'main' into patch-1 2021-11-05 18:27:55 +00:00
Ward Vandewege f9187bdfc4 Switch to named arguments for all `nodes` subcommands. Update docs
accordingly. Fix integration test failure.
2021-10-28 09:31:15 -04:00
Remus CURSARU c22b93734e
update Running.md
clarify setup steps; use a single directory to hold all configuration for docker container
2021-10-24 14:09:07 +02:00
derelm 88b32e4b18
fix typo 2021-10-21 23:07:35 +02:00
Juan Font Alonso 561c15bbe8 Prettier 2021-10-21 21:01:52 +02:00
Juan Font Alonso 636943c715 Improved docker cmd 2021-10-21 20:57:18 +02:00
Juan Font Alonso e9ffd366dd Improvements here and there 2021-10-21 20:54:41 +02:00
Juan Font Alonso 4be0b3f556 Mention disable check updates in the doc 2021-10-21 20:54:29 +02:00
Juan Font Alonso a0bfad6d6e Headscale is not capitalized 2021-10-21 20:48:29 +02:00
Juan Font Alonso bb1f17f5af Added glossary 2021-10-21 20:46:19 +02:00
Kristoffer Dalby 2c5701917d
Merge branch 'main' into doc-reorg-v1 2021-10-21 18:46:29 +01:00
Juan Font 41c5a0ddf5
Apply suggestions from code review
Co-authored-by: Kristoffer Dalby <kradalby@kradalby.no>
2021-10-20 09:35:56 +02:00
Juan Font Alonso 31344128a0 Switch json for yaml in README 2021-10-20 00:17:47 +02:00
Juan Font Alonso d1e8ac7ba5 Moved TLS config to another file 2021-10-20 00:07:05 +02:00
Juan Font Alonso efe208fef5 Merge branch 'doc-reorg-v1' of https://github.com/juanfont/headscale into doc-reorg-v1 2021-10-19 23:54:32 +02:00
Juan Font Alonso 7b40e99aec Added notes on SQLite 2021-10-19 23:45:20 +02:00
Juan Font 06706aab9a
Update docs/Running.md
Co-authored-by: Kristoffer Dalby <kradalby@kradalby.no>
2021-10-19 23:41:08 +02:00
Juan Font 0318af5a33
Apply suggestions from code review
Co-authored-by: Kristoffer Dalby <kradalby@kradalby.no>
2021-10-19 23:22:56 +02:00
Juan Font Alonso 7bb354117b Move README documentation to doc/ 2021-10-19 20:59:33 +02:00
Juan Font Alonso 18b00b5d8d Add support for Split DNS (implements #179) 2021-10-19 20:51:43 +02:00
Juan Font Alonso 088e8248d3 Improved doc 2021-10-04 22:50:33 +02:00
Juan Font Alonso c9e4da3ff5 Improving documentation for DNS config 2021-10-02 11:11:18 +02:00