docs: add Linux server deployment guide + one-click deploy script

- docs/linux-deploy.md: comprehensive guide covering Node.js install, OpenClaw setup, systemd/PM2/Docker, Nginx reverse proxy, firewall, troubleshooting
- scripts/linux-deploy.sh: one-click deploy script with auto OS detection
- README.md: add Linux server section with curl one-liner
This commit is contained in:
晴天
2026-03-05 22:59:10 +08:00
parent cb5cbe2f71
commit 0fabb803d4
3 changed files with 885 additions and 0 deletions

View File

@@ -75,6 +75,16 @@ ClawPanel 是 [OpenClaw](https://github.com/1186258278/OpenClawChineseTranslatio
| DEB | `ClawPanel_x.x.x_amd64.deb` | Debian / Ubuntu`sudo dpkg -i *.deb` |
| RPM | `ClawPanel-x.x.x-1.x86_64.rpm` | Fedora / RHEL`sudo rpm -i *.rpm` |
### Linux 服务器(无 GUI
不需要桌面环境,一键命令部署 OpenClaw Gateway通过端口远程访问
```bash
curl -fsSL https://raw.githubusercontent.com/qingchencloud/clawpanel/main/scripts/linux-deploy.sh | bash
```
📖 详细教程见 [Linux 服务器部署指南](docs/linux-deploy.md)
## 功能特性
<p align="center">

636
docs/linux-deploy.md Normal file
View File

@@ -0,0 +1,636 @@
# Linux 服务器部署指南
本文介绍如何在 Linux 服务器上部署 OpenClaw从零到跑通只需 5 分钟。
适用场景云服务器、NAS、家庭 HomeLab、无 GUI 的 Linux 主机。
## 目录
- [一键部署](#一键部署)
- [分步安装](#分步安装)
- [配置模型](#配置模型)
- [启动 Gateway](#启动-gateway)
- [开机自启](#开机自启)
- [远程管理](#远程管理)
- [反向代理](#反向代理)
- [常见问题](#常见问题)
---
## 一键部署
复制以下命令到终端,一键完成 Node.js + OpenClaw 安装、配置、启动:
```bash
curl -fsSL https://raw.githubusercontent.com/qingchencloud/clawpanel/main/scripts/linux-deploy.sh | bash
```
> 脚本会自动检测系统环境,安装 Node.js如未安装安装 OpenClaw 汉化版,配置默认参数,启动 Gateway。
不想用一键脚本?往下看分步安装。
---
## 分步安装
### 1. 安装 Node.js
OpenClaw 需要 Node.js >= 18。选择适合你的安装方式
**方式一:包管理器(推荐)**
```bash
# Ubuntu / Debian
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt-get install -y nodejs
# CentOS / RHEL / Fedora
curl -fsSL https://rpm.nodesource.com/setup_22.x | sudo bash -
sudo yum install -y nodejs
# Alpine
apk add nodejs npm
```
**方式二nvm多版本管理**
```bash
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
source ~/.bashrc
nvm install 22
```
验证安装:
```bash
node -v # 应显示 v18+ 版本号
npm -v # 应显示 npm 版本号
```
### 2. 安装 OpenClaw
```bash
# 使用淘宝镜像源(国内服务器推荐)
npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com
# 或使用官方源
npm install -g @qingchencloud/openclaw-zh
```
验证安装:
```bash
openclaw --version
```
### 3. 初始化配置
```bash
# 创建配置目录
mkdir -p ~/.openclaw
# 写入基础配置
cat > ~/.openclaw/openclaw.json << 'EOF'
{
"mode": "local",
"tools": {
"profile": "full",
"sessions": {
"visibility": "all"
}
},
"gateway": {
"port": 18789,
"bind": "lan",
"auth": {}
},
"models": {
"providers": {}
}
}
EOF
```
**配置说明:**
| 字段 | 值 | 说明 |
|------|------|------|
| `mode` | `"local"` | 运行模式,必须设置 |
| `tools.profile` | `"full"` | Agent 工具权限,`full` 为全部开启 |
| `gateway.port` | `18789` | Gateway 监听端口 |
| `gateway.bind` | `"lan"` | `"loopback"` 仅本机 / `"lan"` 局域网可访问 |
| `gateway.auth` | `{}` | 认证配置,生产环境建议设置 Token |
**设置访问密钥(推荐):**
如果你的服务器有公网 IP 或局域网内有其他设备访问,强烈建议设置 Token
```bash
# 用 jq 修改(需安装 jq
jq '.gateway.auth = {"mode": "token", "token": "你的密钥"}' ~/.openclaw/openclaw.json > /tmp/oc.json && mv /tmp/oc.json ~/.openclaw/openclaw.json
# 或直接编辑
nano ~/.openclaw/openclaw.json
```
---
## 配置模型
OpenClaw 需要至少一个 AI 模型才能使用。编辑 `~/.openclaw/openclaw.json`,在 `models.providers` 中添加服务商:
### 示例:添加 OpenAI 兼容服务商
```bash
cat > /tmp/add-provider.py << 'PYEOF'
import json, sys
config_path = f"{sys.path[0]}/../.openclaw/openclaw.json".replace(sys.path[0] + "/../", "")
import os
config_path = os.path.expanduser("~/.openclaw/openclaw.json")
with open(config_path) as f:
config = json.load(f)
# 修改为你的实际服务商信息
provider_id = "my-provider"
config["models"]["providers"][provider_id] = {
"baseUrl": "https://api.openai.com/v1",
"apiKey": "sk-xxxx",
"models": [
{"id": "gpt-4o", "name": "GPT-4o"},
{"id": "gpt-4o-mini", "name": "GPT-4o Mini"}
]
}
# 设置默认模型
config.setdefault("agents", {}).setdefault("defaults", {})["model"] = {
"primary": f"{provider_id}/gpt-4o"
}
with open(config_path, "w") as f:
json.dump(config, f, indent=2, ensure_ascii=False)
print(f"✅ 已添加服务商 {provider_id}")
PYEOF
python3 /tmp/add-provider.py
```
**或者直接编辑 JSON更直观**
```bash
nano ~/.openclaw/openclaw.json
```
`models.providers` 中加入:
```json
{
"models": {
"providers": {
"my-provider": {
"baseUrl": "https://api.openai.com/v1",
"apiKey": "sk-xxxx",
"models": [
{ "id": "gpt-4o", "name": "GPT-4o" },
{ "id": "gpt-4o-mini", "name": "GPT-4o Mini" }
]
}
}
}
}
```
> 支持任何 OpenAI 兼容 APIDeepSeek、通义千问、智谱、Ollama 等),只需修改 `baseUrl` 和 `apiKey`。
---
## 启动 Gateway
### 前台运行(调试用)
```bash
openclaw gateway start
```
看到类似输出说明启动成功:
```
Gateway listening on http://0.0.0.0:18789
```
`Ctrl+C` 停止。
### 后台运行
```bash
# 使用 nohup
nohup openclaw gateway start > ~/.openclaw/gateway.log 2>&1 &
echo $! > ~/.openclaw/gateway.pid
# 查看日志
tail -f ~/.openclaw/gateway.log
# 停止
kill $(cat ~/.openclaw/gateway.pid)
```
### 验证运行
```bash
# 检查端口是否在监听
ss -tlnp | grep 18789
# 测试 API 响应
curl http://localhost:18789/health
# 从其他机器测试(替换为服务器 IP
curl http://你的服务器IP:18789/health
```
---
## 开机自启
### 方式一systemd推荐
```bash
sudo tee /etc/systemd/system/openclaw.service << EOF
[Unit]
Description=OpenClaw Gateway
After=network.target
[Service]
Type=simple
User=$USER
Environment=PATH=$(dirname $(which node)):$PATH
ExecStart=$(which openclaw) gateway start
Restart=on-failure
RestartSec=5
WorkingDirectory=$HOME
[Install]
WantedBy=multi-user.target
EOF
# 启用并启动
sudo systemctl daemon-reload
sudo systemctl enable openclaw
sudo systemctl start openclaw
# 查看状态
sudo systemctl status openclaw
# 查看日志
journalctl -u openclaw -f
```
**常用命令:**
```bash
sudo systemctl start openclaw # 启动
sudo systemctl stop openclaw # 停止
sudo systemctl restart openclaw # 重启
sudo systemctl status openclaw # 查看状态
journalctl -u openclaw -f # 实时日志
```
### 方式二PM2
```bash
# 安装 PM2
npm install -g pm2
# 启动
pm2 start "openclaw gateway start" --name openclaw
# 设置开机自启
pm2 save
pm2 startup
# 常用命令
pm2 status # 查看状态
pm2 logs openclaw # 查看日志
pm2 restart openclaw
pm2 stop openclaw
```
### 方式三Docker适合隔离部署
```bash
docker run -d \
--name openclaw \
--restart unless-stopped \
-p 18789:18789 \
-v ~/.openclaw:/root/.openclaw \
node:22-slim \
sh -c "npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com && openclaw gateway start"
```
---
## 远程管理
Gateway 启动后,你可以通过以下方式管理:
### 方式一ClawPanel 桌面端远程连接
在你的 Windows/Mac 电脑上安装 [ClawPanel](https://github.com/qingchencloud/clawpanel/releases/latest),打开后在 Gateway 配置页选择「云端模式」,填入服务器地址即可远程管理。
### 方式二ClawApp 移动端
用手机上的 [ClawApp](https://github.com/qingchencloud/clawapp) 连接 Gateway 地址,随时随地与 AI 对话。
### 方式三API 直接调用
Gateway 兼容 OpenAI API 格式,任何支持 OpenAI API 的客户端都可以直连:
```bash
# 对话测试
curl http://你的服务器IP:18789/v1/chat/completions \
-H "Content-Type: application/json" \
-H "Authorization: Bearer 你的Token" \
-d '{
"model": "gpt-4o",
"messages": [{"role": "user", "content": "你好"}]
}'
```
**在第三方客户端中使用:**
| 设置项 | 值 |
|--------|------|
| API Base URL | `http://服务器IP:18789/v1` |
| API Key | 你在 `gateway.auth.token` 中设置的密钥 |
| Model | 你配置的模型 ID`gpt-4o` |
支持 Cherry Studio、ChatBox、LobeChat、BotGem 等所有兼容 OpenAI API 的客户端。
---
## 反向代理
生产环境建议用 Nginx 反向代理,加上 HTTPS。
### Nginx 配置
```nginx
server {
listen 443 ssl http2;
server_name ai.example.com;
ssl_certificate /etc/ssl/certs/ai.example.com.pem;
ssl_certificate_key /etc/ssl/private/ai.example.com.key;
location / {
proxy_pass http://127.0.0.1:18789;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
# WebSocket 支持(聊天流式响应需要)
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_read_timeout 86400;
}
}
```
```bash
sudo nginx -t && sudo systemctl reload nginx
```
配置完成后,用 `https://ai.example.com` 替代 IP + 端口访问。
### Cloudflare Tunnel无需公网 IP
如果你的服务器没有公网 IP可以用 [cftunnel](https://github.com/qingchencloud/cftunnel) 一键穿透:
```bash
# 安装 cftunnel
npm install -g cftunnel
# 创建隧道
cftunnel create --name my-ai --hostname ai.example.com --url http://localhost:18789
# 启动
cftunnel start
```
---
## 防火墙
如果需要外部访问,记得开放端口:
```bash
# UFWUbuntu
sudo ufw allow 18789/tcp
# firewalldCentOS / Fedora
sudo firewall-cmd --permanent --add-port=18789/tcp
sudo firewall-cmd --reload
# iptables
sudo iptables -A INPUT -p tcp --dport 18789 -j ACCEPT
```
> 如果使用了 Nginx 反向代理,只需开放 80/443 端口,不需要开放 18789。
---
## 升级
```bash
# 升级 OpenClaw
npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com
# 重启服务
sudo systemctl restart openclaw
# 或
pm2 restart openclaw
```
---
## 常见问题
### npm install 报错 EACCES权限不足
```bash
# 方式一:修复 npm 全局目录权限
mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
source ~/.bashrc
# 然后重新安装
npm install -g @qingchencloud/openclaw-zh
```
### Gateway 启动后外部无法访问
1. 检查 `gateway.bind` 是否为 `"lan"`(不要用 `"loopback"`
2. 检查防火墙是否放行了端口
3. 云服务器检查安全组规则是否开放端口
```bash
# 验证监听地址
ss -tlnp | grep 18789
# 应显示 0.0.0.0:18789而不是 127.0.0.1:18789
```
### 端口被占用
```bash
# 查看谁占了端口
sudo lsof -i :18789
# 改用其他端口
jq '.gateway.port = 18790' ~/.openclaw/openclaw.json > /tmp/oc.json && mv /tmp/oc.json ~/.openclaw/openclaw.json
```
### Node.js 版本太低
```bash
node -v
# 如果低于 v18需要升级
# 使用 nvm 升级
nvm install 22
nvm alias default 22
```
### 内存不足
OpenClaw Gateway 本身占用很小(约 50-100MB但如果你同时运行 Ollama 等本地模型,建议至少 4GB 内存。
---
## 完整配置参考
```json
{
"mode": "local",
"tools": {
"profile": "full",
"sessions": {
"visibility": "all"
}
},
"gateway": {
"port": 18789,
"bind": "lan",
"mode": "local",
"auth": {
"mode": "token",
"token": "your-secret-token"
}
},
"models": {
"providers": {
"deepseek": {
"baseUrl": "https://api.deepseek.com/v1",
"apiKey": "sk-xxxx",
"models": [
{ "id": "deepseek-chat", "name": "DeepSeek V3" },
{ "id": "deepseek-reasoner", "name": "DeepSeek R1" }
]
}
}
},
"agents": {
"defaults": {
"model": {
"primary": "deepseek/deepseek-chat"
}
}
}
}
```
---
## 一键部署脚本参考
不想记那么多命令?保存以下脚本到服务器,一键搞定:
```bash
#!/bin/bash
set -e
echo "=========================================="
echo " OpenClaw 一键部署脚本"
echo "=========================================="
# 检查 Node.js
if ! command -v node &> /dev/null || [ "$(node -v | sed 's/v//' | cut -d. -f1)" -lt 18 ]; then
echo "📦 安装 Node.js 22..."
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt-get install -y nodejs
fi
echo "✅ Node.js $(node -v)"
# 安装 OpenClaw
echo "📦 安装 OpenClaw..."
npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com
echo "✅ OpenClaw $(openclaw --version)"
# 初始化配置
mkdir -p ~/.openclaw
if [ ! -f ~/.openclaw/openclaw.json ]; then
echo "📝 写入默认配置..."
cat > ~/.openclaw/openclaw.json << 'CONF'
{
"mode": "local",
"tools": { "profile": "full", "sessions": { "visibility": "all" } },
"gateway": { "port": 18789, "bind": "lan", "auth": {} },
"models": { "providers": {} }
}
CONF
fi
# 创建 systemd 服务
echo "⚙️ 配置开机自启..."
sudo tee /etc/systemd/system/openclaw.service > /dev/null << SVCEOF
[Unit]
Description=OpenClaw Gateway
After=network.target
[Service]
Type=simple
User=$USER
Environment=PATH=$(dirname $(which node)):$PATH
ExecStart=$(which openclaw) gateway start
Restart=on-failure
RestartSec=5
WorkingDirectory=$HOME
[Install]
WantedBy=multi-user.target
SVCEOF
sudo systemctl daemon-reload
sudo systemctl enable openclaw
sudo systemctl start openclaw
echo ""
echo "=========================================="
echo " ✅ 部署完成!"
echo "=========================================="
echo ""
echo " Gateway 地址: http://$(hostname -I | awk '{print $1}'):18789"
echo ""
echo " 管理命令:"
echo " sudo systemctl status openclaw # 查看状态"
echo " sudo systemctl restart openclaw # 重启"
echo " journalctl -u openclaw -f # 查看日志"
echo ""
echo " 下一步:"
echo " 1. 编辑 ~/.openclaw/openclaw.json 添加你的模型 API Key"
echo " 2. sudo systemctl restart openclaw"
echo " 3. 用 ClawPanel 或 ClawApp 连接 Gateway"
echo ""
```
保存为 `deploy.sh`,然后 `chmod +x deploy.sh && ./deploy.sh`

239
scripts/linux-deploy.sh Normal file
View File

@@ -0,0 +1,239 @@
#!/bin/bash
set -e
echo "=========================================="
echo " OpenClaw 一键部署脚本"
echo "=========================================="
echo ""
# 检测系统
detect_os() {
if [ -f /etc/os-release ]; then
. /etc/os-release
OS=$ID
OS_LIKE=$ID_LIKE
elif [ -f /etc/redhat-release ]; then
OS="centos"
else
OS=$(uname -s | tr '[:upper:]' '[:lower:]')
fi
echo "🖥️ 系统: $OS $(uname -m)"
}
# 安装 Node.js
install_node() {
if command -v node &> /dev/null; then
local node_major=$(node -v | sed 's/v//' | cut -d. -f1)
if [ "$node_major" -ge 18 ]; then
echo "✅ Node.js $(node -v) 已安装"
return 0
else
echo "⚠️ Node.js 版本过低 ($(node -v)),需要 >= 18"
fi
fi
echo "📦 安装 Node.js 22..."
case "$OS" in
ubuntu|debian|linuxmint|pop)
curl -fsSL https://deb.nodesource.com/setup_22.x | sudo -E bash -
sudo apt-get install -y nodejs
;;
centos|rhel|fedora|rocky|alma|opencloudos)
curl -fsSL https://rpm.nodesource.com/setup_22.x | sudo bash -
sudo yum install -y nodejs || sudo dnf install -y nodejs
;;
alpine)
sudo apk add nodejs npm
;;
arch|manjaro)
sudo pacman -S --noconfirm nodejs npm
;;
*)
# 通用方式:使用 nvm
echo "🔧 未识别的发行版,使用 nvm 安装..."
if ! command -v nvm &> /dev/null; then
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.40.3/install.sh | bash
export NVM_DIR="$HOME/.nvm"
[ -s "$NVM_DIR/nvm.sh" ] && . "$NVM_DIR/nvm.sh"
fi
nvm install 22
nvm alias default 22
;;
esac
echo "✅ Node.js $(node -v) 安装成功"
}
# 安装 OpenClaw
install_openclaw() {
echo "📦 安装 OpenClaw 汉化版..."
# 检查是否需要修复 npm 权限
local npm_prefix=$(npm config get prefix 2>/dev/null || echo "/usr/local")
if [ ! -w "$npm_prefix/lib" ] 2>/dev/null; then
# 无写入权限,使用用户目录
if [ "$(id -u)" -ne 0 ]; then
echo "🔧 配置 npm 用户目录..."
mkdir -p ~/.npm-global
npm config set prefix '~/.npm-global'
export PATH=~/.npm-global/bin:$PATH
if ! grep -q '.npm-global/bin' ~/.bashrc 2>/dev/null; then
echo 'export PATH=~/.npm-global/bin:$PATH' >> ~/.bashrc
fi
fi
fi
npm install -g @qingchencloud/openclaw-zh --registry https://registry.npmmirror.com
# 验证
if command -v openclaw &> /dev/null; then
echo "✅ OpenClaw $(openclaw --version) 安装成功"
else
echo "❌ openclaw 命令未找到,请检查 PATH"
echo " 尝试: source ~/.bashrc && openclaw --version"
exit 1
fi
}
# 初始化配置
init_config() {
mkdir -p ~/.openclaw
if [ -f ~/.openclaw/openclaw.json ]; then
echo "✅ 配置文件已存在,跳过初始化"
return 0
fi
echo "📝 写入默认配置..."
cat > ~/.openclaw/openclaw.json << 'EOF'
{
"mode": "local",
"tools": {
"profile": "full",
"sessions": {
"visibility": "all"
}
},
"gateway": {
"port": 18789,
"bind": "lan",
"auth": {}
},
"models": {
"providers": {}
}
}
EOF
echo "✅ 配置已写入 ~/.openclaw/openclaw.json"
}
# 安装 systemd 服务
install_service() {
# 检查 systemd 是否可用
if ! command -v systemctl &> /dev/null; then
echo "⚠️ systemd 不可用,使用 nohup 后台启动..."
nohup openclaw gateway start > ~/.openclaw/gateway.log 2>&1 &
echo $! > ~/.openclaw/gateway.pid
echo "✅ Gateway 已后台启动 (PID: $(cat ~/.openclaw/gateway.pid))"
return 0
fi
echo "⚙️ 配置 systemd 服务..."
local node_path=$(dirname $(which node))
local openclaw_path=$(which openclaw)
sudo tee /etc/systemd/system/openclaw.service > /dev/null << SVCEOF
[Unit]
Description=OpenClaw Gateway
After=network.target
[Service]
Type=simple
User=$USER
Environment=PATH=$node_path:/usr/local/bin:/usr/bin:/bin
ExecStart=$openclaw_path gateway start
Restart=on-failure
RestartSec=5
WorkingDirectory=$HOME
[Install]
WantedBy=multi-user.target
SVCEOF
sudo systemctl daemon-reload
sudo systemctl enable openclaw
sudo systemctl start openclaw
# 等待启动
sleep 3
if sudo systemctl is-active --quiet openclaw; then
echo "✅ Gateway 服务已启动并设为开机自启"
else
echo "⚠️ Gateway 服务可能未启动,请检查: journalctl -u openclaw -n 20"
fi
}
# 获取服务器 IP
get_server_ip() {
local ip=$(hostname -I 2>/dev/null | awk '{print $1}')
if [ -z "$ip" ]; then
ip=$(ip route get 1 2>/dev/null | awk '{print $7; exit}')
fi
if [ -z "$ip" ]; then
ip="localhost"
fi
echo "$ip"
}
# 主流程
main() {
detect_os
echo ""
install_node
echo ""
install_openclaw
echo ""
init_config
echo ""
install_service
echo ""
local server_ip=$(get_server_ip)
local port=$(grep -o '"port":[[:space:]]*[0-9]*' ~/.openclaw/openclaw.json 2>/dev/null | head -1 | grep -o '[0-9]*' || echo "18789")
echo "=========================================="
echo " ✅ 部署完成!"
echo "=========================================="
echo ""
echo " Gateway 地址: http://${server_ip}:${port}"
echo ""
echo " 管理命令:"
if command -v systemctl &> /dev/null; then
echo " sudo systemctl status openclaw # 查看状态"
echo " sudo systemctl restart openclaw # 重启"
echo " journalctl -u openclaw -f # 查看日志"
else
echo " cat ~/.openclaw/gateway.pid # 查看 PID"
echo " tail -f ~/.openclaw/gateway.log # 查看日志"
echo " kill \$(cat ~/.openclaw/gateway.pid) # 停止"
fi
echo ""
echo " 下一步:"
echo " 1. 编辑 ~/.openclaw/openclaw.json 添加模型 API Key"
if command -v systemctl &> /dev/null; then
echo " 2. sudo systemctl restart openclaw"
else
echo " 2. 重启 Gateway"
fi
echo " 3. 用 ClawPanel 或 ClawApp 连接管理"
echo ""
}
main "$@"