Timmy
c5ca2ab378
- Remove old README file - Add QUICKSTART.md for quick setup (3-step process) - Add SUMMARY.md for project overview and architecture - Add OPERATIONS.md for detailed management procedures - Keep README.md as comprehensive main documentation - Organize content by purpose: quick start, overview, operations Co-Authored-By: Claude Haiku 4.5 <noreply@anthropic.com>
70 lines
1.3 KiB
Markdown
70 lines
1.3 KiB
Markdown
# Headscale 快速上手指南
|
||
|
||
## 伺服器資訊
|
||
|
||
- **公開端點**: https://headscale.lotimmy.com
|
||
- **管理介面**: 透過 Headscale CLI 或 Tailscale 客戶端
|
||
|
||
## 三步快速啟動
|
||
|
||
### 1. 準備環境
|
||
|
||
```bash
|
||
# 建立 Docker 網路
|
||
docker network create shared-net
|
||
|
||
# 啟動服務
|
||
make up
|
||
|
||
# 查看狀態
|
||
make ps
|
||
```
|
||
|
||
### 2. 設備連接
|
||
|
||
```bash
|
||
# 產生預授權金鑰
|
||
headscale preauthkeys create \
|
||
--user 1 \
|
||
--reusable \
|
||
--ephemeral=false \
|
||
--expiration 87600h
|
||
|
||
# 設備連接指令
|
||
tailscale up --login-server https://headscale.lotimmy.com --auth-key <金鑰>
|
||
```
|
||
|
||
### 3. 註冊節點
|
||
|
||
```bash
|
||
# 在設備連接後執行
|
||
headscale nodes register --user mainnet --key <設備返回的金鑰>
|
||
```
|
||
|
||
## 常用指令
|
||
|
||
### 服務管理
|
||
```bash
|
||
make up # 啟動服務
|
||
make down # 停止服務
|
||
make restart # 重啟服務
|
||
make logs # 查看日誌
|
||
```
|
||
|
||
### 節點管理
|
||
```bash
|
||
headscale nodes list # 查看節點
|
||
headscale nodes tag --id 4 --tags tag:server # 標記節點
|
||
```
|
||
|
||
### 健康檢查
|
||
```bash
|
||
./api_user_request.sh # API 檢查
|
||
make logs # 服務日誌
|
||
```
|
||
|
||
## 下一步
|
||
|
||
- 查看 [README.md](README.md) 獲取完整文件
|
||
- 查看節點狀態：`headscale nodes list`
|
||
- 配置 Exit Node：參考 README 中的 Exit Node 章節 |