配置
Tauri的配置对象，它是从文件中读取的。 你可以在里面自定义前端资源、配置打包选项、开启应用自动更新、定制系统托盘，还有配置API的白名单等等。
配置文件在你的Tauri应用源目录(src-tauri)通过执行 tauri init命令生成。
生成后你也可以随时对其进行修改，来自定义Tauri应用。
文件格式
默认情况下，配置被定义为一个名为 tauri.conf.json 的 JSON 文件。
Tauri 还分别通过 config-json5 和 config-toml 这两个 Cargo 特性支持 JSON5 和 TOML 文件。
JSON5 文件名必须为 tauri.conf.json 或 tauri.conf.json5。
TOML 文件名为 Tauri.toml。
平台特定配置
除了默认配置文件外，Tauri 还可以从 tauri.linux.conf.json、tauri.windows.conf.json 和 tauri.macos.conf.json（如果使用 Tauri.toml 格式，则为 Tauri.linux.toml、Tauri.windows.toml 和 Tauri.macos.toml）中读取平台特定的配置，这些配置将与主配置对象合并。
配置结构
配置由以下对象组成：
{
"build": {
"beforeBuildCommand": "",
"beforeDevCommand": "",
"devPath": "../dist",
"distDir": "../dist"
},
"package": {
"productName": "tauri-app",
"version": "0.1.0"
},
"tauri": {
"allowlist": {
"all": true
},
"bundle": {},
"security": {
"csp": null
},
"updater": {
"active": false
},
"windows": [
{
"fullscreen": false,
"height": 600,
"resizable": true,
"title": "Tauri App",
"width": 800
}
]
}
}PackageConfig
包相关的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
App名称 |
|
|
null |
应用程序版本。它是一个符合语义化版本控制的版本号，或者是包含 |
TauriConfig
Tauri相关的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
使用的模式。 |
||
|
[] |
窗口配置。 |
|
|
命令行配置。 |
||
|
打包配置。 |
||
|
白名单配置。 |
||
|
安全配置。 |
||
|
更新配置。 |
||
|
应用系统托盘配置。 |
||
|
|
|
macOS 私有 API 配置。启用透明背景 API 并将 |
WindowConfig
窗口配置对象。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
窗口的id标识符。必须由字母数字组成。 |
|
窗口的 webview URL。 |
||
|
|
null |
webview中的user agent。 |
|
|
|
webview是否启用了文件拖放功能。默认情况下它是启用的。 在Windows的前端禁用它是为了使用拖放功能。 |
|
|
|
窗口启动时是否居中显示。 |
|
|
null |
窗口左上角的水平位置。 |
|
|
null |
窗口左上角的垂直位置。 |
|
|
|
窗口宽度。 |
|
|
|
窗口高度。 |
|
|
null |
窗口的最小宽度。 |
|
|
null |
窗口的最小高度。 |
|
|
null |
窗口的最大宽度。 |
|
|
null |
窗口的最大高度。 |
|
|
|
窗口是否允许调整大小。 |
|
|
null |
窗口的标题。 |
|
|
|
窗口启动后是否全屏。 |
|
|
|
窗口启动后是否获得焦点。 |
|
|
|
窗口是否透明。 注意，在 |
|
|
|
窗口是否最大化。 |
|
|
|
窗口是否可见。 |
|
|
|
窗口是否应该拥有边框和条栏。 |
|
|
|
窗口是否保持在其它窗口的上方。 |
|
|
|
防止窗口内容被其他应用程序捕获。 |
|
|
|
如果为 |
|
初始窗口主题。默认为系统主题。仅在Windows和macOS 10.14及以上版本可用。 |
||
|
macOS 标题栏的风格。 |
||
|
|
|
如果为 |
|
|
|
在macOS上，点击非活动窗口是否也会传递点击webview的事件。 |
|
|
null |
定义了macOS的 窗口标签标识符。 具有匹配标签标识符的窗口将被分组在一起。如果未设置标签标识符，则自动标签功能将被禁用。 |
|
|
null |
在Windows上定义额外的浏览器参数。默认情况下会传递参数 |
WindowUrl
打开Tauri webview窗口的URL。
可以是以下任意类型：
-
string(format:uri):一个外部URL。 -
string:应用程序URL的路径部分。例如，要加载tauri://localhost/users/john，你可以在简单地配置为users/john。
TitleBarStyle
在macOS上，窗口标题栏应该如何显示。
可以是以下类型中的任何一个：
-
"Visible": 正常的标题栏。
-
"Transparent": 透明的标题栏，以便显示窗口背景颜色。
如果您不需要在标题栏下有实际的HTML内容，这可以让您避免使用TitleBarStyle::Overlay的注意事项。当Tauri允许您设置自定义窗口背景颜色时，这将更加有用。 -
"Overlay": 在窗口内容上以透明覆盖层的形式显示标题栏。
请注意：
-
不同操作系统版本的标题栏高度可能不同，这可能导致窗口控件和标题出现在您意想不到的位置。
-
您需要定义一个自定义拖拽区域来使窗口可拖动，但由于一个限制，当窗口没有焦点时您无法拖动窗口，有关这个问题的讨论可以在Tauri的GitHub问题跟踪器中找到，链接是： https://github.com/tauri-apps/tauri/issues/4316。
-
窗口标题的颜色取决于系统主题。
CliConfig
描述命令行的配置
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
命令描述，将显示在帮助信息中。 |
|
|
null |
命令的详细描述，将在帮助信息中展示。 |
|
|
null |
在帮助信息中除了自动生成的帮助内容外，添加额外的帮助信息。这些信息会在自动生成的帮助信息之前显示。这通常用于显示头部信息。 |
|
|
null |
在自动生成的帮助信息之外添加额外的帮助信息。这些信息会在自动生成的帮助信息之后显示。这通常用于描述如何使用参数，或者需要注意的事项。 |
|
|
null |
命令的参数列表。 |
|
|
null |
命令的子命令列表。 |
CliArg
CLI参数定义。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
参数的简短版本，不包括前面的 -。 注意：任何前导的 |
|
|
null |
唯一参数名称。 |
|
|
null |
参数的描述，将在帮助信息中显示。通常，这是对参数的简短（一行）描述。 |
|
|
null |
参数的详细描述，将在帮助信息中展示。通常这是一个更详细（多行）的消息，用来描述参数。 |
|
|
|
指定该参数在运行时需要一个值。 注意：参数的值可以通过以下任何一种方式指定： |
|
|
|
指定参数可能具有未知数量的多个值。如果没有其他设置，此参数只能出现一次。 例如， 注意：设置此项需要将 |
|
boolean |
|
指定参数可以出现多次。对于标志（flags），这将记录标志出现的次数。例如， 例如，允许使用 |
|
|
null |
指定需要多少个值来满足这个参数。例如，如果你有一个 注意：不需要设置 注意：隐式设置 |
|
|
null |
指定此参数的可能值列表。在运行时，CLI会验证是否只使用了指定值中的一个，否则会以错误消息失败。 |
|
|
null |
指定此参数的最小值数量。例如，如果你有一个 |
|
|
null |
指定此参数的最大值数量。例如，如果你有一个 |
|
|
|
默认情况下设置参数是否必需。 - 默认必需意味着它是必需的，当没有其他冲突的规则被评估时 |
|
|
null |
设置一个参数，该参数会覆盖此参数的必需设置，即除非存在另一个参数，否则此参数将是必需的。 |
|
|
null |
设置参数，这些参数会覆盖此参数的必需设置，即除非所有这些其他参数都存在，否则此参数将是必需的。 |
|
|
null |
设置参数，这些参数会覆盖此参数的必需设置，即除非至少有一个这些其他参数存在，否则此参数将是必需的。 |
|
|
null |
设置一个冲突的参数，通过名称指定，即当使用这个参数时，以下参数不能存在，反之亦然。 |
|
|
null |
与 |
|
|
null |
测试一个参数，通过名称指定，即当此参数存在时，以下参数必须存在。 |
|
|
null |
设置多个参数，通过名称指定，这些参数在当前参数存在时是必需的，即在使用这个参数时，以下参数必须存在。 |
|
|
null |
允许有条件的需求，具有签名 [arg, value]，只有在 |
|
|
null |
允许指定参数的需求是有条件的，具有签名 [arg, value]，只有在 |
|
|
null |
要求选项使用 |
|
|
null |
位置参数的索引，从1开始。 该索引是相对于其他位置参数的位置。它并不定义在整个参数列表中的位置。当与 |
BundleConfig
Tauri打包的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
Tauri 是否应该打包你的应用程序还是只输出可执行文件。 |
|
目前支持的打包目标包括 ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] 或 "all"。 |
||
|
|
应用程序标识符应使用反向域名表示法（例如 |
|
|
|
null |
应用程序的发布者。默认情况下，它是标识符字符串中的第二个元素。目前它对应于 Windows 安装程序的 Manufacturer 属性。 |
|
|
[] |
应用的图标 |
|
|
null |
应用程序需要打包的资源。每个资源是指向文件或目录的路径。支持使用通配符模式。 |
|
|
null |
与您的应用程序相关的版权字符串。 |
|
|
null |
应用程序类型。 应该是以下之一：商务、开发者工具、教育、娱乐、金融、游戏、动作游戏、冒险游戏、街机游戏、棋盘游戏、纸牌游戏、赌场游戏、骰子游戏、教育游戏、家庭游戏、儿童游戏、音乐游戏、益智游戏、赛车游戏、角色扮演游戏、模拟游戏、体育游戏、策略游戏、问答游戏、文字游戏、图形与设计、健康与健身、生活方式、医疗、音乐、新闻、摄影、生产力、参考、社交网络、体育、旅行、实用工具、视频、天气。 |
|
|
null |
您的应用程序的简短描述。 |
|
|
null |
应用程序的详细描述是一个多行文本。 |
|
AppImage 捆绑包的配置。 |
||
|
Debian 捆绑包的配置。 |
||
|
macOS 捆绑包的配置。 |
||
|
|
null |
用于应用程序的二进制文件列表——可以是绝对路径或相对路径。 请注意，Tauri 会按照 "binary-name{-target-triple}{.system-extension}" 的模式寻找特定于系统的二进制文件。 例如，对于外部二进制文件 "my-binary"，Tauri 会寻找： - Windows 系统下的 "my-binary-x86_64-pc-windows-msvc.exe" 因此，别忘了为所有目标平台提供二进制文件。 |
|
Windows 包的配置。 |
AppImageConfig
AppImage 打包的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
包括音频和视频播放所需的额外 gstreamer 依赖项。这将根据你的构建系统，使打包大小增加约 15-35MB。 |
DebConfig
Debian（.deb）打包的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
您的应用程序所依赖的Debian软件包列表。 |
|
|
null |
软件包中要包含的文件列表。 |
MacConfig
macOS捆绑包的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
指示需要与应用程序捆绑的任何macOS X框架的字符串列表。 如果使用名称，则必须省略“.framework”，系统会查找标准安装位置。您还可以使用指向特定框架的路径。 |
|
|
null |
一个版本字符串，指示捆绑的应用程序支持的最低macOS X版本。默认为 将其设置为 空字符串被视为无效值，因此使用默认值。 |
|
|
null |
允许您的应用程序与外界通信。它应该是小写的，不带端口和协议的域名。 |
|
|
null |
要添加到DMG捆绑包的许可证文件的路径。 |
|
|
null |
用于代码签名的身份。 |
|
|
null |
公证的提供商简称。 |
|
|
null |
权利文件的路径。 |
WindowsConfig
Windows打包配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
指定用于创建文件签名的文件摘要算法。代码签名时必需。建议使用SHA-256。 |
|
|
null |
指定签名证书的SHA1哈希。 |
|
|
null |
时间戳使用的服务器。 |
|
|
|
是否使用时间戳协议（TSP，即RFC 3161）作为时间戳服务器。您的代码签名提供商可能使用TSP时间戳服务器，例如SSL.com。如果是这样，请将其设置为true以启用TSP。 |
|
Webview2运行时的安装模式。 |
||
|
|
null |
要使用的Webview固定运行时的路径。如果设置，将覆盖 将在v2中删除，建议使用 固定版本可以从 官方网站 下载。必须将 |
|
|
|
验证第二次应用程序安装，如果设置为 例如，如果已安装 此标志的默认值为 |
|
使用WiX生成的MSI的配置。 |
||
|
使用NSIS生成的安装程序的配置。 |
WebviewInstallMode
Webview2运行时的安装模式。请注意，对于更新程序捆绑包，使用 DownloadBootstrapper。
可以是以下类型中的任何一个：
-
{"type":"skip"}: 不要将Webview2作为Windows安装程序的一部分进行安装。 -
{ "type": "downloadBootstrapper", "silent": boolean }: 下载引导程序并运行它。需要互联网连接。结果是安装程序的大小较小，但不建议在Windows 7上使用。 -
{ "type": "embedBootstrapper", "silent": boolean }: 嵌入引导程序并运行它。需要互联网连接。会增加约1.8MB的安装程序大小，但在Windows 7上提供更好的支持。 -
{ "type": "offlineInstaller", "silent": boolean }: 嵌入离线安装程序并运行它。不需要互联网连接。会增加约127MB的安装程序大小。 -
{ "type": "fixedRuntime", "path": string }: 嵌入固定的Webview2版本并在运行时使用。会增加约180MB的安装程序大小。
WixConfig
使用WiX的MSI捆绑包配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
要构建的安装程序语言。请参见 https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables。 |
||
|
|
null |
自定义 .wxs 模板以供使用。 |
|
|
[] |
使用的包含 WiX 片段的 .wxs 文件路径列表。 |
|
|
[] |
要从片段中引用的 ComponentGroup 元素 ID。 |
|
|
[] |
要从片段中引用的 Component 元素 ID。 |
|
|
[] |
要从片段中引用的 FeatureGroup 元素 ID。 |
|
|
[] |
要从片段中引用的 Feature 元素 ID。 |
|
|
[] |
要从片段中引用的 Merge 元素 ID。 |
|
|
|
在应用安装后禁用 Webview2 运行时安装。 将在 v2 中移除，建议使用 [ |
|
|
null |
要在安装程序中呈现的许可证文件路径。 必须是 RTF 文件，如果提供了其他扩展名，我们会将其转换为 RTF 格式。 |
|
|
|
在 Windows 任务计划程序中创建一个提升权限的更新任务。 |
|
|
null |
用作安装用户界面横幅的位图文件路径。此位图将出现在安装程序的所有页面顶部，但不包括第一页。 所需的尺寸为 493 像素 × 58 像素。 |
|
|
null |
用作安装用户界面对话框的位图文件路径。它用于欢迎和完成对话框。所需的尺寸为 493 像素 × 312 像素。 |
WixLanguageConfig
WiX 构建目标语言的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
区域设置 ( |
NsisConfig
使用 NSIS 的安装程序捆绑包配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
要在安装程序中呈现的许可证文件路径。 |
|
|
null |
要在安装程序页面头部显示的位图文件路径。 推荐的尺寸为 150 像素 × 57 像素。 |
|
|
null |
欢迎页面和完成页面使用的位图文件路径。 推荐尺寸为 164 像素 × 314 像素。 |
|
|
null |
用作安装程序图标的图标文件路径。 |
|
安装是为所有用户还是仅为当前用户。 |
||
|
|
null |
安装程序语言列表。默认情况下使用操作系统语言。如果操作系统语言不在语言列表中，将使用第一个语言。要允许用户选择语言，请将 请参见 https://github.com/kichik/nsis/tree/9465c08046f00ccb6eda985abbdbf52c275c6c4d/Contrib/Language%20files 获取完整的语言列表。 |
|
|
|
是否在安装程序和卸载程序窗口呈现之前显示语言选择对话框。默认情况下，选择操作系统语言，如果操作系统语言不在语言数组中，则回退到 |
NSISInstallerMode
NSIS 安装程序的安装模式。
可以是以下任意一种类型：
-
"currentUser": 安装程序的默认模式。
默认将应用程序安装在不需要管理员访问权限的目录中。
安装程序元数据将保存在 HKCU 注册表路径下。
-
"perMachine": 默认将应用程序安装在
Program Files文件夹中，安装需要管理员访问权限。安装程序元数据将保存在
HKLM注册表路径下。 -
"both": 结合了两种模式，允许用户在安装时选择是为当前用户还是为所有用户安装。请注意，即使用户仅希望为当前用户安装，此模式也需要管理员访问权限。
安装程序元数据将根据用户的选择保存在
HKLM或HKCU注册表路径下。
AllowlistConfig
允许列表配置。允许列表是 Cargo 允许列表功能 的翻译。
示例
-
"app-all": true将使 hide 端点可用，无论允许列表中的hide设置为false还是true。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
使用此标志以启用所有 API 功能。 |
|
文件系统 API 允许列表。 |
||
|
窗口 API 允许列表。 |
||
|
Shell API 允许列表。 |
||
|
对话框 API 允许列表。 |
||
|
HTTP API 允许列表。 |
||
|
通知 API 允许列表。 |
||
|
全局快捷键 API 允许列表。 |
||
|
操作系统允许列表。 |
||
|
路径 API 允许列表。 |
||
|
自定义协议允许列表。 |
||
|
进程 API 允许列表。 |
||
|
剪贴板 API 允许列表。 |
||
|
应用程序 API 允许列表。 |
FsAllowlistConfig
用于文件系统API的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
[] |
文件系统 API 的访问范围。 |
|
|
|
|
使用此标志来启用所有文件系统 API 功能。 |
|
|
|
从本地文件系统读取文件。 |
|
|
|
将文件写入本地文件系统。 |
|
|
|
从本地文件系统读取目录。 |
|
|
|
从本地文件系统复制文件。 |
|
|
|
创建本地文件系统的目录。 |
|
|
|
从本地文件系统删除目录。 |
|
|
|
从本地文件系统删除文件。 |
|
|
|
从本地文件系统重命名文件。 |
|
|
|
检查本地文件系统上路径是否存在。 |
FsAllowlistScope
文件系统范围定义。它是一组限制webview API访问的全局模式列表。
每个模式可以以变量开始，该变量解析为系统基础目录。变量包括：$AUDIO, $CACHE, $CONFIG, $DATA, $LOCALDATA, $DESKTOP, $DOCUMENT, $DOWNLOAD, $EXE, $FONT, $HOME, $PICTURE, $PUBLIC, $RUNTIME, $TEMPLATE, $VIDEO, $RESOURCE, $APP, $LOG, $TEMP, $APPCONFIG, $APPDATA, $APPLOCALDATA, $APPCACHE, $APPLOG。
可以是以下任何类型：
-
string[]: 此范围允许的路径列表。 -
object: 完整的范围配置。
WindowAllowlistConfig
窗口 API 的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
启用此标志以启用所有窗口 API 功能。 |
|
|
|
允许动态窗口创建。 |
|
|
|
允许窗口居中。 |
|
|
|
允许请求窗口上用户的关注。 |
|
|
|
允许设置窗口的可调整大小标志。 |
|
|
|
允许更改窗口标题。 |
|
|
|
允许最大化窗口。 |
|
|
|
允许还原最大化的窗口。 |
|
|
|
允许最小化窗口。 |
|
|
|
允许还原最小化的窗口。 |
|
|
|
允许显示窗口。 |
|
|
|
允许隐藏窗口。 |
|
|
|
允许关闭窗口。 |
|
|
|
允许设置窗口的装饰标志。 |
|
|
|
允许设置窗口的“always_on_top”标志。 |
|
|
|
允许防止窗口内容被其他应用程序捕获。 |
|
|
|
允许设置窗口大小。 |
|
|
|
允许设置窗口的最小尺寸。 |
|
|
|
允许设置窗口的最大尺寸。 |
|
|
|
允许更改窗口的位置。 |
|
|
|
允许设置窗口的全屏标志。 |
|
|
|
允许使窗口获得焦点。 |
|
|
|
允许更改窗口图标。 |
|
|
|
允许设置窗口的“跳过任务栏”标志。 |
|
|
|
允许捕获光标。 |
|
|
|
允许设置光标的可见性。 |
|
|
|
允许更改光标图标。 |
|
|
|
允许设置光标位置。 |
|
|
|
允许忽略光标事件。 |
|
|
|
允许在窗口上开始拖动操作。 |
|
|
|
允许打开系统对话框以打印窗口内容。 |
ShellAllowlistConfig
shell API 的白名单。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
[] |
二进制执行 API 的访问范围。Sidecars 会自动启用。 |
|
|
|
|
使用此标志以启用所有 shell API 功能。 |
|
|
|
启用二进制执行。 |
|
|
|
启用 sidecar 执行，允许 JavaScript 层启动一个 sidecar 命令，这是一个与应用程序一起提供的可执行文件。有关更多信息，请参见 https://tauri.app/v1/guides/building/sidecar。 |
|
|
使用用户的默认应用程序打开 URL。 |
ShellAllowedCommand
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
此允许的 shell 命令配置的名称。 该名称将在 webview API 中用于调用此命令及任何指定的参数。 |
|
|
|
null |
命令名称。它可以以解析为系统基本目录的变量开头。变量包括： |
|
|
允许的命令执行参数。 |
|
|
|
|
如果此命令是一个 sidecar 命令。 |
ShellAllowedArgs
由 webview API 允许执行的一组命令参数。
设置为 true 时，允许传递任何参数给命令；设置为 false 时，禁用所有参数。使用 [ShellAllowedArg] 列表时，将这些参数设置为唯一有效的参数，用于传递给附加的命令配置。
可以是以下任意类型：
-
boolean：使用简单的布尔值允许或禁用所有参数传递给此命令配置。 -
ShellAllowedArg[]：特定的一组 [ShellAllowedArg]，这些参数在命令配置中是有效的。
DialogAllowlistConfig
对话框 API 的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
使用此标志以启用所有对话框 API 功能。 |
|
|
|
允许 API 打开对话窗口以选择文件。 |
|
|
|
允许 API 打开对话窗口以选择文件保存位置。 |
|
|
|
允许 API 显示消息对话窗口。 |
|
|
|
允许 API 显示带有“是”/“否”按钮的对话窗口。 |
|
|
|
允许 API 显示带有“确定”/“取消”按钮的对话窗口。 |
HttpAllowlistConfig
HTTP API 的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
[] |
HTTP API 的访问范围。 |
|
|
|
|
使用此标志以启用所有 HTTP API 功能。 |
|
|
|
允许发起 HTTP 请求。 |
HttpAllowlistScope
HTTP API 范围定义。这是一个 URL 列表，webview 在使用 HTTP API 时可以访问这些 URL。范围 URL 使用 glob 模式与请求 URL 进行匹配。
示例：
-
"https://*": 允许所有 HTTPS URL
-
"https://*.github.com/tauri-apps/tauri": 允许任何 "github.com" 的子域，并且路径为 "tauri-apps/api"
-
"https://myapi.service.com/users/*": 允许访问以 "https://myapi.service.com/users/" 开头的任何 URL
类型：string (格式: uri)
GlobalShortcutAllowlistConfig
全局快捷键 API 的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
使用此标志以启用所有全局快捷键 API 功能。 |
ProtocolAllowlistConfig
自定义协议的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
[] |
资产协议的访问范围。 |
|
|
|
|
使用此标志以启用所有自定义协议。 |
|
|
|
启用资产协议。 |
ProcessAllowlistConfig
进程 API 的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
使用此标志以启用所有进程 API。 |
|
|
|
启用重新启动 API。 |
|
|
|
危险选项，允许 macOS 在二进制文件包含符号链接的情况下重新启动。 这是由于 macOS 对符号链接的保护较少。强烈建议不要设置此标志，除非你有非常具体的理由，并且理解其影响。 |
|
|
|
启用退出 API。 |
ClipboardAllowlistConfig
剪贴板 API 的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
使用此标志以启用所有剪贴板 API。 |
|
|
|
启用剪贴板的 |
|
|
|
启用剪贴板的 |
AppAllowlistConfig
应用程序 API 的允许列表。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
使用此标志以启用所有应用程序 API。 |
|
|
|
启用应用程序的 |
|
|
|
启用应用程序的 |
SecurityConfig
安全相关配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
将注入到构建应用程序的所有 HTML 文件中的内容安全策略。如果未指定 这是配置的一个非常重要的部分，因为它帮助确保你的 WebView 是安全的。请参见 https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP。 |
|
|
Csp? |
在开发模式中注入到所有 HTML 文件中的内容安全策略。 这是配置的一个非常重要的部分，因为它帮助确保你的 WebView 是安全的。请参见 https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP。 |
|
|
|
|
在使用自定义协议时冻结 |
|
|
禁用 Tauri 注入的 CSP 源。 在编译时，Tauri 会解析所有前端资产，并将内容安全策略更改为仅允许加载你自己的脚本和样式，通过注入 nonce 和 hash 源来实现。这会严格限制你的 CSP，这可能在与其他灵活的源一起使用时引入问题。 此配置选项允许使用布尔值和字符串列表作为值。布尔值指示 Tauri 禁用所有 CSP 注入，而字符串列表则表示 Tauri 无法注入的 CSP 指令。 警告：只有在你知道自己在做什么并且已正确配置 CSP 的情况下才禁用此功能。没有这个 Tauri 保护，你的应用程序可能会受到 XSS 攻击的风险。 |
|
|
[] |
允许外部域发送命令到 Tauri。 默认情况下，外部域无法访问 此配置允许一组外部域访问 Tauri 命令。当你配置一个域允许访问 IPC 时，所有子路径都被允许。子域名是不允许的。 警告：仅在你有内部检查来防范恶意外部网站或可以信任允许的外部网站时使用此选项。否则，你的应用程序可能会受到危险的 Tauri 命令相关攻击的风险。 |
CspDirectiveSources
内容安全策略指令源列表。请参见 https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources。
可以是以下任意类型：
-
string：CSP 源的内联列表。与List相同，但用空格分隔连接。 -
string[]：CSP 源的列表。集合将用空格分隔连接以形成 CSP 字符串。
UpdaterConfig
更新程序配置对象。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
|
更新程序是否处于活动状态。 |
|
|
|
显示内置对话框或在禁用时使用事件系统。 |
|
|
null |
更新程序端点。生产环境强制使用 TLS。 更新程序 URL 可以包含以下变量： # 示例 |
|
|
null |
签名公钥。 |
|
更新程序的 Windows 配置。 |
UpdaterWindowsConfig
Windows 的更新程序配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
[] |
提供给 NSIS 或 WiX 安装程序的附加参数。 |
|
Windows 上更新的安装模式。默认为 |
SystemTrayConfig
应用程序系统托盘图标的配置。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
系统托盘上使用的默认图标的路径。 |
|
|
|
一个布尔值，决定图像是否表示 macOS 上的 模板 图像。 |
|
|
|
一个布尔值，决定在 macOS 上托盘图标接收到左键点击时是否显示菜单。 |
|
|
null |
macOS 托盘的标题。 |
BuildConfig
构建配置对象。
类型: 对象
名称 |
类型 |
默认 |
描述 |
|
|
null |
用于构建和运行应用程序的二进制文件。 |
|
应用程序资产的路径或开发时加载的 URL。 这通常是一个指向开发服务器的 URL，该服务器提供应用程序资产并支持实时重新加载。大多数现代 JavaScript 打包工具默认提供启动开发服务器的方式。 请参见 vite、 Webpack DevServer 和 sirv，以了解如何设置开发服务器的示例。 |
||
|
应用程序资产的路径或生产时加载的 URL。 当提供一个相对于配置文件的路径时，它会递归读取所有文件，并将它们嵌入到应用程序二进制文件中。除非提供自定义窗口 URL，否则 Tauri 会查找 您还可以提供一个路径列表以进行嵌入，这允许对添加到二进制文件的文件进行细粒度控制。在这种情况下，所有文件都添加到根目录中，您必须在 HTML 文件中以这种方式引用它们。 当提供 URL 时，应用程序将没有打包的资产，应用程序将默认加载该 URL。 |
||
|
在 如果执行条件编译，将会设置 TAURI_PLATFORM、TAURI_ARCH、TAURI_FAMILY、TAURI_PLATFORM_VERSION、TAURI_PLATFORM_TYPE 和 TAURI_DEBUG 环境变量。 |
||
|
在 如果执行条件编译，将会设置 TAURI_PLATFORM、TAURI_ARCH、TAURI_FAMILY、TAURI_PLATFORM_VERSION、TAURI_PLATFORM_TYPE 和 TAURI_DEBUG 环境变量。 |
||
|
在 如果执行条件编译，将会设置 TAURI_PLATFORM、TAURI_ARCH、TAURI_FAMILY、TAURI_PLATFORM_VERSION、TAURI_PLATFORM_TYPE 和 TAURI_DEBUG 环境变量。 |
||
|
|
null |
传递给 |
|
|
|
是否应该在 |