timmy/netbird-selfhosted
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: remove decorative emojis

Browse Source 
Gitea's markdown renderer displays keycap emojis (1️⃣, 2️⃣) as broken
boxes. Strip all decorative emojis from doc files for cleaner rendering.
This commit is contained in:
Timmy
2026-04-18 09:30:18 +08:00
parent 655f07a198
commit d026ce4ba9
4 changed files with 18 additions and 18 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
QUICKSTART.md
View File

@@ -9,7 +9,7 @@
- 網際網路存取 - 網際網路存取
- 內網 IP (例：`192.168.42.127`) - 內網 IP (例：`192.168.42.127`)
> ⚠️ 以下步驟中的 `192.168.42.127` 請換成你的實際 IP。 > 以下步驟中的 `192.168.42.127` 請換成你的實際 IP。
--- ---
@@ -184,7 +184,7 @@ docker compose pull
docker compose up -d docker compose up -d
``` ```
> ⏳ 首次啟動需等待約 2-5 分鐘下載 GeoLite2 地理資料庫（約 60MB）。 > 首次啟動需等待約 2-5 分鐘下載 GeoLite2 地理資料庫（約 60MB）。
## Step 7: 驗證 ## Step 7: 驗證
@@ -203,13 +203,13 @@ curl -s http://127.0.0.1/oauth2/.well-known/openid-configuration | jq .issuer
## Step 8: 開始使用 ## Step 8: 開始使用
### 1️⃣ Web 管理介面 ### Web 管理介面
瀏覽器開啟：**http://192.168.42.127** 瀏覽器開啟：**http://192.168.42.127**
首次登入會引導你建立管理員帳號。 首次登入會引導你建立管理員帳號。
### 2️⃣ 客戶端連線 ### 客戶端連線
安裝 NetBird 客戶端後執行： 安裝 NetBird 客戶端後執行：

16
README.md
View File

