sungamma/nas-tools

sungamma/nas-tools 镜像文档

镜像概述

sungamma/nas-tools镜像是一款适用于NAS环境的工具镜像，提供3.0及以上版本支持。该镜像特点是每次小版本后的提交均会重新编译，确保用户获取到最新的功能更新与稳定性改进，适用于NAS环境下的工具部署与管理场景。

核心功能与特性

• 版本管理：仅支持3.0及以上版本，确保功能完整性与安全性
• 编译策略：每次小版本后的提交均重新编译，保持镜像时效性
• 配置灵活性：默认端口为3000，可通过程序生成的config.yml文件修改
• 权限控制：支持通过PUID、PGID和UMASK环境变量配置运行权限
• 自动更新：可选启用自动更新功能，保持工具最新状态

使用场景与适用范围

适用于需要在NAS环境中部署工具的用户，可用于媒体文件管理、数据同步、服务监控等场景，尤其适合需要持续获取功能更新的NAS用户。

使用方法与配置说明

基本部署（docker-compose）

推荐使用docker-compose进行部署，以下是完整配置示例：

yaml
version: "3.2"

services:
  nas-tools:
    image: sungamma/nas-tools:latest
    # 默认端口是3000，可通过程序生成的config.yml文件修改
    volumes:
      - /volume1/docker/nastools:/config  # 配置文件存储路径
      - /volume1/movie:/volume1/movie    # 媒体文件挂载（主机路径:容器内路径）
    environment: 
      - PUID=1027    # 执行用户ID（根据实际用户名获取）
      - PGID=100     # 用户组ID（根据实际用户组获取）
      - UMASK=022    # 文件权限掩码
      # - NASTOOL_AUTO_UPDATE=true  # 取消注释启用自动更新
    restart: always  # 容器退出后自动重启
    network_mode: host  # 使用主机网络模式
    hostname: nas-tools  # 容器主机名
    container_name: nas-tools  # 容器名称

参数说明

卷挂载（volumes）

• /config：配置文件存储目录，需映射到主机持久化存储路径（如示例中的/volume1/docker/nastools）
• 其他媒体路径：根据实际需求挂载，格式为主机路径:容器内路径（如示例中的媒体文件路径）

环境变量（environment）

• PUID：执行用户ID，用于控制容器内文件访问权限，需根据实际用户名获取
• PGID：用户组ID，与PUID配合控制权限，需根据实际用户组获取
• UMASK：文件权限掩码，默认022
• NASTOOL_AUTO_UPDATE：可选，设置为true启用自动更新功能（默认注释禁用）

网络与运行设置

• network_mode: host：使用主机网络模式，便于端口映射与网络访问
• restart: always：确保容器在意外退出后自动重启
• hostname与container_name：自定义容器主机名与名称，便于识别与管理

端口配置

默认端口为3000，如需修改，可在容器启动后通过生成的config.yml文件进行配置调整。