zoeyvid/npmplus

NPMplus 镜像文档

概述

NPMplus 是 nginx-proxy-manager 的增强分支，旨在通过改进和扩展功能，进一步简化 Nginx 代理服务器的管理流程。该镜像继承了 nginx-proxy-manager 直观的 Web 管理界面，并在此基础上提供更多高级特性，帮助用户轻松配置反向代理、管理 SSL 证书及优化代理规则，无需深入编写复杂的 Nginx 配置文件。

主要用途

• 简化反向代理规则的创建、编辑与管理
• 自动化 SSL 证书的申请、续期及部署（集成 Let's Encrypt）
• 集中管理多个域名与后端服务的映射关系
• 通过图形界面配置访问控制、重定向及其他 Nginx 高级功能

核心功能和特性

基础功能

• Web 管理界面：无需手动编辑配置文件，通过直观界面完成所有操作
• 反向代理管理：支持 HTTP/HTTPS 协议，快速将域名映射到后端服务（如 Docker 容器、本地服务等）
• SSL 证书管理：自动申请 Let's Encrypt 证书，支持证书自动续期及自定义证书上传
• 访问控制：配置基本身份验证、IP 白名单/黑名单等访问限制规则

增强特性（相较于 nginx-proxy-manager）

• 提供更多高级配置选项，支持复杂场景下的代理需求
• 优化性能与稳定性，提升大规模部署时的可靠性
• 改进的用户界面交互体验，操作流程更简洁
• 可能包含额外集成功能（如日志分析、统计监控等，具体以官方文档为准）

使用场景和适用范围

适用场景

• 个人服务器或小型企业环境中管理多域名/多服务的反向代理
• 需要快速部署 HTTPS 服务且自动维护 SSL 证书的场景
• 非专业 Nginx 用户通过图形界面简化代理配置
• 对 nginx-proxy-manager 功能有扩展需求的进阶用户

适用范围

• 兼容 Docker 环境，支持主流 Linux 发行版（如 Ubuntu、Debian、CentOS 等）
• 适用于单服务器或小型服务器集群的 Nginx 代理管理
• 支持从家庭实验室到中小型生产环境的各类规模部署

使用方法和配置说明

前提条件

• 已安装 Docker 和 Docker Compose
• 服务器具备公网 IP（如需申请 Let's Encrypt 证书）
• 目标域名已正确解析至服务器 IP

快速部署

Docker Run 命令

bash
docker run -d \
  --name npmplus \
  -p 80:80 \    # HTTP 端口（用于 Let's Encrypt 验证及 HTTP 代理）
  -p 443:443 \  # HTTPS 端口（用于 HTTPS 代理）
  -p 81:81 \    # Web 管理界面端口
  -v /path/to/npmplus/data:/data \          # 配置数据持久化目录
  -v /path/to/npmplus/letsencrypt:/etc/letsencrypt \  # SSL 证书持久化目录
  --restart unless-stopped \
  zoeyvid/npmplus:latest

Docker Compose 配置

创建 docker-compose.yml 文件：

yaml
version: '3'
services:
  npmplus:
    image: zoeyvid/npmplus:latest
    container_name: npmplus
    ports:
      - "80:80"
      - "443:443"
      - "81:81"
    volumes:
      - ./data:/data           # 替换为本地数据目录路径
      - ./letsencrypt:/etc/letsencrypt  # 替换为本地证书目录路径
    environment:
      - TZ=Asia/Shanghai       # 设置时区（可选）
      - PUID=1000              # 运行用户 ID（可选，默认 0）
      - PGID=1000              # 运行用户组 ID（可选，默认 0）
    restart: unless-stopped

执行部署命令：

bash
docker-compose up -d

初始访问与配置

1. 访问管理界面：部署完成后，通过 http://服务器IP:81 访问 Web 界面
2. 初始登录：默认凭据（首次登录需修改）：
   • 用户名：admin@example.com
   • 密码：changeme
3. 基本配置流程：
   • 导航至「Proxy Hosts」→「Add Proxy Host」添加反向代理规则
   • 填写域名、后端服务地址（如 http://192.168.1.100:3000）及端口
   • 切换至「SSL」选项卡，选择「Request a new SSL Certificate」自动申请证书
   • 保存配置，NPMplus 将自动生成并应用 Nginx 配置

数据持久化

为避免容器重启后配置丢失，需持久化以下目录：

• /data：存储配置数据、数据库及用户设置
• /etc/letsencrypt：存储 SSL 证书文件

环境变量配置

支持通过环境变量自定义运行参数（具体以官方文档为准）：

• DB_SQLITE_FILE：SQLite 数据库文件路径，默认 /data/database.sqlite
• TZ：时区设置，如 Asia/Shanghai
• PUID/PGID：运行容器的用户/组 ID，用于权限控制
• LOG_LEVEL：日志级别，可选 info/warn/error/debug

注意事项

• 详细功能和最新配置说明请参考官方 GitHub 文档：https://github.com/ZoeyVid/NPMplus/blob/develop/README.md
• 升级镜像前建议备份 /data 和 /etc/letsencrypt 目录，防止数据丢失
• 确保服务器防火墙开放 80、443（业务端口）和 81（管理界面端口），具体端口可根据配置调整
• 生产环境中建议通过环境变量 PUID/PGID 配置非 root 用户运行，提升安全性