myriation/headscale
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages 1 Wiki Activity
3195 commits 1 branch 0 tags 8.5 MiB
Commit graph

229 commits

Author SHA1 Message Date
Jiang Zhu
0b4b530809 remove the hardcoded version(suggested by @kradalby) 2022-06-11 16:41:52 +08:00
Juan Font Alonso
5bc11891f5 Update internal docs with protocol usage 2022-06-08 18:15:38 +02:00
Juan Font Alonso
c47354bdc3 Update internal docs to the new syntax 2022-06-08 18:12:47 +02:00
Jiang Zhu
c8a14ccabb fix prettier 2022-06-05 16:01:53 +08:00
Jiang Zhu
1de29fd4e6 fix rcd link 2022-06-05 15:49:24 +08:00
Jiang Zhu
75a0155f73 add openbsd doc 2022-06-05 15:45:38 +08:00
Kristoffer Dalby
2edb5428f9
Merge branch 'main' into acls-doc 2022-05-16 16:32:18 +01:00
Deon Thomas
ed46491a3d
fixed typo 
not => note
 2022-05-07 16:23:26 -04:00
Moritz Poldrack
6dd9e93346
expanded arguments in useradd to be easier to understand for beginners 2022-04-21 11:00:17 +02:00
Kristoffer Dalby
db930af50e
Merge branch 'main' into patch-1 2022-04-21 09:13:34 +01:00
Kristoffer Dalby
580c72bf16 Update discord link so it does not grant temp memberships 2022-04-21 09:06:30 +01:00
Moritz Poldrack
7ce0bd053c
removed leading whitespace 2022-04-16 23:58:05 +02:00
Moritz Poldrack
41a8c14acb
add information on how to create a headscale user 2022-04-16 23:56:57 +02:00
Moritz Poldrack
be2487f4c0
Clarified systemd friendly path 
Suggested-by: Rendezvous
 2022-04-16 23:52:06 +02:00
Artem Klevtsov
98e98a8adb
Fix wrong metrics port in docs 
It should be 9090.
 2022-04-09 16:24:57 +07: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
Nico Rey
d68d7d5a6f Docs/ACLs: Add a network diagram to help explain ACLs 2022-03-17 19:58:56 -03:00
Nico Rey
bff9036f14 Docs/ACLs: Add router examples with subnets 2022-03-17 19:58:34 -03:00
Nico Rey
8b08c2a918 Docs/ACLs: Namespaces are created automatically 2022-03-17 19:24:39 -03:00
Nico Rey
b9f0fabb5c Docs/ACLs: Wording, add intermediary router example 2022-03-17 19:23:37 -03:00
Yang Bin
537ecb8db0
docs: fixed /metrics endpoint 8080 → 9090, reference config-example.yaml 2022-03-17 09:25:42 +08:00
Kristoffer Dalby
dd219d0ff6
Merge branch 'main' into docs-acl-modifications 2022-03-08 17:05:59 +00:00
Nico Rey
9a61725e9f Metrics: Disable toggle. Set default port to 9090 2022-02-28 10:40:02 -03:00
Kristoffer Dalby
6126d6d9b5
Merge branch 'main' into metrics-listen 2022-02-28 14:24:25 +01:00
Nico Rey
06e6c29a5b metrics: make metrics endpoint toggleable 2022-02-25 18:36:03 -03:00
Nico Rey
a9122c3de3 prometheus: replace default port by a port between the recommended prometheus range 2022-02-25 18:21:20 -03:00
Kristoffer Dalby
91b50550ee Update readme and glossary to reflect features and goals 2022-02-25 10:34:35 +01:00
Nico
d55c79e75b
Merge branch 'main' into metrics-listen 2022-02-24 10:41:07 -03:00
Kristoffer Dalby
d27f2bc538
Merge branch 'main' into metrics-listen 2022-02-24 11:16:57 +00:00
Kristoffer Dalby
8c33907655 Sort lint 2022-02-24 11:10:40 +00:00
Kristoffer Dalby
f562ad579a
Merge branch 'main' into configurable-mtls 2022-02-21 21:44:49 +00:00
Nico Rey
14e49885fb metrics/kustomize: update Kustomize examples 2022-02-21 12:51:25 -03:00
Justin Angel
b5a59d4e7a updating changelog and docs 2022-02-21 10:20:11 -05:00
Kristoffer Dalby
ecb3ee6bfa
Merge branch 'main' into feat-improve-acls-usage 2022-02-21 08:51:21 +00:00
Kristoffer Dalby
7bf2a91dd0
Merge branch 'main' into configurable-mtls 2022-02-20 14:33:23 +00:00
Justin Angel
385dd9cc34 refactoring 2022-02-20 09:06:14 -05:00
e-zk
a6b7bc5939 Fix spelling error 2022-02-20 03:14:51 +10:00
Kristoffer Dalby
397b6fc4bf
Merge branch 'main' into docs-acl-modifications 2022-02-18 20:13:10 +00:00
Adrien Raffin-Caboisse
d8c4c3163b
chore(fmt): apply make fmt command 2022-02-17 09:32:54 +01:00
Adrien Raffin-Caboisse
7b5ba9f781
docs(acl): add configuration example to explain acls 2022-02-17 09:30:09 +01:00
Adrien Raffin-Caboisse
55d746d3f5 docs(acls-proposal): wording comment 
A hidden thing was implied in this document is that each person should have his own namespace.
Hidden information in spicification isn't good.
Thank's @kradalby for pointing it out.
 2022-02-16 09:16:25 +01:00
