xjianglin/nas-tools

NAS-Tools Docker镜像文档

镜像概述

本镜像基于NAStool/nas-tools:2.9.2最后一版commit e3a43d4构建，是一款轻量级的NAS媒体管理工具容器化实现。采用alpine系统作为基础，具有体积小、镜像层数少的特点，同时支持amd64和arm64架构，适用于多种硬件环境。

核心功能和特性

• 基础版本：基于NAStool/nas-tools:2.9.2（commit e3a43d4）构建
• 轻量级设计：采用alpine系统，镜像体积小，层数少
• 多架构支持：兼容amd64和arm64架构
• 便捷更新：重启容器即可更新程序；依赖变化时会自动尝试重新安装，若失败则提示更新镜像
• 权限控制：支持以非root用户执行任务，降低潜在风险
• 权限管理：可设置文件掩码权限umask
• Lite版本特性：体积更小，但不包含浏览器内核及xvfb（不支持浏览器仿真），不支持Rclone/Minio转移方式，不支持复杂依赖变更时的自动安装升级

使用场景

适用于需要在NAS环境中进行媒体管理的用户，尤其适合关注镜像体积、权限安全及跨架构支持的场景。Lite版本适合对功能要求较简单、追求极致轻量化部署的用户。

使用方法和配置说明

注意事项

• 媒体目录的设置必须符合https://github.com/jxxghp/nas-tools#%E9%85%8D%E7%BD%AE%E7%9A%84%E8%A6%81%E6%B1%82
• umask含义详见：[***]
• 创建容器后，请根据https://github.com/jxxghp/nas-tools#%E9%85%8D%E7%BD%AE%E5%8F%8A%E6%96%87%E4%BB%B6%E6%B3%A8%E9%87%8A%E4%BF%AE%E6%94%B9%60config/config.yaml%60%EF%BC%8C%E4%BF%AE%E6%94%B9%E5%AE%8C%E6%88%90%E5%90%8E%E9%87%8D%E5%90%AF%E5%AE%B9%E5%99%A8%EF%BC%8C%E6%9C%80%E5%90%8E%E9%80%9A%E8%BF%87%60http://:<web_port>`访问

Docker CLI部署

bash
docker run -d \
    --name nas-tools \
    --hostname nas-tools \
    -p 3000:3000   `# 默认的webui控制端口` \
    -v $(pwd)/config:/config  `# 冒号左边请修改为你想在主机上保存配置文件的路径` \
    -v /你的媒体目录:/你想设置的容器内能见到的目录    `# 媒体目录，多个目录需要分别映射进来` \
    -e PUID=0     `# 运行程序的用户uid，详见下方说明` \
    -e PGID=0     `# 运行程序的用户gid，详见下方说明` \
    -e UMASK=000  `# 掩码权限，默认000，可考虑设置为022` \
    -e NASTOOL_AUTO_UPDATE=false `# 启动容器时自动升级程序请设置为true` \
    -e NASTOOL_CN_UPDATE=false `# 开启自动升级且网络不佳时，设置为true使用国内源更新` \
    jxxghp/nas-tools

网络优化：若访问GitHub网络不佳，可添加环境变量： -e REPO_URL="https://ghproxy.com/https://github.com/jxxghp/nas-tools.git" \

Docker Compose部署

新建docker-compose.yaml文件，内容如下，然后执行docker-compose up -d启动：

yaml
version: "3"
services:
  nas-tools:
    image: jxxghp/nas-tools:latest
    ports:
      - 3000:3000        # 默认的webui控制端口
    volumes:
      - ./config:/config   # 冒号左边请修改为保存配置的路径
      - /你的媒体目录:/你想设置的容器内能见到的目录   # 媒体目录，多个需分别映射，需满足配置文件要求
    environment: 
      - PUID=0    # 运行程序的用户uid
      - PGID=0    # 运行程序的用户gid
      - UMASK=000 # 掩码权限，默认000，可考虑设置为022
      - NASTOOL_AUTO_UPDATE=false  # 启动时自动升级程序请设置为true
      - NASTOOL_CN_UPDATE=false # 开启自动升级且网络不佳时，设置为true使用国内源
     #- REPO_URL=https://ghproxy.com/https://github.com/jxxghp/nas-tools.git  # 访问GitHub网络差时取消注释
    restart: always
    network_mode: bridge
    hostname: nas-tools
    container_name: nas-tools

后续更新方法

• 自动更新：若设置NASTOOL_AUTO_UPDATE=true，重启容器即可自动更新程序
• 更新失败处理：日志提示"更新失败，继续使用旧的程序来启动..."时，建议再次重启；若持续失败，需改善网络环境
• 依赖安装失败：日志提示"无法安装依赖，请更新镜像..."时，需删除旧容器和镜像，重新拉取镜像并创建容器

关于PUID/PGID的说明

• 一致性要求：若同时使用emby、jellyfin、plex、qbittorrent、transmission、deluge、jackett、sonarr、radarr等Docker镜像，需保证本容器的PUID/PGID与它们一致
• 获取方法：在Docker宿主上，登录媒体文件所有者用户，执行id -u获取uid（对应PUID），id -g获取gid（对应PGID）
• 权限建议：PUID=0 PGID=0为root用户，拥有最高权限；若媒体文件所有者非root，不建议使用root权限

硬连接映射说明

参考下图（由imogel@***制作）：

!https://github.com/receyuki/nas-tools/blob/v2.9.1-e3a43d4/docker/volume.png