TheArchive/headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2025-07-29 08:34:05 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: fix typos

Browse Source
This commit is contained in:
Luke Watts 2025-07-26 20:48:08 +02:00 committed by nblock
parent 9779adc0b7
commit b2a18830ed
2 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
docs/about/faq.md
View File

@ -51,11 +51,11 @@ is homelabbers and self-hosters. Of course, we do not prevent people from using
it in a commercial/professional setting and often get questions about scaling. it in a commercial/professional setting and often get questions about scaling.
Please note that when Headscale is developed, performance is not part of the Please note that when Headscale is developed, performance is not part of the
consideration as the main audience is considered to be users with a moddest consideration as the main audience is considered to be users with a modest
amount of devices. We focus on correctness and feature parity with Tailscale amount of devices. We focus on correctness and feature parity with Tailscale
SaaS over time. SaaS over time.
To understand if you might be able to use Headscale for your usecase, I will To understand if you might be able to use Headscale for your use case, I will
describe two scenarios in an effort to explain what is the central bottleneck describe two scenarios in an effort to explain what is the central bottleneck
of Headscale: of Headscale:
@ -94,14 +94,14 @@ learn about the current state of the world.
We expect that the performance will improve over time as we improve the code We expect that the performance will improve over time as we improve the code
base, but it is not a focus. In general, we will never make the tradeoff to make base, but it is not a focus. In general, we will never make the tradeoff to make
things faster on the cost of less maintainable or readable code. We are a small things faster on the cost of less maintainable or readable code. We are a small
team and have to optimise for maintainabillity. team and have to optimise for maintainability.
## Which database should I use? ## Which database should I use?
We recommend the use of SQLite as database for headscale: We recommend the use of SQLite as database for headscale:
- SQLite is simple to setup and easy to use - SQLite is simple to setup and easy to use
- It scales well for all of headscale's usecases - It scales well for all of headscale's use cases
- Development and testing happens primarily on SQLite - Development and testing happens primarily on SQLite
- PostgreSQL is still supported, but is considered to be in "maintenance mode" - PostgreSQL is still supported, but is considered to be in "maintenance mode"

4
docs/ref/oidc.md
View File

@ -2,7 +2,7 @@
Headscale supports authentication via external identity providers using OpenID Connect (OIDC). It features: Headscale supports authentication via external identity providers using OpenID Connect (OIDC). It features:
- Autoconfiguration via OpenID Connect Discovery Protocol - Auto configuration via OpenID Connect Discovery Protocol
- [Proof Key for Code Exchange (PKCE) code verification](#enable-pkce-recommended) - [Proof Key for Code Exchange (PKCE) code verification](#enable-pkce-recommended)
- [Authorization based on a user's domain, email address or group membership](#authorize-users-with-filters) - [Authorization based on a user's domain, email address or group membership](#authorize-users-with-filters)
- Synchronization of [standard OIDC claims](#supported-oidc-claims) - Synchronization of [standard OIDC claims](#supported-oidc-claims)
@ -142,7 +142,7 @@ Access Token.
=== "Use expiration from Access Token" === "Use expiration from Access Token"
Please keep in mind that the Access Token is typically a short-lived token that expires within a few minutes. You Please keep in mind that the Access Token is typically a short-lived token that expires within a few minutes. You
will have to configure token expiration in your identity provider to avoid frequent reauthentication. will have to configure token expiration in your identity provider to avoid frequent re-authentication.
```yaml hl_lines="5" ```yaml hl_lines="5"