docker-nzbget-ghost 镜像文档

一、镜像概述和主要用途

概述

docker-nzbget-ghost 是基于 linuxserver/nzbget 镜像的配置包装器（config wrapper），旨在简化 NZBGet（一款高效的 Usenet 下载客户端）的容器化部署与配置流程。该镜像通过预设配置模板、简化初始设置步骤，帮助用户快速启动并管理 NZBGet 服务，同时保持与 linuxserver/nzbget ***镜像的兼容性。

主要用途

作为 NZBGet 的容器化部署方案，提供开箱即用的 Usenet 下载服务；
简化 NZBGet 初始配置流程，降低用户操作门槛；
标准化 NZBGet 运行环境，确保配置一致性与稳定性。

二、核心功能和特性

配置简化
集成预设配置模板，覆盖基础下载路径、连接参数、安全设置等常用选项，减少手动配置工作量。
兼容性
完全兼容 linuxserver/nzbget 镜像的核心功能与参数，支持其原生配置文件结构与运行机制。
持久化管理
优化配置文件与数据目录的持久化方案，支持通过卷挂载保存用户自定义配置及下载文件。
轻量设计
基于***基础镜像构建，无冗余依赖，保持镜像体积精简。

三、使用场景和适用范围

个人/家庭用户：需要快速部署 NZBGet 进行 Usenet 下载，且希望简化配置流程的场景；
标准化部署：需在多环境中保持一致 NZBGet 配置的场景（如家庭服务器、NAS 设备）；
新手用户：对 NZBGet 配置不熟悉，需要预设最佳实践配置快速上手的用户。

四、使用方法和配置说明

4.1 前置要求

已安装 Docker 或 Docker Compose；
了解基础容器操作（如镜像拉取、容器启动、卷挂载）。

4.2 快速启动（Docker Run）

基础命令

bash
docker run -d \
  --name=nzbget-ghost \
  -p 6789:6789 \  # NZBGet Web 管理端口
  -v /path/to/config:/config \  # 配置文件持久化目录
  -v /path/to/downloads:/downloads \  # 下载文件存储目录
  -e PUID=1000 \  # 运行用户 UID（避免权限问题）
  -e PGID=1000 \  # 运行用户 GID
  -e TZ=Asia/Shanghai \  # 时区设置（如 Asia/Shanghai）
  --restart unless-stopped \
  docker-nzbget-ghost

参数说明

-p 6789:6789：映射容器内 6789 端口（NZBGet 默认 Web 端口）到主机，用于访问 Web 管理界面；
-v /path/to/config:/config：挂载主机目录到容器内 /config，持久化 NZBGet 配置文件；
-v /path/to/downloads:/downloads：挂载下载目录，存储下载文件；
-e PUID/PGID：指定运行用户的 UID/GID（需与主机目录权限匹配，避免文件读写权限问题）；
-e TZ：设置时区，确保日志时间与本地时间一致。

4.3 Docker Compose 配置

示例配置文件（`docker-compose.yml`）

yaml
version: "3"

services:
  nzbget-ghost:
    image: docker-nzbget-ghost
    container_name: nzbget-ghost
    restart: unless-stopped
    ports:
      - "6789:6789"
    volumes:
      - /path/to/config:/config
      - /path/to/downloads:/downloads
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Asia/Shanghai

启动命令

bash
docker-compose up -d

4.4 访问 Web 管理界面

容器启动后，通过 http://<主机IP>:6789 访问 NZBGet Web 管理界面，默认用户名/密码为 nzbget/tegbzn6789（首次登录需修改默认密码）。

4.5 配置自定义

配置文件路径

容器内配置文件位于 /config/nzbget.conf，通过宿主机挂载的 /path/to/config 目录可直接编辑该文件（需重启容器生效）。

自定义配置项

支持修改 nzbget.conf 中的所有原生 NZBGet 配置项，例如：

ControlPort：修改 Web 管理端口；
DownloadDir：调整下载文件存储路径；
Server1.Host/Server1.Port：配置 Usenet 服务器信息。

五、环境变量说明

环境变量	必须	说明
`PUID`	是	运行容器的用户 UID（建议设为宿主机当前用户 UID，避免权限问题）
`PGID`	是	运行容器的用户 GID（同上）
`TZ`	否	时区（如 `Asia/Shanghai`，默认 `UTC`）
`UMASK`	否	文件权限掩码（默认 `022`）

六、注意事项

配置持久化：务必通过 -v 挂载 /config 目录，避免容器重建后配置丢失；
权限问题：确保宿主机 /path/to/config 和 /path/to/downloads 目录权限与 PUID/PGID 匹配（可通过 chown -R <PUID>:<PGID> /path/to/dir 调整）；
版本兼容：镜像与 linuxserver/nzbget 保持版本同步，升级前建议备份配置文件。