flnxi-Wu/docs/guides/NAS_INSTALL_GUIDE.md
WuYongJie d1c6efc79d
Some checks failed
CI Check / check (push) Has been cancelled
feat: NAS 部署与 Harbor 推送流程
2025-12-03 14:39:06 +08:00

4.3 KiB
Raw Blame History

NAS 设备一键安装指南

📋 前置要求

  1. NAS 设备已安装 Docker 和 Docker Compose

    docker --version
    docker compose version
    
  2. NAS 可以访问互联网(用于拉取 Harbor 镜像)

  3. NAS 可以通过 SSH 访问(或直接在 NAS 上操作)

🚀 安装步骤

方式一:直接下载脚本(推荐)

如果 NAS 可以访问互联网,可以直接下载并运行:

# 1. 创建安装目录
mkdir -p ~/flnxi-install
cd ~/flnxi-install

# 2. 下载安装脚本(需要从 Git 仓库或文件服务器获取)
# 方式 A: 如果 NAS 有 Git
git clone <your-repo-url> .
# 或只下载必要文件:
wget <url-to-install.sh>
wget <url-to-docker-compose.prod.yml>

# 方式 B: 从本地传输(见方式二)

# 3. 给脚本执行权限
chmod +x install.sh

# 4. 运行安装脚本
./install.sh

方式二:从本地传输到 NAS

步骤 1: 准备文件

在本地 Windows 机器上,确保以下文件已准备好:

  • scripts/tools/install.sh
  • docker-compose.prod.yml

步骤 2: 传输文件到 NAS

选项 A: 使用 SCP(如果 NAS 支持 SSH)

# 在 PowerShell 中执行
$NAS_IP = "192.168.x.x"  # 替换为你的 NAS IP
$NAS_USER = "admin"      # 替换为你的 NAS 用户名
$NAS_PATH = "/volume1/docker/flnxi"  # 替换为你的 NAS 路径

# 传输文件
scp scripts/tools/install.sh ${NAS_USER}@${NAS_IP}:${NAS_PATH}/
scp docker-compose.prod.yml ${NAS_USER}@${NAS_IP}:${NAS_PATH}/

选项 B: 使用 NAS 的 Web 界面

  1. 通过浏览器访问 NAS 管理界面
  2. 使用文件管理器上传 install.sh 和 docker-compose.prod.yml 到指定目录
  3. 通过 SSH 登录 NAS,给脚本添加执行权限

步骤 3: 在 NAS 上运行

# SSH 登录 NAS
ssh admin@192.168.x.x

# 进入安装目录
cd /volume1/docker/flnxi  # 或你上传的目录

# 给脚本执行权限
chmod +x install.sh

# 运行安装脚本
./install.sh

📝 安装过程说明

安装脚本会引导你完成以下步骤:

  1. 检查 Docker 环境 - 自动检测 Docker 和 Docker Compose
  2. 配置环境变量 - 交互式输入:
    • 服务器 IP 地址(会自动检测,可确认或修改)
    • 应用端口(默认 4320)
    • MinIO 端口(默认 9000/9001)
    • 初始管理员账号和密码
    • Harbor 登录信息(如果需要)
  3. 创建数据目录 - 自动创建必要的目录
  4. 登录 Harbor - 如果需要访问私有镜像仓库
  5. 清理旧容器 - 清理可能存在的旧容器
  6. 拉取镜像 - 从 Harbor 拉取所有需要的镜像
  7. 启动服务 - 启动所有 Docker 容器
  8. 初始化数据库 - 自动运行数据库迁移

✅ 安装完成后

安装脚本会显示:

  • 应用访问地址: http://<NAS_IP>:4320
  • MinIO 控制台: http://<NAS_IP>:9001
  • 初始管理员账号: 邮箱和密码(安装时设置)
  • 数据库信息: 用户名和密码

🔧 常用命令

# 查看服务状态
docker compose -f docker-compose.prod.yml ps

# 查看日志
docker compose -f docker-compose.prod.yml logs -f

# 重启服务
docker compose -f docker-compose.prod.yml restart

# 停止服务
docker compose -f docker-compose.prod.yml down

# 启动服务
docker compose -f docker-compose.prod.yml up -d

⚠️ 注意事项

  1. 端口冲突: 确保 4320、9000、9001 端口未被占用
  2. 防火墙: 确保 NAS 防火墙允许这些端口
  3. 存储空间: 确保有足够的存储空间(建议至少 50GB)
  4. Harbor 访问: 如果 Harbor 需要登录,确保 NAS 可以访问 harbor.flnxi.com
  5. 配置文件: 所有配置保存在 .env.production 文件中,请妥善保管

🐛 故障排查

Docker 未安装

# 群晖 DSM
# 通过套件中心安装 Docker

# Ubuntu/Debian
sudo apt-get update
sudo apt-get install docker.io docker-compose

Harbor 连接失败

# 测试 Harbor 连接
ping harbor.flnxi.com

# 手动登录 Harbor
docker login harbor.flnxi.com

端口被占用

# 查看端口占用
netstat -tuln | grep 4320
netstat -tuln | grep 9000

# 修改 docker-compose.prod.yml 中的端口配置

📞 需要帮助?

如果遇到问题,请检查:

  1. Docker 和 Docker Compose 版本是否符合要求
  2. NAS 系统日志
  3. Docker 容器日志:docker compose -f docker-compose.prod.yml logs