Nuwax

Appearance

安装部署 ​

该文档介绍了docker版本的智能体客户端安装，其他版本请移步 https://nuwax.com/agent.html

🚀 快速开始 ​

登录官网,左下角进入"我的电脑",新建电脑保存,然后复制密钥,用于后续的"NUWAX_SAVED_KEY"配置使用。

获取密钥 ​

img.png

启动容器服务 ​

快捷启动容器命令

bash
docker run -d \
  --name nuwax-client \
  --restart always \
  -p 6080:6080 \
  -v nuwax_home:/home/user \
  -e TZ=Asia/Shanghai \
  -e NUWAX_SAVED_KEY=xxxxxxxx-个人密钥-xxxxxxxxxxxx \
  nuwax-docker-images-registry.cn-hangzhou.cr.aliyuncs.com/nuwax/nuwax-agent-client:latest

浏览器访问VNC桌面（用于确认是否部署成功） ​

容器启动成功之后,可以浏览器访问vnc桌面,参考访问地址(云服务器部署，注意替换下ip)，6080端口为非必须端口，仅用于测试连通性，正式使用时请屏蔽，启动时可以去掉 -p 6080:6080 参数

bash
http://127.0.0.1:6080/vnc.html?autoconnect=true&resize=scale

容器里的客户端启动正常后，即可在智能体平台正常选择使用。

完整参数命令参数示例 ​

bash
docker run -d \
  --name nuwax-client \
  --restart always \
  -p 6080:6080 \
  -v nuwax_home:/home/user \
  -e TZ=Asia/Shanghai \
  -e NUWAX_SERVER_HOST=https://agent.nuwax.com \
  -e NUWAX_AGENT_PORT=60006 \
  -e NUWAX_FILE_SERVER_PORT=60005 \
  -e NUWAX_WORKSPACE_DIR=/home/user/nuwaxbot/workspace \
  -e NUWAX_SAVED_KEY=xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx \
  nuwax-docker-images-registry.cn-hangzhou.cr.aliyuncs.com/nuwax/nuwax-agent-client:latest

环境变量 ​

变量名默认值说明
TZAsia/Shanghai时区设置
NUWAX_SERVER_HOSThttps://agent.nuwax.comNuwax Agent 服务器地址
NUWAX_AGENT_PORT60006Agent 服务端口
NUWAX_FILE_SERVER_PORT60005文件服务端口
NUWAX_WORKSPACE_DIR/home/user/nuwaxbot/workspace工作目录（容器内）
NUWAX_SAVED_KEY-认证密钥（必填）

内存优化 ​

增加 Swap 空间 ​

如果服务器内存较小（如 2GB 或更少），建议增加 swap 空间以避免容器因内存不足而崩溃。

检查当前 swap 状态 ​

bash
# 查看 swap 使用情况
free -h

# 查看 swap 文件或分区
swapon --show

创建 swap 文件（推荐 4GB） ​

方法一：使用 fallocate（推荐，速度快）

bash
# 创建 4GB swap 文件
sudo fallocate -l 4G /swapfile

# 设置正确的权限
sudo chmod 600 /swapfile

# 格式化为 swap
sudo mkswap /swapfile

# 启用 swap
sudo swapon /swapfile

# 验证是否生效
free -h

方法二：使用 dd（兼容性好）

bash
# 创建 4GB swap 文件
sudo dd if=/dev/zero of=/swapfile bs=1M count=4096 status=progress

# 设置正确的权限
sudo chmod 600 /swapfile

# 格式化为 swap
sudo mkswap /swapfile

# 启用 swap
sudo swapon /swapfile

# 验证是否生效
free -h

永久启用 swap ​

为了让 swap 在重启后自动生效，需要将其添加到 /etc/fstab：

bash
# 备份 fstab 文件
sudo cp /etc/fstab /etc/fstab.bak

# 添加 swap 到 fstab
echo '/swapfile none swap sw 0 0' | sudo tee -a /etc/fstab

# 验证配置
cat /etc/fstab | grep swap

调整 swap 使用策略 ​

bash
# 设置 swapiness（0-100，值越低越倾向于使用 RAM）
# 推荐设置为 10，优先使用 RAM，但保留 swap 作为备用
sudo sysctl vm.swappiness=10

# 永久生效
echo 'vm.swappiness=10' | sudo tee -a /etc/sysctl.conf

删除 swap（如需要） ​

bash
# 禁用 swap
sudo swapoff /swapfile

# 从 fstab 中移除
sudo sed -i '/swapfile/d' /etc/fstab

# 删除 swap 文件
sudo rm /swapfile

推荐配置 ​

服务器内存Swap 大小总可用内存
1GB4GB5GB
2GB4GB6GB
4GB4GB8GB
8GB2-4GB10-12GB
16GB+2-4GB18-20GB

提示：

  • 增加 swap 会降低性能，但可以防止内存不足导致的服务崩溃
  • 对于内存较小的服务器（1-2GB），建议配置 4GB swap 以确保稳定运行
  • 建议根据实际使用情况和性能需求调整 swap 大小

数据持久化 ​

镜像已配置命名卷自动持久化以下目录：

  • nuwax_home → /home/user/

执行 docker compose down 再 up 时数据不会丢失。如需清理数据，使用 docker compose down -v。

端口说明 ​

端口用途
6080noVNC Web 界面

常用命令 ​

bash
# 查看日志
docker logs -f nuwax-client-test

# 进入容器
docker exec -it nuwax-client-test bash

# 停止容器
docker stop nuwax-client-test

# 启动容器
docker start nuwax-client-test

# 删除容器
docker rm -f nuwax-client-test

# 清理命名卷（删除容器时同时删除卷数据）
docker compose down -v

# 单独删除指定卷
docker volume rm nuwax-client_nuwax_home

# 查看所有卷
docker volume ls