Shawl - 简易Windows服务包装器

Shawl是一款用Rust语言编写的工具，用于将任意程序包装成Windows服务。它替您处理繁琐的Windows服务API，使您的程序只需响应ctrl-C/SIGINT信号即可。如果您正在开发一个需要作为服务运行的项目，只需要将Shawl与您的项目一起打包，并将其设置为入口点，通过命令行接口传递要执行的命令。

安装

1. 预编译二进制文件: 您可以在发布页面上下载预编译好的版本，它是便携式的，可以直接放入任何位置。
2. Rust安装: 如果您的机器已安装Rust，可以运行cargo install shawl进行安装。
3. 使用Scoop: 先添加额外的bucket并安装scoop bucket add extras && scoop install shawl。更新时运行scoop update && scoop update shawl。

使用方法

创建一个由Shawl包裹的服务，例如：

• 使用Shawl的add命令：shawl add --name my-app -- C:/path/my-app.exe
• 使用Windows sc命令以获得更多控制权：

  sc create my-app binPath= "C:/path/shawl.exe run --name my-app -- C:/path/my-app.exe"
  sc config my-app start= auto
  sc start my-app
  

Shawl会检查您的程序状态，以便向Windows报告正确的服务状态：

• 默认情况下，当您的程序退出且退出代码非零时，Shawl会重新启动它。您可以使用--(no-)restart来控制所有退出代码的行为，或者使用--restart-if(-not)来针对特定退出代码定制行为。请注意，这四个选项互斥。
• 当服务被请求停止时，Shawl会发送一个ctrl-C事件给您的程序，然后在--stop-timeout(默认3秒)后等待，如果程序未终止，会选择强制结束。
• 在这两种情况中，如果Shawl不重启程序，它会将退出代码报告给Windows作为服务特定错误，除非退出代码是0或您已配置的--pass代码。

命令行界面（CLI）

完整帮助文本可查看docs/cli.md。

日志记录

Shawl为每个服务创建日志文件（如shawl_for_<service>_*.log），基于--name参数，在Shawl执行文件的同一目录下，记录其自身消息和所运行命令的输出。若出现问题，您可以查看日志获取更多信息。可通过--no-log禁用所有日志，或通过--no-log-cmd禁用命令日志。默认情况下，每个日志文件限制为2MB，最多保留2个历史副本。

账户管理

默认新服务使用Local System账户，该账户的PATH环境变量与您的用户账户不同。如果配置Shawl运行像npm start这样的命令，这意味着npm需要在Local System账户的PATH中，或者您可以更改服务使用的账户。需要注意的是，使用Local System账户运行服务就像Unix系统中的root权限一样危险，增加了系统被黑客攻击的风险。建议使用受限账户，如Network Service，来运行服务。

与其他工具的比较

与WinSW和NSSM等现有解决方案相比，它们需要运行特殊的安装命令来准备服务，这在某些场景（如通过MSI安装服务）中可能不太方便。Shawl没有特殊配置，您可以自由地以常规的MSI ServiceInstall 或者运行 sc create 来配置服务，因为Shawl并不需要特别的设置。shawl add命令只是作为可选的便利功能。

开发与贡献

有关开发和贡献的详细信息，请查阅CONTRIBUTING.md。

---

利用Shawl，您可以轻松地将应用程序转换为Windows服务，享受其简洁的API和灵活的配置选项。无论是简单的小型应用还是复杂的服务器端软件，Shawl都能为您提供有力的支持。立即尝试Shawl，让您的服务管理和运行更加便捷高效！