-
-
Notifications
You must be signed in to change notification settings - Fork 1.3k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Linux installation documentation update #2054
Open
labeneator
wants to merge
4
commits into
juanfont:main
Choose a base branch
from
labeneator:main
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 2 commits
Commits
Show all changes
4 commits
Select commit
Hold shift + click to select a range
3460ed6
easier to use bash one liners to download the latest headscale versio…
labeneator 866b481
cosmetic updates for the markdown file
labeneator 99563e5
removing config-example.yaml in favour of the existing one
labeneator 641e676
bugfix - extra pipe removed
labeneator File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -24,7 +24,13 @@ configuration (`/etc/headscale/config.yaml`). | |
|
||
```shell | ||
HEADSCALE_VERSION="" # See above URL for latest version, e.g. "X.Y.Z" (NOTE: do not add the "v" prefix!) | ||
# Or you can use the following bash one liner | ||
# HEADSCALE_VERSION="$(curl -v https://github.com/juanfont/headscale/releases/latest 2>&1 |grep location | awk -F'/' '{print $NF}' | sed -e 's/v//' | |tr -d '\r')" | ||
|
||
HEADSCALE_ARCH="" # Your system architecture, e.g. "amd64" | ||
# Or you can use: | ||
# HEADSCALE_ARCH="$(dpkg --print-architecture)" | ||
|
||
wget --output-document=headscale.deb \ | ||
"https://github.com/juanfont/headscale/releases/download/v${HEADSCALE_VERSION}/headscale_${HEADSCALE_VERSION}_linux_${HEADSCALE_ARCH}.deb" | ||
``` | ||
|
@@ -95,3 +101,107 @@ connect a node to `headscale` during the `tailscale` command: | |
```shell | ||
tailscale up --login-server <YOUR_HEADSCALE_URL> --authkey <YOUR_AUTH_KEY> | ||
``` | ||
|
||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. We normally refer anyway to the config-example.yaml. I don't want to maintain another example config. |
||
# Sample config.yml | ||
|
||
A sane config.yml might look like this | ||
|
||
```yaml | ||
--- | ||
|
||
# Remember to punch a hole in your firewall for this port | ||
server_url: https://headscale.example.com:28000 | ||
|
||
listen_addr: 0.0.0.0:28000 | ||
|
||
metrics_listen_addr: 127.0.0.1:9090 | ||
|
||
grpc_listen_addr: 127.0.0.1:50443 | ||
|
||
grpc_allow_insecure: false | ||
|
||
private_key_path: /var/lib/headscale/private.key | ||
|
||
noise: | ||
private_key_path: /var/lib/headscale/noise_private.key | ||
|
||
ip_prefixes: | ||
- fd7a:115c:a1e0::/48 | ||
- 100.64.0.0/10 | ||
|
||
derp: | ||
server: | ||
enabled: false | ||
|
||
region_id: 999 | ||
|
||
region_code: "headscale" | ||
region_name: "Headscale Embedded DERP" | ||
|
||
stun_listen_addr: "0.0.0.0:3478" | ||
|
||
urls: | ||
- https://controlplane.tailscale.com/derpmap/default | ||
|
||
paths: [] | ||
|
||
auto_update_enabled: true | ||
|
||
update_frequency: 24h | ||
|
||
disable_check_updates: false | ||
|
||
ephemeral_node_inactivity_timeout: 30m | ||
|
||
node_update_check_interval: 10s | ||
|
||
db_type: sqlite3 | ||
|
||
db_path: /var/lib/headscale/db.sqlite | ||
|
||
|
||
|
||
acme_url: https://acme-v02.api.letsencrypt.org/directory | ||
|
||
acme_email: "contact@example.com" | ||
|
||
|
||
tls_letsencrypt_cache_dir: /var/lib/headscale/cache | ||
|
||
tls_letsencrypt_challenge_type: HTTP-01 | ||
tls_letsencrypt_listen: ":http" | ||
|
||
# Provisioned via certbot | ||
tls_cert_path: "/etc/letsencrypt/live/headscale.example.com/fullchain.pem" | ||
tls_key_path: "/etc/letsencrypt/live/headscale.example.com/privkey.pem" | ||
|
||
log: | ||
format: text | ||
level: info | ||
|
||
acl_policy_path: "" | ||
|
||
dns_config: | ||
override_local_dns: true | ||
|
||
nameservers: | ||
- 9.9.9.9 | ||
- 1.1.1.1 | ||
|
||
|
||
|
||
domains: [] | ||
|
||
|
||
magic_dns: true | ||
|
||
base_domain: example.com | ||
|
||
unix_socket: /var/run/headscale/headscale.sock | ||
unix_socket_permission: "0770" | ||
|
||
logtail: | ||
enabled: false | ||
|
||
randomize_client_port: false | ||
``` |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fixed the shell call