Commit Graph

239 Commits

Author SHA1 Message Date
Kristoffer Dalby a5afe4bd06 Add more capabilities for systemd
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-04-20 15:53:19 +02:00
Kristoffer Dalby cad5ce0ebd lint fix
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-04-19 20:04:58 +02:00
Kristoffer Dalby 667295e15e add new documentation on how to install on debian/ubuntu
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-04-19 20:04:58 +02:00
Kristoffer Dalby bea52678e3 move current linux documentation into "manual"
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-04-19 20:04:58 +02:00
Kristoffer Dalby 307cfc3304 add systemd enable to postinstall script
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-04-19 20:04:58 +02:00
Andriy Kushnir (Orhideous) dd9b4b1cb7 Move examples out of docs/ directory 2023-04-07 15:24:13 +02:00
Andriy Kushnir (Orhideous) 99bd09f688 Add new index page 2023-04-07 15:24:13 +02:00
Andriy Kushnir (Orhideous) a6bc792a61 Move admonitions to relevant sections 2023-04-07 15:24:13 +02: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
Juan Font c6815c5334 Target Go 1.20 and Tailscale 1.38 2023-04-07 13:25:34 +02:00
Kristoffer Dalby b684ac0668 Simplify goreleaser, package deb and rpm
This commit simplifies the goreleaser configuration and then adds nfpm
support which allows us to build .deb and .rpm for each of the ARCH we
support.

The deb and rpm packages adds systemd services and users, creates
directories etc and should in general give the user a working
environment. We should be able to remove a lot of the complicated,
PEBCAK inducing documentation after this.

Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-04-07 11:06:42 +02:00
Sean Reifschneider 036ff1cbb9
Adding Powershell commands to Windows instructions (#1299)
Co-authored-by: Kristoffer Dalby <kristoffer@dalby.cc>
2023-04-04 08:58:32 +02:00
Julien Zweverink 681c86cc95
ACL Doc's (#1288) 2023-03-28 18:41:23 +02:00
Gabe Cook 56a7b1e349
Add SVG logos (#1286) 2023-03-27 15:33:25 +02:00
Antonio Fernandez f1eee841cb
updated to ACL doc (#1278) 2023-03-27 11:25:55 +02:00
Moritz Poldrack d12f247490 document running exit nodes
Currently the only kind-of documentation is #210 which is outdated. To remedy
this, add a document describing the process.
2023-03-19 11:02:01 +01:00
nicholas-yap 003036a779
Update iOS compatibility and added iOS docs (#1264) 2023-03-17 15:56:15 +01:00
Josh Taylor 5e6868a858 Run prettier 2023-02-27 10:28:49 +01:00
Josh Taylor 5caf848f94 Add steps for Google OAuth for OIDC 2023-02-27 10:28:49 +01:00
Michael Savage dcc246c869 Fix OpenBSD build docs
- OpenBSD 7.2 installs go 1.19 by default
- Doubt you can run nix so skip the makefile/nix build and just go build directly
2023-02-26 12:54:47 +01:00
Maxim Gajdaj 61c578f82b Update running-headscale-linux.md
Option WorkingDirectory for headscale.service added
2023-02-09 08:17:28 -05:00
Jan Hartkopf cb25f0d650 Add hint for reverse proxying with Apache 2023-01-23 15:51:20 +01:00
Christian Heusel c720af66d6 permalink in the limitations section to tailscale
The relative link was broken after one commit to the file

Signed-off-by: Christian Heusel <christian@heusel.eu>
2023-01-20 09:19:26 +01: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
Motiejus Jakštys bafb6791d3 oidc: allow reading the client secret from a file
Currently the most "secret" way to specify the oidc client secret is via
an environment variable `OIDC_CLIENT_SECRET`, which is problematic[1].
Lets allow reading oidc client secret from a file. For extra convenience
the path to the secret will resolve the environment variables.

[1]: https://systemd.io/CREDENTIALS/
2023-01-14 17:03:57 +01:00
Even Holthe fecb13b24b oidc: add basic docs 2023-01-04 09:23:52 +01:00
Christian Heusel 1f1931fb00 fix spelling mistakes 2023-01-01 22:45:16 +01:00
Christian Heusel 711fe1d806 enumerate the config 2023-01-01 22:45:16 +01:00
Christian Heusel e2c62a7b0c document how to add new DNS records via extra_records 2023-01-01 22:45:16 +01:00
Avirut Mehta 549b82df11 Add Caddy instructions to reverse_proxy.md 2022-12-27 23:08:34 +01:00
Anoop Sundaresh 91900b7310 Update remote-cli.md
Fixing the local binary path
2022-12-19 19:16:48 +01:00
Juan Font 2770c7cc07 Initial proposal for better routing 2022-11-21 21:58:22 +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
Juan Font 935319a218 Remove mTLS from doc and config example 2022-11-19 19:50:34 +01:00
Till Hoffmann 701f990a23
Unify code snippet comment location 2022-10-22 00:12:24 +02:00
kevinlin 79864e0165 Fmt md with prettier 2022-10-15 00:11:57 +08:00
kevinlin 06e12f7020 Update: tips about warnning log 2022-10-15 00:11:05 +08:00
kevinlin 3659461666 Update reverse-proxy document for istio/envoy 2022-10-15 00:11:05 +08: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
Mike Lloyd e286ba817b Format reverse-proxy.md 2022-09-20 20:12:45 -07:00
Juan Font 44be239723
Merge branch 'main' into reverse-proxy 2022-09-20 23:16:21 +02: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
Mike Lloyd 0fe3c21223 Move map block out of server block 2022-09-06 16:12:20 -07:00
Mike Lloyd 45df6e77ff
Apply suggestions from code review
Thanks for the pointers!

Co-authored-by: Juan Font <juanfontalonso@gmail.com>
2022-09-06 15:37:39 -07:00
Juan Font 31662bcd28
Merge branch 'main' into reverse-proxy 2022-09-07 00:19:57 +02:00
Kristoffer Dalby 641c6fd439 Add logo files 2022-09-05 15:29:30 +02:00
Mike Lloyd 3a042471b7 Add web sockets section 2022-09-04 17:39:51 -07:00
Mike Lloyd dc18d64286 Add websockets config 2022-09-04 17:26:33 -07:00
Mike Lloyd 90e840c3c9 Add reverse proxy documentation 2022-09-04 09:42:23 -07:00
Juan Font Alonso dd3ec84000 Minor doc change 2022-09-03 12:22:03 +02: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
Juan Font 913a94d2ab
Merge branch 'main' into android-readme 2022-08-09 15:37:20 +02:00
Steve Malloy 2254ac2102 typo fixed from advertised to advertise 2022-08-05 15:44:11 -04:00
Juan Font 54e381cecb
Revert "Topic/speedup build" 2022-08-05 00:31:39 +02:00
Rasmus Moorats 10d566c946
add details on how to use the android app 2022-08-02 09:49:28 +03:00
ohdearaugustin 96221cc4f7 docs: add bulding container docs 2022-07-17 21:18:04 +02:00
Kristoffer Dalby 7cd0f5e8a4
Merge branch 'main' into acl-syntax-fixes 2022-06-11 14:14:21 +01:00
Jiang Zhu 2be16b581c 1) fix typo 2) another hard coded version 2022-06-11 17:23:01 +08:00
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