Mirrors/juanfont.headscale
1
0
Fork 0
mirror of https://github.com/juanfont/headscale.git synced 2025-10-10 11:14:24 +02:00
Code Issues Projects Releases Wiki Activity
cbe2483d45
juanfont.headscale/docs/setup/requirements.md
Florian Preinstorfer ba5b944426 Document requirements and assumptions
2024-10-09 15:41:54 +02:00

1.0 KiB
Raw Blame History

Requirements

Headscale should just work as long as the following requirements are met:

  • A server with a public IP address for headscale. A dual-stack setup with a public IPv4 and a public IPv6 address is recommended.
  • A reasonably modern Linux or BSD based operating system.
  • A dedicated user account to run headscale.
  • A little bit of command line knowledge to configure and operate headscale.

Assumptions

The headscale documentation and the provided examples are written with a few assumptions in mind:

  • Headscale is running as system service via a dedicated user headscale.
  • The configuration is loaded from /etc/headscale/config.yaml.
  • SQLite is used as database.
  • The data directory for headscale (used for private keys, ACLs, SQLite database, …) is located in /var/lib/headscale.
  • URLs and values that need to be replaced by the user are either denoted as <VALUE_TO_CHANGE> or use placeholder values such as headscale.example.com.

Please adjust to your local environment accordingly.