Commit Graph

163 Commits

Author SHA1 Message Date
nblock 8c7d8ee34f
Restructure headscale documentation (#2163)
* Setup mkdocs-redirects

* Restructure existing documentation

* Move client OS support into the documentation

* Move existing Client OS support table into its own documentation page
* Link from README.md to the rendered documentation
* Document minimum Tailscale client version

* Reuse CONTRIBUTING.md" in the documentation

* Include "CONTRIBUTING.md" from the repository root
* Update FAQ and index page and link to the contributing docs

* Add configuration reference

* Add a getting started page and explain the first steps with headscale

* Use the existing "Using headscale" sections and combine them into a
  single getting started guide with a little bit more explanation.
* Explain how to get help from the command line client.
* Remove duplicated sections from existing installation guides

* Document requirements and assumptions

* Document packages provided by the community

* Move deb install guide to official releases

* Move manual install guide to official releases

* Move container documentation to setup section

* Move sealos documentation to cloud install page

* Move OpenBSD docs to build from source

* Simplify DNS documentation

* Add sponsor page

* Add releases page

* Add features page

* Add help page

* Add upgrading page

* Adjust mkdocs nav

* Update wording

Use the term headscale for the project, Headscale on the beginning of a
sentence and `headscale` when refering to the CLI.

* Welcome to headscale

* Link to existing documentation in the FAQ

* Remove the goal header and use the text as opener

* Indent code block in OIDC

* Make a few pages linter compatible

Also update ignored files for prettier

* Recommend HTTPS on port 443

Fixes: #2164

* Use hosts in acl documentation

thx @efficacy38 for noticing this

Ref: #1863

* Use mkdocs-macros to set headscale version once
2024-10-10 15:24:04 +02:00
nblock c3ef90a7f7
Update documentation for Apple (#2117)
* Rename docs/ios-client.md to docs/apple-client.md. Add instructions
  for macOS; those are copied from the /apple endpoint and slightly
  modified. Fix doc links in the README.
* Move infoboxes for /apple and /windows under the "Goal" section to the
  top. Those should be seen by users first as they contain *their*
  specific headscale URL.
* Swap order of macOS and iOS to move "Profiles" further down.
* Remove apple configuration profiles
* Remove Tailscale versions hints
* Mention /apple and /windows in the README along with their docs

See: #2096
2024-09-11 18:43:59 +02:00
Kristoffer Dalby 1193a50e9e
oldest client supported, not latest (#2086) 2024-08-30 16:59:37 +02:00
Stefan Majer 8185a70dc7
Fix typos (#1860)
* Fix typos

* trigger GitHub actions

* remove kdiff3 orig files

* fix unicode

* remove unnecessary function call

* remove unnecessary comment

* remove unnecessary comment

---------

Co-authored-by: ohdearaugustin <ohdearaugustin@users.noreply.github.com>
2024-05-19 23:49:27 +02:00
Juan Font 10e37ec28d Add contributing document 2024-04-29 23:04:02 +02:00
Juan Font aba4b36030
Clarify relation with Tailscale (#1908) 2024-04-22 20:37:59 +02:00
Arnaud Dezandee 803269a64c
docs(readme): change contributors section (#1889) 2024-04-21 16:48:33 +02:00
github-actions[bot] 20bf3777d3
docs(README): update contributors (#1834)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2024-03-19 22:39:43 +01:00
github-actions[bot] b359939812
docs(README): update contributors (#1639)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2023-12-10 08:56:01 +01:00
github-actions[bot] 2af71c9e31
docs(README): update contributors (#1592)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2023-11-06 14:07:35 +01:00
github-actions[bot] 6cd0f77511
docs(README): update contributors (#1558)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
2023-09-24 14:34:53 -07:00
github-actions[bot] 699655a93f docs(README): update contributors 2023-05-27 16:21:42 +02:00
Juan Font 997e93455d Added web ui section
Added discord
2023-05-10 16:16:12 +02:00
Kristoffer Dalby ba45d7dbd3
update readme and templates to clarify scope (#1437)
Co-authored-by: Juan Font <juanfontalonso@gmail.com>
2023-05-10 08:03:13 +01:00
loprima-l 0f8d8fc2d8 Fix : Updating the doc path
Updating the doc path to be the doc website url as it's a better documentation tool
2023-04-30 22:56:38 +02:00
github-actions[bot] d08fee78c3
docs(README): update contributors (#1325) 2023-04-07 17:31:29 +02:00
nicholas-yap 003036a779
Update iOS compatibility and added iOS docs (#1264) 2023-03-17 15:56:15 +01:00
github-actions[bot] ed79f977a7
docs(README): update contributors (#1262) 2023-03-17 10:07:39 +01:00
Albert Copeland c9ecdd6ef1
Add Graphical Control Panels section to README (#1226) 2023-03-03 19:05:12 +01:00
Kristoffer Dalby 6950ff7841 Add list of talks to the readme
Signed-off-by: Kristoffer Dalby <kristoffer@tailscale.com>
2023-02-07 17:04:14 +01:00
github-actions[bot] 1faac0b3d7 docs(README): update contributors 2022-12-07 15:18:37 +01:00
github-actions[bot] d1bca105ef docs(README): update contributors 2022-12-05 22:05:25 +01:00
github-actions[bot] 91559d0558 docs(README): update contributors 2022-11-25 08:58:13 +01:00
github-actions[bot] d6b383dd2f docs(README): update contributors 2022-11-05 16:03:17 +01:00
github-actions[bot] b22e628b49
docs(README): update contributors 2022-10-23 14:33:02 +00:00
github-actions[bot] 72e2fa46c7
docs(README): update contributors 2022-09-30 08:23:20 +00:00
Kristoffer Dalby 002d484abe use logo in readme correcly 2022-09-05 15:31:03 +02:00
Kristoffer Dalby 9823ef2af5 use logo in readme 2022-09-05 15:30:19 +02:00
github-actions[bot] 20970b580a
docs(README): update contributors 2022-08-22 12:47:42 +00:00
github-actions[bot] d56b409cb9
docs(README): update contributors 2022-08-13 20:44:38 +00:00
Rasmus Moorats 10d566c946
add details on how to use the android app 2022-08-02 09:49:28 +03:00
github-actions[bot] 936adb7d2c
docs(README): update contributors 2022-07-22 07:36:16 +00:00
github-actions[bot] 02c7a46b97
docs(README): update contributors 2022-07-20 07:21:19 +00:00
github-actions[bot] b8c3387892
docs(README): update contributors 2022-07-12 11:35:28 +00:00
github-actions[bot] 7ae38346e5
docs(README): update contributors 2022-06-26 08:22:05 +00:00
github-actions[bot] 360488abb4
docs(README): update contributors 2022-06-16 13:08:07 +00:00
github-actions[bot] 28a3a5bd61
docs(README): update contributors 2022-06-12 17:00:23 +00:00
github-actions[bot] e5f26f819a
docs(README): update contributors 2022-06-11 14:35:56 +00:00
github-actions[bot] 17d4968425
docs(README): update contributors 2022-06-07 06:16:00 +00:00
github-actions[bot] 571ce2b0b9
docs(README): update contributors 2022-06-03 08:49:19 +00:00
github-actions[bot] f7f722af52
docs(README): update contributors 2022-05-29 14:49:25 +00:00
github-actions[bot] bec35b4965
docs(README): update contributors 2022-05-29 11:03:33 +00:00
github-actions[bot] 6c903d2d93
docs(README): update contributors 2022-05-29 10:23:00 +00:00
Pavlos Vinieratos fff1011ed8
typo 2022-05-28 20:46:01 +03:00
github-actions[bot] 31bdba7456
docs(README): update contributors 2022-05-08 21:57:04 +00:00
github-actions[bot] 00535a2016
docs(README): update contributors 2022-05-02 21:12:01 +00:00
Kristoffer Dalby cd9807a1d3
Merge branch 'main' into flake-build-env 2022-04-22 07:52:29 +01:00
github-actions[bot] c8ed1f0f43
docs(README): update contributors 2022-04-21 11:51:30 +00:00
Kristoffer Dalby 5c285afda5
Merge branch 'main' into flake-build-env 2022-04-21 09:21:10 +01:00
Kristoffer Dalby 580c72bf16 Update discord link so it does not grant temp memberships 2022-04-21 09:06:30 +01:00