commit 6d6f6e52996dbd011471aeaa33a8191a26517b9d Author: Timmy Date: Tue Mar 24 10:08:28 2026 +0800 Initial commit: Headscale management scripts and configuration - Add headscale binary and configuration files - Include management scripts for API keys, nodes, and authentication - Add Docker setup with docker-compose - Include backup and restore functionality - Add example scripts for creating API keys and pre-auth keys Co-Authored-By: Claude Haiku 4.5 diff --git a/Makefile b/Makefile new file mode 100644 index 0000000..76a0331 --- /dev/null +++ b/Makefile @@ -0,0 +1,55 @@ +# Makefile: 適用於 docker-compose 專案，自動取用當前資料夾為專案名 + +COMPOSE := docker-compose +COMPOSE_FILE := docker-compose.yml +PROJECT_NAME := $(notdir $(CURDIR)) # 依照當前資料夾自動命名 + +# 可選自訂 .env 變數（預設 docker-compose 自動載入） +# ENV_FILE := .env + +.PHONY: help up down build restart logs ps exec clean prune + +help: + @echo "🔧 Docker Compose Makefile 指令：" + @echo " make up - 啟動所有服務 (背景執行)" + @echo " make up-fg - 前景執行（方便除錯）" + @echo " make down - 停止並移除服務容器" + @echo " make build - 重新建構服務映像檔" + @echo " make restart - 重啟所有服務" + @echo " make logs - 查看服務日誌" + @echo " make ps - 顯示服務狀態" + @echo " make exec - 進入主要容器 shell" + @echo " make clean - 清理所有服務資料（含 volume）" + @echo " make prune - 清除未使用的資源" + +up: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) up -d + +up-fg: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) up + +down: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) down + +build: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) build + +restart: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) down + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) up -d + +logs: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) logs -f --tail=100 + +ps: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) ps + +exec: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) exec app sh + +clean: + $(COMPOSE) -p $(PROJECT_NAME) -f $(COMPOSE_FILE) down -v --remove-orphans + +prune: + docker system prune -af --volumes + diff --git a/README b/README new file mode 100644 index 0000000..35dfe1d --- /dev/null +++ b/README @@ -0,0 +1,107 @@ +https://headscale.lotimmy.com + +docker network create shared-net + +# Create a pre-auth key +headscale preauthkeys create --user 1 --reusable --ephemeral=false --expiration 24h + +# Create a pre-auth key with long expiration +headscale preauthkeys create --user 1 --reusable --ephemeral=false --expiration 87600h + +headscale preauthkeys create \ + --user 1 \ # 給 ID 是 1 的人用（記得先用 list 查 ID） + --reusable \ # 拿到這組 key，你想裝幾台機器都可以，不用換 + --ephemeral=false \ # 機器離線後名字還是會留著，不會被系統踢掉 + --expiration 87600h # 有效期開到最滿（10 年），懶人必備，不用每年重弄 + + +HS_十年金鑰 +2026-01-14T03:31:35Z TRC expiration has been set expiration=315360000000 +ef127d5251adc78d0250f869d00e5454e40612ba47f4ce80 + + +tailscale up --login-server <你的網址> --auth-key <指令產生的金鑰> +tailscale up --login-server https://headscale.lotimmy.com --auth-key ef127d5251adc78d0250f869d00e5454e40612ba47f4ce80 +tailscale up --login-server https://headscale.lotimmy.com --auth-key ef127d5251adc78d0250f869d00e5454e40612ba47f4ce80 --accept-routes + +# Register a node +headscale nodes register --user USERNAME --key 2HdYHEaOQ30UUckHXt_dBYZr +headscale nodes register --user mainnet --key tzDlexiDOMMIOlJUlkQUADTy +headscale nodes register --user mainnet --key WxG-YH2yUTAz4Vf5bJaiJxG4 +headscale nodes register --user mainnet --key xi1HU_5AJqJXdKIhLY4E8WiU +headscale nodes register --user mainnet --key t1o75XesCYNkVJxUnm-VNIst +headscale nodes register --user mainnet --key lvfjwzg2KeISpdJtMtqMNeFN +headscale nodes register --user mainnet --key 4L66v9uDIuzJdgeo4dupGLfL +headscale nodes register --key 7oLjwdXp0OyIlrRbEZr35Gwv --user mainnet + +# List routes +headscale nodes list-routes + +# Approve routes +headscale nodes approve-routes --identifier 3 --routes 0.0.0.0/0,::/0 +headscale nodes approve-routes --identifier 4 --routes 0.0.0.0/0,192.168.42.0/24,::/0 +headscale nodes approve-routes --identifier 33 --routes 0.0.0.0/0,192.168.42.0/24,::/0 +headscale nodes approve-routes --identifier 5 --routes 192.168.42.0/24 +headscale nodes approve-routes --identifier 6 --routes 0.0.0.0/0,192.168.88.0/24,::/0 +headscale nodes approve-routes --identifier 19 --routes 0.0.0.0/0,192.168.88.0/24,::/0 + +# List all nodes +headscale nodes list +headscale nodes list --output json | jq '.[] | {id, name, tags: .forced_tags}' + + +# Rename nodes +headscale nodes rename --identifier 2 iphone-15-pro-max +headscale nodes rename --identifier 4 ip-192-168-42-102 +headscale nodes rename --identifier 5 apple-tv-bedroom +headscale nodes rename --identifier 7 ipad-mini-6 +headscale nodes rename --identifier 7 iphone-12 +headscale nodes rename --identifier 38 galaxy-tab-a + +# Delete node 6 +headscale nodes delete --identifier 6 +headscale nodes delete --identifier 6 --force + +# List pre-auth keys +headscale preauthkeys list --user 1 + + +# List API keys +headscale apikeys list + +# Revoke API key +headscale apikeys revoke + +# 為指定節點加上 server 或 mobile 的 tag +headscale nodes tag --identifier 4 --tags tag:server # ct102 +headscale nodes tag --identifier 9 --tags tag:server # 15-macbook-pro +headscale nodes tag --identifier 12 --tags tag:server # ip-192-168-88-82 +headscale nodes tag --identifier 13 --tags tag:server # ip-141-11-93-252 + +headscale nodes tag --identifier 2 --tags tag:mobile # iphone-15-pro-max +headscale nodes tag --identifier 5 --tags tag:mobile # apple-tv-bedroom +headscale nodes tag --identifier 7 --tags tag:mobile # ipad-mini-6 +headscale nodes tag --identifier 8 --tags tag:mobile # oppo-a74-5g +headscale nodes tag --identifier 11 --tags tag:mobile # iphone-xr + +# 移除指定節點（ID 13）的所有 tags +headscale nodes tag --identifier 13 --tags "" + + +# 查看所有使用者 +headscale users list + +# 將 ID 1 的使用者（namespace）改名為 mainnet +headscale users rename --identifier 1 --new-name mainnet + + +# ping 內部 tailnet 節點（例：100.64.0.4） +tailscale ping 100.64.0.4 + + + +tailscale up --reset \ + --login-server https://headscale.lotimmy.com \ + --advertise-exit-node \ + --advertise-routes=192.168.42.0/24 \ + --accept-routes=false diff --git a/api_user_request.sh b/api_user_request.sh new file mode 100755 index 0000000..d3f7851 --- /dev/null +++ b/api_user_request.sh @@ -0,0 +1,27 @@ +#!/bin/bash + +# 定義變數以便於管理 +API_URL="http://localhost:8080/api/v1/user" +AUTH_TOKEN="Bearer -YSEvxm.BAy6LySE1-WXm4MbsYoBxlI-5NpCPp70" + +# 使用 curl 發送 HTTP 請求，帶有授權標頭 +# -s: 靜默模式，不顯示進度條 +# -f: 如果伺服器返回錯誤狀態碼，則失敗並返回非零狀態 +# -o /dev/null: 將輸出丟棄（如果不需要顯示響應內容） +# -w: 輸出 HTTP 狀態碼以便檢查 +response_status=$(curl -s -f -X GET \ + -H "Authorization: $AUTH_TOKEN" \ + "$API_URL" \ + -w "%{http_code}" \ + -o /dev/null) + +# 檢查請求是否成功 +if [ "$response_status" -eq 200 ]; then + echo "Request successful (Status: $response_status)" + # 如果需要顯示響應內容，可以移除 -o /dev/null 並直接輸出 + # curl -s -X GET -H "Authorization: $AUTH_TOKEN" "$API_URL" +else + echo "Request failed (Status: $response_status)" + exit 1 +fi + diff --git a/config/config.yaml b/config/config.yaml new file mode 100644 index 0000000..e6221ad --- /dev/null +++ b/config/config.yaml @@ -0,0 +1,409 @@ +--- +# headscale will look for a configuration file named `config.yaml` (or `config.json`) in the following order: +# +# - `/etc/headscale` +# - `~/.headscale` +# - current working directory + +# The url clients will connect to. +# Typically this will be a domain like: +# +# https://myheadscale.example.com:443 +# +# server_url: http://127.0.0.1:8080 +server_url: https://headscale.lotimmy.com + +# Address to listen to / bind to on the server +# +# For production: +listen_addr: 0.0.0.0:8080 +# listen_addr: 127.0.0.1:8080 + +# Address to listen to /metrics and /debug, you may want +# to keep this endpoint private to your internal network +# metrics_listen_addr: 127.0.0.1:9090 +metrics_listen_addr: 0.0.0.0:9090 + +# Address to listen for gRPC. +# gRPC is used for controlling a headscale server +# remotely with the CLI +# Note: Remote access _only_ works if you have +# valid certificates. +# +# For production: +grpc_listen_addr: 0.0.0.0:50443 +# grpc_listen_addr: 127.0.0.1:50443 + +# Allow the gRPC admin interface to run in INSECURE +# mode. This is not recommended as the traffic will +# be unencrypted. Only enable if you know what you +# are doing. +grpc_allow_insecure: false + +# The Noise section includes specific configuration for the +# TS2021 Noise protocol +noise: + # The Noise private key is used to encrypt the traffic between headscale and + # Tailscale clients when using the new Noise-based protocol. A missing key + # will be automatically generated. + private_key_path: /var/lib/headscale/noise_private.key + +# List of IP prefixes to allocate tailaddresses from. +# Each prefix consists of either an IPv4 or IPv6 address, +# and the associated prefix length, delimited by a slash. +# It must be within IP ranges supported by the Tailscale +# client - i.e., subnets of 100.64.0.0/10 and fd7a:115c:a1e0::/48. +# See below: +# IPv6: https://github.com/tailscale/tailscale/blob/22ebb25e833264f58d7c3f534a8b166894a89536/net/tsaddr/tsaddr.go#LL81C52-L81C71 +# IPv4: https://github.com/tailscale/tailscale/blob/22ebb25e833264f58d7c3f534a8b166894a89536/net/tsaddr/tsaddr.go#L33 +# Any other range is NOT supported, and it will cause unexpected issues. +prefixes: + v4: 100.64.0.0/10 + v6: fd7a:115c:a1e0::/48 + + # Strategy used for allocation of IPs to nodes, available options: + # - sequential (default): assigns the next free IP from the previous given IP. + # - random: assigns the next free IP from a pseudo-random IP generator (crypto/rand). + allocation: sequential + +# DERP is a relay system that Tailscale uses when a direct +# connection cannot be established. +# https://tailscale.com/blog/how-tailscale-works/#encrypted-tcp-relays-derp +# +# headscale needs a list of DERP servers that can be presented +# to the clients. +derp: + server: + # If enabled, runs the embedded DERP server and merges it into the rest of the DERP config + # The Headscale server_url defined above MUST be using https, DERP requires TLS to be in place + enabled: false + + # Region ID to use for the embedded DERP server. + # The local DERP prevails if the region ID collides with other region ID coming from + # the regular DERP config. + region_id: 999 + + # Region code and name are displayed in the Tailscale UI to identify a DERP region + region_code: "headscale" + region_name: "Headscale Embedded DERP" + + # Listens over UDP at the configured address for STUN connections - to help with NAT traversal. + # When the embedded DERP server is enabled stun_listen_addr MUST be defined. + # + # For more details on how this works, check this great article: https://tailscale.com/blog/how-tailscale-works/ + stun_listen_addr: "0.0.0.0:3478" + + # Private key used to encrypt the traffic between headscale DERP and + # Tailscale clients. A missing key will be automatically generated. + private_key_path: /var/lib/headscale/derp_server_private.key + + # This flag can be used, so the DERP map entry for the embedded DERP server is not written automatically, + # it enables the creation of your very own DERP map entry using a locally available file with the parameter DERP.paths + # If you enable the DERP server and set this to false, it is required to add the DERP server to the DERP map using DERP.paths + automatically_add_embedded_derp_region: true + + # For better connection stability (especially when using an Exit-Node and DNS is not working), + # it is possible to optionally add the public IPv4 and IPv6 address to the Derp-Map using: + ipv4: 1.2.3.4 + ipv6: 2001:db8::1 + + # List of externally available DERP maps encoded in JSON + urls: + - https://controlplane.tailscale.com/derpmap/default + + # Locally available DERP map files encoded in YAML + # + # This option is mostly interesting for people hosting + # their own DERP servers: + # https://tailscale.com/kb/1118/custom-derp-servers/ + # + # paths: + # - /etc/headscale/derp-example.yaml + paths: [] + + # If enabled, a worker will be set up to periodically + # refresh the given sources and update the derpmap + # will be set up. + auto_update_enabled: true + + # How often should we check for DERP updates? + update_frequency: 24h + +# Disables the automatic check for headscale updates on startup +disable_check_updates: false + +# Time before an inactive ephemeral node is deleted? +ephemeral_node_inactivity_timeout: 30m + +database: + # Database type. Available options: sqlite, postgres + # Please note that using Postgres is highly discouraged as it is only supported for legacy reasons. + # All new development, testing and optimisations are done with SQLite in mind. + type: sqlite + + # Enable debug mode. This setting requires the log.level to be set to "debug" or "trace". + debug: false + + # GORM configuration settings. + gorm: + # Enable prepared statements. + prepare_stmt: true + + # Enable parameterized queries. + parameterized_queries: true + + # Skip logging "record not found" errors. + skip_err_record_not_found: true + + # Threshold for slow queries in milliseconds. + slow_threshold: 1000 + + # SQLite config + sqlite: + path: /var/lib/headscale/db.sqlite + + # Enable WAL mode for SQLite. This is recommended for production environments. + # https://www.sqlite.org/wal.html + write_ahead_log: true + + # Maximum number of WAL file frames before the WAL file is automatically checkpointed. + # https://www.sqlite.org/c3ref/wal_autocheckpoint.html + # Set to 0 to disable automatic checkpointing. + wal_autocheckpoint: 1000 + + # # Postgres config + # Please note that using Postgres is highly discouraged as it is only supported for legacy reasons. + # See database.type for more information. + # postgres: + # # If using a Unix socket to connect to Postgres, set the socket path in the 'host' field and leave 'port' blank. + # host: localhost + # port: 5432 + # name: headscale + # user: foo + # pass: bar + # max_open_conns: 10 + # max_idle_conns: 10 + # conn_max_idle_time_secs: 3600 + + # # If other 'sslmode' is required instead of 'require(true)' and 'disabled(false)', set the 'sslmode' you need + # # in the 'ssl' field. Refers to https://www.postgresql.org/docs/current/libpq-ssl.html Table 34.1. + # ssl: false + +### TLS configuration +# +## Let's encrypt / ACME +# +# headscale supports automatically requesting and setting up +# TLS for a domain with Let's Encrypt. +# +# URL to ACME directory +acme_url: https://acme-v02.api.letsencrypt.org/directory + +# Email to register with ACME provider +acme_email: "" + +# Domain name to request a TLS certificate for: +tls_letsencrypt_hostname: "" + +# Path to store certificates and metadata needed by +# letsencrypt +# For production: +tls_letsencrypt_cache_dir: /var/lib/headscale/cache + +# Type of ACME challenge to use, currently supported types: +# HTTP-01 or TLS-ALPN-01 +# See: docs/ref/tls.md for more information +tls_letsencrypt_challenge_type: HTTP-01 +# When HTTP-01 challenge is chosen, letsencrypt must set up a +# verification endpoint, and it will be listening on: +# :http = port 80 +tls_letsencrypt_listen: ":http" + +## Use already defined certificates: +tls_cert_path: "" +tls_key_path: "" + +log: + # Output formatting for logs: text or json + format: text + level: info + +## Policy +# headscale supports Tailscale's ACL policies. +# Please have a look to their KB to better +# understand the concepts: https://tailscale.com/kb/1018/acls/ +policy: + # The mode can be "file" or "database" that defines + # where the ACL policies are stored and read from. + mode: file + # If the mode is set to "file", the path to a + # HuJSON file containing ACL policies. + path: "" + + +## DNS +# +# headscale supports Tailscale's DNS configuration and MagicDNS. +# Please have a look to their KB to better understand the concepts: +# +# - https://tailscale.com/kb/1054/dns/ +# - https://tailscale.com/kb/1081/magicdns/ +# - https://tailscale.com/blog/2021-09-private-dns-with-magicdns/ +# +# Please note that for the DNS configuration to have any effect, +# clients must have the `--accept-dns=true` option enabled. This is the +# default for the Tailscale client. This option is enabled by default +# in the Tailscale client. +# +# Setting _any_ of the configuration and `--accept-dns=true` on the +# clients will integrate with the DNS manager on the client or +# overwrite /etc/resolv.conf. +# https://tailscale.com/kb/1235/resolv-conf +# +# If you want stop Headscale from managing the DNS configuration +# all the fields under `dns` should be set to empty values. +dns: + # Whether to use [MagicDNS](https://tailscale.com/kb/1081/magicdns/). + magic_dns: true + + # Defines the base domain to create the hostnames for MagicDNS. + # This domain _must_ be different from the server_url domain. + # `base_domain` must be a FQDN, without the trailing dot. + # The FQDN of the hosts will be + # `hostname.base_domain` (e.g., _myhost.example.com_). + # base_domain: example.com + base_domain: internal.lotimmy.com + + # Whether to use the local DNS settings of a node (default) or override the + # local DNS settings and force the use of Headscale's DNS configuration. + override_local_dns: false + + # List of DNS servers to expose to clients. + nameservers: + global: + - 1.1.1.1 + - 1.0.0.1 + - 2606:4700:4700::1111 + - 2606:4700:4700::1001 + + # NextDNS (see https://tailscale.com/kb/1218/nextdns/). + # "abc123" is example NextDNS ID, replace with yours. + # - https://dns.nextdns.io/abc123 + + # Split DNS (see https://tailscale.com/kb/1054/dns/), + # a map of domains and which DNS server to use for each. + split: + {} + # foo.bar.com: + # - 1.1.1.1 + # darp.headscale.net: + # - 1.1.1.1 + # - 8.8.8.8 + + # Set custom DNS search domains. With MagicDNS enabled, + # your tailnet base_domain is always the first search domain. + search_domains: [] + + # Extra DNS records + # so far only A and AAAA records are supported (on the tailscale side) + # See: docs/ref/dns.md + extra_records: [] + # - name: "grafana.myvpn.example.com" + # type: "A" + # value: "100.64.0.3" + # + # # you can also put it in one line + # - { name: "prometheus.myvpn.example.com", type: "A", value: "100.64.0.3" } + # + # Alternatively, extra DNS records can be loaded from a JSON file. + # Headscale processes this file on each change. + # extra_records_path: /var/lib/headscale/extra-records.json + +# Unix socket used for the CLI to connect without authentication +# Note: for production you will want to set this to something like: +unix_socket: /var/run/headscale/headscale.sock +unix_socket_permission: "0770" +# +# headscale supports experimental OpenID connect support, +# it is still being tested and might have some bugs, please +# help us test it. +# OpenID Connect +# oidc: +# only_start_if_oidc_is_available: true +# issuer: "https://your-oidc.issuer.com/path" +# client_id: "your-oidc-client-id" +# client_secret: "your-oidc-client-secret" +# # Alternatively, set `client_secret_path` to read the secret from the file. +# # It resolves environment variables, making integration to systemd's +# # `LoadCredential` straightforward: +# client_secret_path: "${CREDENTIALS_DIRECTORY}/oidc_client_secret" +# # client_secret and client_secret_path are mutually exclusive. +# +# # The amount of time from a node is authenticated with OpenID until it +# # expires and needs to reauthenticate. +# # Setting the value to "0" will mean no expiry. +# expiry: 180d +# +# # Use the expiry from the token received from OpenID when the user logged +# # in, this will typically lead to frequent need to reauthenticate and should +# # only been enabled if you know what you are doing. +# # Note: enabling this will cause `oidc.expiry` to be ignored. +# use_expiry_from_token: false +# +# # Customize the scopes used in the OIDC flow, defaults to "openid", "profile" and "email" and add custom query +# # parameters to the Authorize Endpoint request. Scopes default to "openid", "profile" and "email". +# +# scope: ["openid", "profile", "email", "custom"] +# extra_params: +# domain_hint: example.com +# +# # List allowed principal domains and/or users. If an authenticated user's domain is not in this list, the +# # authentication request will be rejected. +# +# allowed_domains: +# - example.com +# # Note: Groups from keycloak have a leading '/' +# allowed_groups: +# - /headscale +# allowed_users: +# - alice@example.com +# +# # Optional: PKCE (Proof Key for Code Exchange) configuration +# # PKCE adds an additional layer of security to the OAuth 2.0 authorization code flow +# # by preventing authorization code interception attacks +# # See https://datatracker.ietf.org/doc/html/rfc7636 +# pkce: +# # Enable or disable PKCE support (default: false) +# enabled: false +# # PKCE method to use: +# # - plain: Use plain code verifier +# # - S256: Use SHA256 hashed code verifier (default, recommended) +# method: S256 +# +# # Map legacy users from pre-0.24.0 versions of headscale to the new OIDC users +# # by taking the username from the legacy user and matching it with the username +# # provided by the OIDC. This is useful when migrating from legacy users to OIDC +# # to force them using the unique identifier from the OIDC and to give them a +# # proper display name and picture if available. +# # Note that this will only work if the username from the legacy user is the same +# # and there is a possibility for account takeover should a username have changed +# # with the provider. +# # When this feature is disabled, it will cause all new logins to be created as new users. +# # Note this option will be removed in the future and should be set to false +# # on all new installations, or when all users have logged in with OIDC once. +# map_legacy_users: false + +# Logtail configuration +# Logtail is Tailscales logging and auditing infrastructure, it allows the control panel +# to instruct tailscale nodes to log their activity to a remote server. +logtail: + # Enable logtail for this headscales clients. + # As there is currently no support for overriding the log server in headscale, this is + # disabled by default. Enabling this will make your clients send logs to Tailscale Inc. + enabled: false + +# Enabling this option makes devices prefer a random port for WireGuard traffic over the +# default static port 41641. This option is intended as a workaround for some buggy +# firewall devices. See https://tailscale.com/kb/1181/firewalls/ for more information. +# randomize_client_port: false +randomize_client_port: true diff --git a/create_headscale_api_key.sh b/create_headscale_api_key.sh new file mode 100755 index 0000000..dddeeba --- /dev/null +++ b/create_headscale_api_key.sh @@ -0,0 +1,33 @@ +#!/bin/bash + +# Headscale 的 API 金鑰就像是你進入 Headscale API 世界的通行證。 +# 有了這把鑰匙，只有你能開門進行操作，保證你是被認可的。 +# 用這金鑰就能鎖住 API，防止那些不速之客亂搞。 + +# 定義變數以便管理 +CONTAINER_NAME="headscale" +COMMAND="headscale apikeys create" +EXPIRATION="87600h" # 等於 10 年 + +# 執行 Docker 指令來建立 API 金鑰，輸出為 JSON 格式 +echo "Creating API key for Headscale with expiration of $EXPIRATION..." +response=$(docker exec -it "$CONTAINER_NAME" $COMMAND --expiration "$EXPIRATION" --output json 2>&1) + +# 檢查指令是否成功執行 +if [ $? -eq 0 ]; then + echo "API key created successfully!" + # 嘗試提取 API 金鑰 + # 簡單檢查響應中是否包含 key 欄位，或者直接提取引號內的內容 + api_key=$(echo "$response" | grep -o '"[^"]*"' | sed 's/"//g') + if [ -n "$api_key" ]; then + echo "API Key: $api_key" + else + echo "Warning: Could not extract API key from response." + echo "Raw response: $response" + fi +else + echo "Error: Failed to create API key." + echo "Error message: $response" + exit 1 +fi + diff --git a/create_headscale_preauthkey.sh b/create_headscale_preauthkey.sh new file mode 100755 index 0000000..7cab25b --- /dev/null +++ b/create_headscale_preauthkey.sh @@ -0,0 +1,13 @@ +#!/bin/bash + +# 預認證金鑰就像是裝置的 VIP 通行證，讓它們能在進入網路前就被認證。 +# 有了這個金鑰，裝置一接上網就能被識別為自家人，免去手動認證的麻煩。 +# 對於要管理一大堆裝置或想自動化加入流程的人來說，這是個超方便的工具。 + +# 在名為 headscale 的執行中容器內執行 headscale 指令，建立一個預認證金鑰 +docker exec -it headscale headscale preauthkeys create \ + --user 1 \ + --reusable \ + --ephemeral=false \ + --expiration 87600h + diff --git a/data/db.sqlite b/data/db.sqlite new file mode 100644 index 0000000..ee088c1 Binary files /dev/null and b/data/db.sqlite differ diff --git a/data/db.sqlite-shm b/data/db.sqlite-shm new file mode 100644 index 0000000..c4fb7e0 Binary files /dev/null and b/data/db.sqlite-shm differ diff --git a/data/db.sqlite-wal b/data/db.sqlite-wal new file mode 100644 index 0000000..d8bc21e Binary files /dev/null and b/data/db.sqlite-wal differ diff --git a/data/noise_private.key b/data/noise_private.key new file mode 100644 index 0000000..5eb0e24 --- /dev/null +++ b/data/noise_private.key @@ -0,0 +1 @@ +privkey:08a7dc8305baa74525b91b7d31a48dd8e91a13f812b732a7de4b4da8fef09d68 \ No newline at end of file diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..d14445f --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,22 @@ +services: + headscale: + image: headscale/headscale:latest + container_name: headscale + volumes: + - ./config:/etc/headscale + - ./data:/var/lib/headscale + ports: + - "8080:8080" + - "9090:9090" + - "50443:50443" + command: serve + labels: + - "com.centurylinklabs.watchtower.enable=true" + restart: unless-stopped + networks: + - shared-net + +networks: + shared-net: + external: true + diff --git a/headscale b/headscale new file mode 100755 index 0000000..71ed2d0 --- /dev/null +++ b/headscale @@ -0,0 +1,3 @@ +#!/bin/bash +docker exec -i headscale headscale "$@" + diff --git a/headscale_backup_and_restore.sh b/headscale_backup_and_restore.sh new file mode 100755 index 0000000..d7963f3 --- /dev/null +++ b/headscale_backup_and_restore.sh @@ -0,0 +1,59 @@ +#!/bin/bash + +set -e # Stop script if any command fails + +# Parameters +BACKUP_SERVER="192.168.42.126" +BACKUP_SERVER_USER="root" +REMOTE_TMP_DIR="/tmp" +REMOTE_TARGET_DIR="/opt/headscale" + +cd /opt/headscale + +NOW=$(date +"%Y%m%d_%H%M%S") +TARFILE="headscale_backup_$NOW.tar.gz" + +echo "1. Stop Headscale Docker service..." +docker compose down + +echo "2. Create tar.gz backup..." +tar czvf "/tmp/$TARFILE" . + +echo "3. Calculate local checksum (db.sqlite)..." +LOCAL_SUM=$(md5sum /opt/headscale/data/db.sqlite | awk '{print $1}') + +echo "4. Start Headscale Docker service again..." +docker compose up -d + +echo "5. Copy backup to backup server..." +scp "/tmp/$TARFILE" "$BACKUP_SERVER_USER@$BACKUP_SERVER:$REMOTE_TMP_DIR/" +rm -f "/tmp/$TARFILE" + +echo "6. Restore backup and verify checksum on backup server..." +ssh "$BACKUP_SERVER_USER@$BACKUP_SERVER" "bash -s" < "\$LOGFILE" +EOF + +echo "=== DONE ===" + diff --git a/list_headscale_api_keys.sh b/list_headscale_api_keys.sh new file mode 100755 index 0000000..68e0a12 --- /dev/null +++ b/list_headscale_api_keys.sh @@ -0,0 +1,3 @@ +#!/bin/bash +docker exec -it headscale headscale apikeys list + diff --git a/list_headscale_nodes.sh b/list_headscale_nodes.sh new file mode 100755 index 0000000..bff4242 --- /dev/null +++ b/list_headscale_nodes.sh @@ -0,0 +1,2 @@ +#!/bin/bash +docker exec -it headscale headscale nodes list diff --git a/restart.sh b/restart.sh new file mode 100755 index 0000000..4eff682 --- /dev/null +++ b/restart.sh @@ -0,0 +1,2 @@ +#!/bin/bash +/usr/local/bin/docker-compose restart diff --git a/revoke_headscale_api_key.sh b/revoke_headscale_api_key.sh new file mode 100755 index 0000000..7f7877d --- /dev/null +++ b/revoke_headscale_api_key.sh @@ -0,0 +1,3 @@ +#!/bin/bash +docker exec -it headscale headscale apikeys revoke + diff --git a/run.sh b/run.sh new file mode 100755 index 0000000..69541aa --- /dev/null +++ b/run.sh @@ -0,0 +1,2 @@ +#!/bin/bash +/usr/local/bin/docker-compose up -d diff --git a/stop.sh b/stop.sh new file mode 100755 index 0000000..6971cba --- /dev/null +++ b/stop.sh @@ -0,0 +1,4 @@ +#!/bin/bash +# docker stop caddy +# docker system prune -f +/usr/local/bin/docker-compose down