MyFavMirrors/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2025-11-22 02:25:25 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add API documentation

Browse Source 
Document the API endpoint and the built-in swagger docs at /swagger. The
remote control docs are just a use case for gRPC - move it in the API
docs and update links to it.
This commit is contained in:
Florian Preinstorfer
2025-10-26 09:12:53 +01:00
committed by nblock
parent 75247f82b8
commit 249630bed8
7 changed files with 136 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
docs/setup/requirements.md
View File

@@ -28,7 +28,7 @@ The ports in use vary with the intended scenario and enabled features. Some of t
- STUN, required if the [embedded DERP server](../ref/derp.md) is enabled
- tcp/50443
- Expose publicly: yes
- Only required if the gRPC interface is used to [remote-control Headscale](../ref/remote-cli.md).
- Only required if the gRPC interface is used to [remote-control Headscale](../ref/api.md#grpc).
- tcp/9090
- Expose publicly: no
- [Metrics and debug endpoint](../ref/debug.md#metrics-and-debug-endpoint)