• oneClick: 是否创建一键式安装程序。如果为 true,则默认为所有用户安装;如果为 false,则需要根据 perMachine 参数来决定是否安装至所有用户。

  • perMachine: 仅当 oneClick 为 false 时有效。是否显示安装模式页面(选择每台机器还是每个用户),默认为 false(即显示)。

  • allowElevation: 仅在 assisted installer 下有效。允许请求提权,默认为 true。如果为 false,则用户将需要以管理员权限重新启动安装程序。

  • allowToChangeInstallationDirectory: 仅在 assisted installer 下有效。是否允许用户更改安装目录,默认为 false。

  • removeDefaultUninstallWelcomePage: 仅在 assisted installer 下有效。是否删除默认的卸载欢迎页面,默认为 false。

  • installerIcon: 安装程序图标路径,默认为 build/installerIcon.ico 或应用程序图标。

  • uninstallerIcon: 卸载程序图标路径,默认为 build/uninstallerIcon.ico 或应用程序图标。

  • installerHeader: assisted installer 下的 MUI_HEADERIMAGE,相对于 build 资源或项目目录,默认为 build/installerHeader.bmp 或 undefined。

  • installerHeaderIcon: one-click installer 下进度条上方的头部图标路径,相对于 build 资源或项目目录,默认为 build/installerHeaderIcon.ico 或应用程序图标。

  • installerSidebar: assisted installer 下的 MUI_WELCOMEFINISHPAGE_BITMAP 路径,相对于 build 资源或项目目录,默认为 build/installerSidebar.bmp 或 ${NSISDIR}\Contrib\Graphics\Wizard\nsis3-metro.bmp,图像大小为 164 × 314 像素。

  • uninstallerSidebar: assisted installer 下的 MUI_UNWELCOMEFINISHPAGE_BITMAP 路径,相对于 build 资源或项目目录,默认取决于 installerSidebar 选项,或为 build/uninstallerSidebar.bmp 或 build/installerSidebar.bmp 或 ${NSISDIR}\Contrib\Graphics\Wizard\nsis3-metro.bmp。

  • uninstallDisplayName: 在控制面板中显示的卸载程序名称,格式为 ”${productName} ${version}”。

  • include: 定制安装程序的 NSIS include 脚本路径,默认为 build/installer.nsh。可查看 Custom NSIS script。

  • script: 定制安装程序的 NSIS 脚本路径,默认为 build/installer.nsi。可查看 Custom NSIS script。

  • license: EULA 许可证文件路径,默认为 license.txt 或 eula.txt(或大写变体)。支持 txt、rtf 和 html 格式(不要忘记为链接使用 target=“_blank”)。支持多种不同语言的许可证文件,只需在后面添加语言编码后缀(例如 _de、_ru)即可,如创建 build resources 中的 license_de.txt 和 license_en.txt 文件。如果 OS 语言是德语,则会显示 license_de.txt 文件。可查看 language code to name 表格。

  • artifactName: 工件文件名称模板,默认为 ”${productName} Setup version.

    version.{ext}”。

  • deleteAppDataOnUninstall: 仅在 one-click installer 下有效。是否在卸载时删除应用程序数据,默认为 false。

  • displayLanguageSelector: 是否显示语言选择对话框,默认为 false(建议不要修改,系统会自动检测)。

  • installerLanguages: 安装程序语言(例如 en_US、de_DE)。只有当你理解你所做的和为何这样做时才更改此选项。

  • language: LCID Dec,默認為 1033(英语 - 美国)。

  • multiLanguageInstaller: 是否创建多语言安装程序,默认为 unicode 选项值。

  • packElevateHelper: 是否打包 elevate 可执行文件(如果使用 per-machine 安装程序或将来可能使用),仅在 assisted installer 下有效。如果为 true,则会忽略 perMachine 参数。

  • preCompressedFileExtensions: 不压缩的文件扩展名(例如 “.avi”、“.mov” 等),仅适用于 extraResources 和 extraFiles 文件。

  • unicode: 是否创建 Unicode 安装程序。

  • guid: 参见 GUID vs Application Name。

  • warningsAsErrors: 如果为 true,则 NSIS 将把警告视为错误。如果为 false,则 NSIS 将允许警告。

  • customNsisBinary: 允许您提供自己的 makensis,例如支持通过 LogSet 和 LogText 进行调试记录的 makensis。(日志记录还需要选项 debugLogging = true)

  • runAfterFinish: 是否在安装完成后运行安装程序。

  • createDesktopShortcut: 是否在桌面上创建快捷方式。如果为 “always”,则即使用户已删除快捷方式,也将在重新安装时重新创建它。

  • createStartMenuShortcut: 是否在开始菜单中创建快捷方式。

  • menuCategory: 是否为开始菜单快捷方式和程序文件目录创建子菜单。如果为 true,则使用公司名称。或者字符串值。

  • shortcutName: 所有快捷方式将使用的名称。默认为应用程序名称。

个人笔记记录 2021 ~ 2025