@@ -2,14 +2,14 @@
在 Proxmox LXC (Ubuntu 24.04) 上自建 NetBird 的完整部署記錄與設定檔。 在 Proxmox LXC (Ubuntu 24.04) 上自建 NetBird 的完整部署記錄與設定檔。
## 🎯 部署特色 ## 部署特色
- **IP-only 部署**：無需域名，純內網 LAN 使用 - **IP-only 部署**：無需域名，純內網 LAN 使用
- **HTTP 模式**：使用 Caddy 作為反向代理統一 port 80 - **HTTP 模式**：使用 Caddy 作為反向代理統一 port 80
- **內建 IdP**：使用 NetBird Server 內建的 OAuth2（Dex），無需額外 IdP - **內建 IdP**：使用 NetBird Server 內建的 OAuth2（Dex），無需額外 IdP
- **LXC 相容**：使用 crun 取代 runc 繞過 Proxmox 非特權容器限制 - **LXC 相容**：使用 crun 取代 runc 繞過 Proxmox 非特權容器限制
## 📁 文件說明 ## 文件說明
| 文件 | 用途 | | 文件 | 用途 |
|------|------| |------|------|
@@ -18,7 +18,7 @@
| [npm-grpc-fix.md](./npm-grpc-fix.md) | 透過 Nginx Proxy Manager 對外公開時的 gRPC 修復 | | [npm-grpc-fix.md](./npm-grpc-fix.md) | 透過 Nginx Proxy Manager 對外公開時的 gRPC 修復 |
| [SUMMARY.md](./SUMMARY.md) | 部署摘要與疑難排解記錄 | | [SUMMARY.md](./SUMMARY.md) | 部署摘要與疑難排解記錄 |
## 🚀 快速開始 ## 快速開始
```bash ```bash
# 瀏覽器開啟 # 瀏覽器開啟
@@ -28,7 +28,7 @@ open http://192.168.42.127
netbird up --management-url http://192.168.42.127 netbird up --management-url http://192.168.42.127
``` ```
## 🏗️ 架構 ## 架構
``` ```
┌───────────────────────┐ ┌───────────────────────┐
@@ -44,7 +44,7 @@ netbird up --management-url http://192.168.42.127
└───────────────────────┘ └───────────────────────┘
``` ```
## 🔧 環境 ## 環境
| 項目 | 值 | | 項目 | 值 |
|------|-----| |------|-----|
@@ -55,7 +55,7 @@ netbird up --management-url http://192.168.42.127
| OCI Runtime | crun 1.20 | | OCI Runtime | crun 1.20 |
| 設定目錄 | `/opt/netbird/` | | 設定目錄 | `/opt/netbird/` |
## 📦 服務清單 ## 服務清單
| 容器 | 映像 | 用途 | | 容器 | 映像 | 用途 |
|------|------|------| |------|------|------|
@@ -63,14 +63,14 @@ netbird up --management-url http://192.168.42.127
| `netbird-dashboard` | `netbirdio/dashboard:latest` | Web 管理介面 | | `netbird-dashboard` | `netbirdio/dashboard:latest` | Web 管理介面 |
| `netbird-server` | `netbirdio/netbird-server:latest` | 管理 + Signal + Relay + STUN + IdP | | `netbird-server` | `netbirdio/netbird-server:latest` | 管理 + Signal + Relay + STUN + IdP |
## ⚠️ 注意事項 ## 注意事項
- **無 TLS**：僅適合內網，勿暴露至公網 - **無 TLS**：僅適合內網，勿暴露至公網
- **無域名**：使用 IP 作為 issuer，若 IP 變更需重建 - **無域名**：使用 IP 作為 issuer，若 IP 變更需重建
- **LXC 限制**：必須使用 crun，不可使用預設 runc - **LXC 限制**：必須使用 crun，不可使用預設 runc
- **首次啟動慢**：需下載 GeoLite2 資料庫（約 60MB） - **首次啟動慢**：需下載 GeoLite2 資料庫（約 60MB）
## 🔗 相關連結 ## 相關連結
- [NetBird 官方文件](https://docs.netbird.io/selfhosted/selfhosted-quickstart) - [NetBird 官方文件](https://docs.netbird.io/selfhosted/selfhosted-quickstart)
- [NetBird GitHub](https://github.com/netbirdio/netbird) - [NetBird GitHub](https://github.com/netbirdio/netbird)

10
SUMMARY.md
View File

@@ -2,7 +2,7 @@
## 部署結果 ## 部署結果
✅ **NetBird Self-Hosted 成功部署於 `192.168.42.127`** **NetBird Self-Hosted 已部署於 `192.168.42.127`**
- 部署日期：2026-04-17 - 部署日期：2026-04-17
- 存取方式：`http://192.168.42.127` - 存取方式：`http://192.168.42.127`
@@ -65,10 +65,10 @@ reopen fd 8: permission denied
| 端點 | 狀態 | 說明 | | 端點 | 狀態 | 說明 |
|------|------|------| |------|------|------|
| `http://192.168.42.127/` | ✅ 200 | Dashboard Web UI | | `http://192.168.42.127/` | 200 | Dashboard Web UI |
| `http://192.168.42.127/oauth2/.well-known/openid-configuration` | ✅ 200 | OIDC Discovery | | `http://192.168.42.127/oauth2/.well-known/openid-configuration` | 200 | OIDC Discovery |
| STUN `:3478/udp` | ✅ | NAT 穿透 | | STUN `:3478/udp` | | NAT 穿透 |
| 內部 gRPC (Signal + Management) | ✅ | h2c via Caddy | | 內部 gRPC (Signal + Management) | | h2c via Caddy |
## 疑難排解記錄 ## 疑難排解記錄

2
npm-grpc-fix.md
View File

@@ -99,7 +99,7 @@ PY
#### 1b. 重新渲染 nginx config #### 1b. 重新渲染 nginx config
⚠️ **注意**：NPM 只有在 UI/API 儲存 proxy host 時才會重新渲染 `/data/nginx/proxy_host/<id>.conf`，重啟容器**不會**觸發。 **注意**：NPM 只有在 UI/API 儲存 proxy host 時才會重新渲染 `/data/nginx/proxy_host/<id>.conf`，重啟容器**不會**觸發。
兩種處理方式： 兩種處理方式：