Adrien Raffin-Caboisse
c364c2a382 chore(acl-proposals): apply prettier 2022-02-15 09:53:22 +01:00
Adrien Raffin-Caboisse
e540679dbd docs(acl-proposals): integrate comments 2022-02-15 09:52:05 +01:00
Adrien Raffin-Caboisse
86b329d8bf chore(docs): create proposals directory 2022-02-15 09:27:33 +01:00
Kristoffer Dalby
28c824acaf
Merge branch 'main' into apiwork 2022-02-14 16:17:34 +00:00
Kristoffer Dalby
14b23544e4 Add note about running grpc behind a proxy and combining ports 2022-02-13 09:48:33 +00:00
Kristoffer Dalby
0018a78d5a Add insecure option 
Add option to not _validate_ if the certificate served from headscale is
trusted.
 2022-02-13 08:41:49 +00:00
Kristoffer Dalby
4841e16386
Add remote control doc 2022-02-12 20:39:42 +00:00
Kristoffer Dalby
3bb4c28c9a
Merge branch 'main' into apiwork 2022-02-12 19:39:30 +00:00
Kristoffer Dalby
2fbcc38f8f Emph trusted cert 2022-02-12 19:36:43 +00:00
Kristoffer Dalby
315ff9daf0 Remove insecure, only allow valid certs 2022-02-12 19:35:55 +00:00
Kristoffer Dalby
58bfea4e64 Update examples and docs 2022-02-12 19:08:59 +00:00
Kristoffer Dalby
dd8bae8c61 Add link from the docs readme 2022-02-11 18:39:41 +00:00
Kristoffer Dalby
1b47ddd583 Improve the windows client docs as per discord recommendations 2022-02-11 18:36:53 +00:00
Kristoffer Dalby
d9aaa0bdfc Add docs on how to set up Windows clients 2022-02-11 08:26:22 +00:00
Adrien Raffin-Caboisse
7bdd7748e4 fix(acl): add missing internal namespace communications 2022-02-10 12:03:03 +01:00
Adrien Raffin-Caboisse
0426212348 docs(acls): add example use case 2022-02-10 10:42:26 +01:00
Adrien Raffin-Caboisse
85cf443ac6 docs(acls): Issues with ACL and proposition 2022-02-08 16:59:35 +01:00
Justin Angel
1b2fff4337
Merge branch 'main' into configurable-mtls 2022-02-02 11:54:49 -05:00
lachy-2849
7b607b3fe8
Forgot to run Prettier 2022-02-01 19:32:13 -05:00
lachy-2849
41fbe47cdf
Note when running as another user in systemd 
Headscale commands fail when running them as the current user instead of the user defined in the systemd file. This note provides 2 methods of how to correctly run the headscale commands.
 2022-02-01 14:23:18 -05:00
Kristoffer Dalby
168b1bd579
Merge branch 'main' into configurable-mtls 2022-01-31 12:28:00 +00:00
Justin Angel
310e7b15c7 making alternatives constants 2022-01-30 10:46:57 -05:00
Bryan Stenson
ccd41b9a13
Typo 2022-01-29 22:34:51 -08:00
Justin Angel
5935b13b67 refining 2022-01-29 13:35:08 -05:00
Kristoffer Dalby
56b6528e3b Run prettier 2022-01-25 22:11:15 +00:00
Kristoffer Dalby
fa197cc183 Add docs for remote access 2022-01-25 22:11:15 +00:00
Jim Tittsler
86f3f26a18 Fix typos 2022-01-15 16:44:36 +09:00
Pierre Carru
cec236ce24
Fix example config link 
Everything is in the title :p
 2022-01-10 14:44:11 +01: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
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