NSSM

NSSM 能做什么

NSSM 是一个类似于 srvany 和 cygrunsrv 的服务辅助程序， 但具备一个真正的服务管理器该有的功能。它可以把任何应用作为 NT 服务启动， 并在应用因任何原因失败时自动重启服务。

关于这个分支

NSSM 由 Iain Patterson 编写并以公共领域（public domain）授权发布，原站为 nssm.cc。上游最后一个版本（2.24）发布于 2017 年。 本项目是持续维护的延续版，包含以下改进，并与原版命令语法、注册表结构 100% 兼容。

快速上手

所有命令都需要管理员权限的命令提示符。下面的例子把一个 Node.js 应用安装为 名为 myapp 的服务，请替换成你自己的路径。

1. 安装服务

   最快的方式——所有参数直接写在命令行上：

   nssm install myapp "C:\apps\node\node.exe" "C:\apps\myapp\server.js"

   或者不带程序路径运行 nssm install myapp，会打开图形安装界面。路径中有空格必须加引号。

2. 调整基本配置

   rem 程序的启动目录
   nssm set myapp AppDirectory C:\apps\myapp
   
   rem 把 stdout 和 stderr 记录到日志文件
   nssm set myapp AppStdout C:\logs\myapp.out.log
   nssm set myapp AppStderr C:\logs\myapp.err.log
   
   rem 每 10 MB 轮转一次日志，并在每行前面加时间戳
   nssm set myapp AppRotateFiles 1
   nssm set myapp AppRotateBytes 10485760
   nssm set myapp AppTimestampLog 1
   
   rem 让服务显示为"我的应用"并附上描述
   nssm set myapp DisplayName "My Application"
   nssm set myapp Description "My web application server"

3. 启动服务

   nssm start myapp

   确认它在运行：

   nssm status myapp
   nssm processes myapp

4. 日常管理

   nssm restart myapp
   nssm stop myapp
   nssm list

   也可以用 services.msc 或 sc.exe 来控制——NSSM 管理的就是普通的 Windows 服务。

5. 备份或迁移

   nssm dump myapp

   输出一份可重建该服务的批处理脚本。在另一台机器上（先复制过去 nssm.exe）执行即可克隆服务。nssm dump myapp myapp2 会展示 myapp 的配置，但生成的命令针对名为 myapp2 的服务。

6. 卸载服务

   nssm remove myapp confirm

   NSSM 会先停止服务再删除。即使服务正在运行也不需要重启系统。

命令参考

凡是出现 <servicename> 的地方，既可以填服务的注册表键名， 也可以填它的显示名称。不带参数运行 nssm 可以查看内置帮助。

配置参考

所有配置都保存在注册表 HKLM\SYSTEM\CurrentControlSet\Services\<服务名>\Parameters 下，用 nssm get / nssm set / nssm reset 管理。 命令行上的参数名与下面的注册表值名称一致。

应用程序

进程控制

I/O 重定向

日志轮转

退出动作

NSSM 读取以应用退出码命名的 AppExit 值，找不到时回退到默认值。 退出码可到 Windows 事件日志里查。按退出码设置用 nssm set <服务> AppExit <退出码> <动作>，默认动作用 nssm set <服务> AppExit Default <动作>。

停止应用的方式

服务停止时 NSSM 按顺序尝试四种方式，每种默认超时 1500 毫秒，作用于整个进程树：

1. 在应用的控制台产生 Control-C 事件。
2. 向应用的窗口发送 WM_CLOSE。
3. 向应用的线程发送 WM_QUIT。
4. 调用 TerminateProcess()。

环境变量

每条是 KEY=VALUE；变量按出现顺序展开，所以 PATH=C:\bin;%PATH% 在 AppEnvironmentExtra 里能正常工作。 命令行下每对键值是一个独立参数，+KEY=VALUE / -KEY 可以增删单个变量：

nssm set myapp AppEnvironmentExtra JAVA_HOME=C:\jdk-17
nssm set myapp AppEnvironmentExtra +PATH=C:\apps\myapp\bin
nssm set myapp AppEnvironmentExtra -JAVA_HOME

系统级服务设置

这些对应标准的服务注册表值，对非 NSSM 管理的服务同样可以读写：

事件钩子

NSSM 可以在服务事件的前后运行你自己的命令。用 nssm set <服务名> AppEvents <事件>/<动作> <命令> 配置，或直接设置注册表字符串值 Parameters\AppEvents\<事件>\<动作>。

钩子继承服务的环境变量，并额外获得 %NSSM_EXE%、 %NSSM_SERVICE_NAME%、%NSSM_EVENT%、 %NSSM_EXITCODE% 等上下文变量；使用前先检查 %NSSM_HOOK_VERSION%。例：系统从待机恢复时自动重启服务：

nssm set myapp AppEvents Power/Resume "%NSSM_EXE% restart %NSSM_SERVICE_NAME%"

全部钩子环境变量（NSSM_HOOK_VERSION ≥ 1）

变量	内容
NSSM_EXE	NSSM 自身路径
NSSM_CONFIGURATION	编译信息，如 64-bit debug
NSSM_VERSION	NSSM 版本
NSSM_BUILD_DATE	NSSM 编译日期
NSSM_PID	运行中的 NSSM 进程 PID
NSSM_DEADLINE	多少毫秒后钩子会被强制结束
NSSM_SERVICE_NAME	服务注册表键名
NSSM_SERVICE_DISPLAYNAME	服务显示名
NSSM_COMMAND_LINE	启动应用所用的命令行
NSSM_APPLICATION_PID	应用进程 PID（可能为空）
NSSM_EVENT / NSSM_ACTION	触发钩子的事件类别与动作
NSSM_TRIGGER / NSSM_LAST_CONTROL	触发钩子的服务控制 / 最近一次处理的服务控制
NSSM_START_REQUESTED_COUNT	累计启动请求数
NSSM_START_COUNT	累计成功启动数
NSSM_THROTTLE_COUNT	距上次成功启动的慢启动次数
NSSM_EXIT_COUNT	累计应用退出次数
NSSM_EXITCODE	最近一次应用退出码（可能为空）
NSSM_RUNTIME	NSSM 已运行毫秒数
NSSM_APPLICATION_RUNTIME	应用自最近一次启动以来的运行毫秒数

Start/Pre 钩子返回退出码 99 时会中止应用启动。把 AppRedirectHooks 设为 1 可让钩子输出进入服务配置的 stdout/stderr。所有钩子超时后都会被强制结束。

常见问题与排障