mirror of
https://github.com/tauri-apps/tauri.git
synced 2024-12-19 00:21:32 +03:00
8de308d1bf
* feat(core): implement new config structure RFC#5f3e82a6b0c/texts/0005-tauri-config-restructure.md* fixes * remove tauri-plugin copy [skip ci] * move platform specific configs * fix build * fix cli * doctests * change files * read updater plugin config on CLI * doctests * remove env var from docs * fix getting pubkey * add migrations * clippy * update change file [skip ci] * rename frontendDist to prodFrontend? * Revert "rename frontendDist to prodFrontend?" This reverts commitef7394f085. * fix all_features check * fix field name * single license getter on bundler * readd msiexec_args * remove unused fixture * update template * Update .changes/tauri-bundle-settings-rfc-5.md * Update .changes/config-restructure-rfc-5.md * lint bundler, fix change file * rename AppUrl to FrontendDist, add explicit variants for docs * fix build * lint --------- Co-authored-by: Lucas Nogueira <lucas@tauri.studio> Co-authored-by: Lucas Fernandes Nogueira <lucas@tauri.app>
2455 lines
82 KiB
JSON
2455 lines
82 KiB
JSON
{
|
||
"$schema": "http://json-schema.org/draft-07/schema#",
|
||
"title": "Config",
|
||
"description": "The Tauri configuration object. It is read from a file where you can define your frontend assets, configure the bundler and define a tray icon.\n\nThe configuration file is generated by the [`tauri init`](https://tauri.app/v1/api/cli#init) command that lives in your Tauri application source directory (src-tauri).\n\nOnce generated, you may modify it at will to customize your Tauri application.\n\n## File Formats\n\nBy default, the configuration is defined as a JSON file named `tauri.conf.json`.\n\nTauri also supports JSON5 and TOML files via the `config-json5` and `config-toml` Cargo features, respectively. The JSON5 file name must be either `tauri.conf.json` or `tauri.conf.json5`. The TOML file name is `Tauri.toml`.\n\n## Platform-Specific Configuration\n\nIn addition to the default configuration file, Tauri can read a platform-specific configuration from `tauri.linux.conf.json`, `tauri.windows.conf.json`, `tauri.macos.conf.json`, `tauri.android.conf.json` and `tauri.ios.conf.json` (or `Tauri.linux.toml`, `Tauri.windows.toml`, `Tauri.macos.toml`, `Tauri.android.toml` and `Tauri.ios.toml` if the `Tauri.toml` format is used), which gets merged with the main configuration object.\n\n## Configuration Structure\n\nThe configuration is composed of the following objects:\n\n- [`package`](#packageconfig): Package settings - [`app`](#appconfig): The Tauri config - [`build`](#buildconfig): The build configuration - [`plugins`](#pluginconfig): The plugins config\n\n```json title=\"Example tauri.config.json file\" { \"productName\": \"tauri-app\", \"version\": \"0.1.0\" \"build\": { \"beforeBuildCommand\": \"\", \"beforeDevCommand\": \"\", \"devUrl\": \"../dist\", \"frontendDist\": \"../dist\" }, \"app\": { \"security\": { \"csp\": null }, \"windows\": [ { \"fullscreen\": false, \"height\": 600, \"resizable\": true, \"title\": \"Tauri App\", \"width\": 800 } ] }, \"bundle\": {} } ```",
|
||
"type": "object",
|
||
"properties": {
|
||
"$schema": {
|
||
"description": "The JSON schema for the Tauri config.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"productName": {
|
||
"description": "App name.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
],
|
||
"pattern": "^[^/\\:*?\"<>|]+$"
|
||
},
|
||
"version": {
|
||
"description": "App version. It is a semver version number or a path to a `package.json` file containing the `version` field. If removed the version number from `Cargo.toml` is used.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"identifier": {
|
||
"description": "The application identifier in reverse domain name notation (e.g. `com.tauri.example`). This string must be unique across applications since it is used in system configurations like the bundle ID and path to the webview data directory. This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-), and periods (.).",
|
||
"default": "",
|
||
"type": "string"
|
||
},
|
||
"app": {
|
||
"description": "The App configuration.",
|
||
"default": {
|
||
"macOSPrivateApi": false,
|
||
"security": {
|
||
"assetProtocol": {
|
||
"enable": false,
|
||
"scope": []
|
||
},
|
||
"dangerousDisableAssetCspModification": false,
|
||
"freezePrototype": false,
|
||
"pattern": {
|
||
"use": "brownfield"
|
||
}
|
||
},
|
||
"windows": [],
|
||
"withGlobalTauri": false
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/AppConfig"
|
||
}
|
||
]
|
||
},
|
||
"build": {
|
||
"description": "The build configuration.",
|
||
"default": {},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/BuildConfig"
|
||
}
|
||
]
|
||
},
|
||
"bundle": {
|
||
"description": "The bundler configuration.",
|
||
"default": {
|
||
"active": false,
|
||
"android": {
|
||
"minSdkVersion": 24
|
||
},
|
||
"iOS": {},
|
||
"icon": [],
|
||
"linux": {
|
||
"appimage": {
|
||
"bundleMediaFramework": false,
|
||
"files": {}
|
||
},
|
||
"deb": {
|
||
"files": {}
|
||
},
|
||
"rpm": {
|
||
"epoch": 0,
|
||
"files": {},
|
||
"release": "1"
|
||
}
|
||
},
|
||
"macOS": {
|
||
"dmg": {
|
||
"appPosition": {
|
||
"x": 180,
|
||
"y": 170
|
||
},
|
||
"applicationFolderPosition": {
|
||
"x": 480,
|
||
"y": 170
|
||
},
|
||
"windowSize": {
|
||
"height": 400,
|
||
"width": 660
|
||
}
|
||
},
|
||
"files": {},
|
||
"minimumSystemVersion": "10.13"
|
||
},
|
||
"targets": "all",
|
||
"windows": {
|
||
"allowDowngrades": true,
|
||
"certificateThumbprint": null,
|
||
"digestAlgorithm": null,
|
||
"nsis": null,
|
||
"timestampUrl": null,
|
||
"tsp": false,
|
||
"webviewFixedRuntimePath": null,
|
||
"webviewInstallMode": {
|
||
"silent": true,
|
||
"type": "downloadBootstrapper"
|
||
},
|
||
"wix": null
|
||
}
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/BundleConfig"
|
||
}
|
||
]
|
||
},
|
||
"plugins": {
|
||
"description": "The plugins config.",
|
||
"default": {},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/PluginConfig"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false,
|
||
"definitions": {
|
||
"AppConfig": {
|
||
"description": "The App configuration object.\n\nSee more: <https://tauri.app/v1/api/config#appconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"windows": {
|
||
"description": "The windows configuration.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/WindowConfig"
|
||
}
|
||
},
|
||
"security": {
|
||
"description": "Security configuration.",
|
||
"default": {
|
||
"assetProtocol": {
|
||
"enable": false,
|
||
"scope": []
|
||
},
|
||
"dangerousDisableAssetCspModification": false,
|
||
"freezePrototype": false,
|
||
"pattern": {
|
||
"use": "brownfield"
|
||
}
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/SecurityConfig"
|
||
}
|
||
]
|
||
},
|
||
"trayIcon": {
|
||
"description": "Configuration for app tray icon.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/TrayIconConfig"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"macOSPrivateApi": {
|
||
"description": "MacOS private API configuration. Enables the transparent background API and sets the `fullScreenEnabled` preference to `true`.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"withGlobalTauri": {
|
||
"description": "Whether we should inject the Tauri API on `window.__TAURI__` or not.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"WindowConfig": {
|
||
"description": "The window configuration object.\n\nSee more: <https://tauri.app/v1/api/config#windowconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"label": {
|
||
"description": "The window identifier. It must be alphanumeric.",
|
||
"default": "main",
|
||
"type": "string"
|
||
},
|
||
"url": {
|
||
"description": "The window webview URL.",
|
||
"default": "index.html",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/WebviewUrl"
|
||
}
|
||
]
|
||
},
|
||
"userAgent": {
|
||
"description": "The user agent for the webview",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"fileDropEnabled": {
|
||
"description": "Whether the file drop is enabled or not on the webview. By default it is enabled.\n\nDisabling it is required to use drag and drop on the frontend on Windows.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"center": {
|
||
"description": "Whether or not the window starts centered or not.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"x": {
|
||
"description": "The horizontal position of the window's top left corner",
|
||
"type": [
|
||
"number",
|
||
"null"
|
||
],
|
||
"format": "double"
|
||
},
|
||
"y": {
|
||
"description": "The vertical position of the window's top left corner",
|
||
"type": [
|
||
"number",
|
||
"null"
|
||
],
|
||
"format": "double"
|
||
},
|
||
"width": {
|
||
"description": "The window width.",
|
||
"default": 800.0,
|
||
"type": "number",
|
||
"format": "double"
|
||
},
|
||
"height": {
|
||
"description": "The window height.",
|
||
"default": 600.0,
|
||
"type": "number",
|
||
"format": "double"
|
||
},
|
||
"minWidth": {
|
||
"description": "The min window width.",
|
||
"type": [
|
||
"number",
|
||
"null"
|
||
],
|
||
"format": "double"
|
||
},
|
||
"minHeight": {
|
||
"description": "The min window height.",
|
||
"type": [
|
||
"number",
|
||
"null"
|
||
],
|
||
"format": "double"
|
||
},
|
||
"maxWidth": {
|
||
"description": "The max window width.",
|
||
"type": [
|
||
"number",
|
||
"null"
|
||
],
|
||
"format": "double"
|
||
},
|
||
"maxHeight": {
|
||
"description": "The max window height.",
|
||
"type": [
|
||
"number",
|
||
"null"
|
||
],
|
||
"format": "double"
|
||
},
|
||
"resizable": {
|
||
"description": "Whether the window is resizable or not. When resizable is set to false, native window's maximize button is automatically disabled.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"maximizable": {
|
||
"description": "Whether the window's native maximize button is enabled or not. If resizable is set to false, this setting is ignored.\n\n## Platform-specific\n\n- **macOS:** Disables the \"zoom\" button in the window titlebar, which is also used to enter fullscreen mode. - **Linux / iOS / Android:** Unsupported.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"minimizable": {
|
||
"description": "Whether the window's native minimize button is enabled or not.\n\n## Platform-specific\n\n- **Linux / iOS / Android:** Unsupported.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"closable": {
|
||
"description": "Whether the window's native close button is enabled or not.\n\n## Platform-specific\n\n- **Linux:** \"GTK+ will do its best to convince the window manager not to show a close button. Depending on the system, this function may not have any effect when called on a window that is already visible\" - **iOS / Android:** Unsupported.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"title": {
|
||
"description": "The window title.",
|
||
"default": "Tauri App",
|
||
"type": "string"
|
||
},
|
||
"fullscreen": {
|
||
"description": "Whether the window starts as fullscreen or not.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"focus": {
|
||
"description": "Whether the window will be initially focused or not.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"transparent": {
|
||
"description": "Whether the window is transparent or not.\n\nNote that on `macOS` this requires the `macos-private-api` feature flag, enabled under `tauri > macOSPrivateApi`. WARNING: Using private APIs on `macOS` prevents your application from being accepted to the `App Store`.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"maximized": {
|
||
"description": "Whether the window is maximized or not.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"visible": {
|
||
"description": "Whether the window is visible or not.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"decorations": {
|
||
"description": "Whether the window should have borders and bars.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"alwaysOnBottom": {
|
||
"description": "Whether the window should always be below other windows.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"alwaysOnTop": {
|
||
"description": "Whether the window should always be on top of other windows.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"visibleOnAllWorkspaces": {
|
||
"description": "Whether the window should be visible on all workspaces or virtual desktops.\n\n## Platform-specific\n\n- **Windows / iOS / Android:** Unsupported.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"contentProtected": {
|
||
"description": "Prevents the window contents from being captured by other apps.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"skipTaskbar": {
|
||
"description": "If `true`, hides the window icon from the taskbar on Windows and Linux.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"theme": {
|
||
"description": "The initial window theme. Defaults to the system theme. Only implemented on Windows and macOS 10.14+.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/Theme"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"titleBarStyle": {
|
||
"description": "The style of the macOS title bar.",
|
||
"default": "Visible",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/TitleBarStyle"
|
||
}
|
||
]
|
||
},
|
||
"hiddenTitle": {
|
||
"description": "If `true`, sets the window title to be hidden on macOS.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"acceptFirstMouse": {
|
||
"description": "Whether clicking an inactive window also clicks through to the webview on macOS.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"tabbingIdentifier": {
|
||
"description": "Defines the window [tabbing identifier] for macOS.\n\nWindows with matching tabbing identifiers will be grouped together. If the tabbing identifier is not set, automatic tabbing will be disabled.\n\n[tabbing identifier]: <https://developer.apple.com/documentation/appkit/nswindow/1644704-tabbingidentifier>",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"additionalBrowserArgs": {
|
||
"description": "Defines additional browser arguments on Windows. By default wry passes `--disable-features=msWebOOUI,msPdfOOUI,msSmartScreenProtection` so if you use this method, you also need to disable these components by yourself if you want.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"shadow": {
|
||
"description": "Whether or not the window has shadow.\n\n## Platform-specific\n\n- **Windows:** - `false` has no effect on decorated window, shadow are always ON. - `true` will make ndecorated window have a 1px white border, and on Windows 11, it will have a rounded corners. - **Linux:** Unsupported.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"windowEffects": {
|
||
"description": "Window effects.\n\nRequires the window to be transparent.\n\n## Platform-specific:\n\n- **Windows**: If using decorations or shadows, you may want to try this workaround <https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891> - **Linux**: Unsupported",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/WindowEffectsConfig"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"incognito": {
|
||
"description": "Whether or not the webview should be launched in incognito mode.\n\n## Platform-specific:\n\n- **Android**: Unsupported.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"parent": {
|
||
"description": "Sets the window associated with this label to be the parent of the window to be created.\n\n## Platform-specific\n\n- **Windows**: This sets the passed parent as an owner window to the window to be created. From [MSDN owned windows docs](https://docs.microsoft.com/en-us/windows/win32/winmsg/window-features#owned-windows): - An owned window is always above its owner in the z-order. - The system automatically destroys an owned window when its owner is destroyed. - An owned window is hidden when its owner is minimized. - **Linux**: This makes the new window transient for parent, see <https://docs.gtk.org/gtk3/method.Window.set_transient_for.html> - **macOS**: This adds the window as a child of parent, see <https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc>",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"proxyUrl": {
|
||
"description": "The proxy URL for the WebView for all network requests.\n\nMust be either a `http://` or a `socks5://` URL.\n\n## Platform-specific\n\n- **macOS**: Requires the `macos-proxy` feature flag and only compiles for macOS 14+.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
],
|
||
"format": "uri"
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"WebviewUrl": {
|
||
"description": "An URL to open on a Tauri webview window.",
|
||
"anyOf": [
|
||
{
|
||
"description": "An external URL. Must use either the `http` or `https` schemes.",
|
||
"type": "string",
|
||
"format": "uri"
|
||
},
|
||
{
|
||
"description": "The path portion of an app URL. For instance, to load `tauri://localhost/users/john`, you can simply provide `users/john` in this configuration.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"description": "A custom protocol url, for example, `doom://index.html`",
|
||
"type": "string",
|
||
"format": "uri"
|
||
}
|
||
]
|
||
},
|
||
"Theme": {
|
||
"description": "System theme.",
|
||
"oneOf": [
|
||
{
|
||
"description": "Light theme.",
|
||
"type": "string",
|
||
"enum": [
|
||
"Light"
|
||
]
|
||
},
|
||
{
|
||
"description": "Dark theme.",
|
||
"type": "string",
|
||
"enum": [
|
||
"Dark"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"TitleBarStyle": {
|
||
"description": "How the window title bar should be displayed on macOS.",
|
||
"oneOf": [
|
||
{
|
||
"description": "A normal title bar.",
|
||
"type": "string",
|
||
"enum": [
|
||
"Visible"
|
||
]
|
||
},
|
||
{
|
||
"description": "Makes the title bar transparent, so the window background color is shown instead.\n\nUseful if you don't need to have actual HTML under the title bar. This lets you avoid the caveats of using `TitleBarStyle::Overlay`. Will be more useful when Tauri lets you set a custom window background color.",
|
||
"type": "string",
|
||
"enum": [
|
||
"Transparent"
|
||
]
|
||
},
|
||
{
|
||
"description": "Shows the title bar as a transparent overlay over the window's content.\n\nKeep in mind: - The height of the title bar is different on different OS versions, which can lead to window the controls and title not being where you don't expect. - You need to define a custom drag region to make your window draggable, however due to a limitation you can't drag the window when it's not in focus <https://github.com/tauri-apps/tauri/issues/4316>. - The color of the window title depends on the system theme.",
|
||
"type": "string",
|
||
"enum": [
|
||
"Overlay"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"WindowEffectsConfig": {
|
||
"description": "The window effects configuration object",
|
||
"type": "object",
|
||
"required": [
|
||
"effects"
|
||
],
|
||
"properties": {
|
||
"effects": {
|
||
"description": "List of Window effects to apply to the Window. Conflicting effects will apply the first one and ignore the rest.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/WindowEffect"
|
||
}
|
||
},
|
||
"state": {
|
||
"description": "Window effect state **macOS Only**",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/WindowEffectState"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"radius": {
|
||
"description": "Window effect corner radius **macOS Only**",
|
||
"type": [
|
||
"number",
|
||
"null"
|
||
],
|
||
"format": "double"
|
||
},
|
||
"color": {
|
||
"description": "Window effect color. Affects [`WindowEffect::Blur`] and [`WindowEffect::Acrylic`] only on Windows 10 v1903+. Doesn't have any effect on Windows 7 or Windows 11.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/Color"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"WindowEffect": {
|
||
"description": "Platform-specific window effects",
|
||
"oneOf": [
|
||
{
|
||
"description": "A default material appropriate for the view's effectiveAppearance. **macOS 10.14-**",
|
||
"deprecated": true,
|
||
"type": "string",
|
||
"enum": [
|
||
"appearanceBased"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14-**",
|
||
"deprecated": true,
|
||
"type": "string",
|
||
"enum": [
|
||
"light"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14-**",
|
||
"deprecated": true,
|
||
"type": "string",
|
||
"enum": [
|
||
"dark"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14-**",
|
||
"deprecated": true,
|
||
"type": "string",
|
||
"enum": [
|
||
"mediumLight"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14-**",
|
||
"deprecated": true,
|
||
"type": "string",
|
||
"enum": [
|
||
"ultraDark"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.10+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"titlebar"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.10+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"selection"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.11+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"menu"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.11+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"popover"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.11+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"sidebar"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"headerView"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"sheet"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"windowBackground"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"hudWindow"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"fullScreenUI"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"tooltip"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"contentBackground"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"underWindowBackground"
|
||
]
|
||
},
|
||
{
|
||
"description": "*macOS 10.14+**",
|
||
"type": "string",
|
||
"enum": [
|
||
"underPageBackground"
|
||
]
|
||
},
|
||
{
|
||
"description": "Mica effect that matches the system dark perefence **Windows 11 Only**",
|
||
"type": "string",
|
||
"enum": [
|
||
"mica"
|
||
]
|
||
},
|
||
{
|
||
"description": "Mica effect with dark mode but only if dark mode is enabled on the system **Windows 11 Only**",
|
||
"type": "string",
|
||
"enum": [
|
||
"micaDark"
|
||
]
|
||
},
|
||
{
|
||
"description": "Mica effect with light mode **Windows 11 Only**",
|
||
"type": "string",
|
||
"enum": [
|
||
"micaLight"
|
||
]
|
||
},
|
||
{
|
||
"description": "Tabbed effect that matches the system dark perefence **Windows 11 Only**",
|
||
"type": "string",
|
||
"enum": [
|
||
"tabbed"
|
||
]
|
||
},
|
||
{
|
||
"description": "Tabbed effect with dark mode but only if dark mode is enabled on the system **Windows 11 Only**",
|
||
"type": "string",
|
||
"enum": [
|
||
"tabbedDark"
|
||
]
|
||
},
|
||
{
|
||
"description": "Tabbed effect with light mode **Windows 11 Only**",
|
||
"type": "string",
|
||
"enum": [
|
||
"tabbedLight"
|
||
]
|
||
},
|
||
{
|
||
"description": "**Windows 7/10/11(22H1) Only**\n\n## Notes\n\nThis effect has bad performance when resizing/dragging the window on Windows 11 build 22621.",
|
||
"type": "string",
|
||
"enum": [
|
||
"blur"
|
||
]
|
||
},
|
||
{
|
||
"description": "**Windows 10/11 Only**\n\n## Notes\n\nThis effect has bad performance when resizing/dragging the window on Windows 10 v1903+ and Windows 11 build 22000.",
|
||
"type": "string",
|
||
"enum": [
|
||
"acrylic"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"WindowEffectState": {
|
||
"description": "Window effect state **macOS only**\n\n<https://developer.apple.com/documentation/appkit/nsvisualeffectview/state>",
|
||
"oneOf": [
|
||
{
|
||
"description": "Make window effect state follow the window's active state",
|
||
"type": "string",
|
||
"enum": [
|
||
"followsWindowActiveState"
|
||
]
|
||
},
|
||
{
|
||
"description": "Make window effect state always active",
|
||
"type": "string",
|
||
"enum": [
|
||
"active"
|
||
]
|
||
},
|
||
{
|
||
"description": "Make window effect state always inactive",
|
||
"type": "string",
|
||
"enum": [
|
||
"inactive"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"Color": {
|
||
"description": "a tuple struct of RGBA colors. Each value has minimum of 0 and maximum of 255.",
|
||
"type": "array",
|
||
"items": [
|
||
{
|
||
"type": "integer",
|
||
"format": "uint8",
|
||
"minimum": 0.0
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"format": "uint8",
|
||
"minimum": 0.0
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"format": "uint8",
|
||
"minimum": 0.0
|
||
},
|
||
{
|
||
"type": "integer",
|
||
"format": "uint8",
|
||
"minimum": 0.0
|
||
}
|
||
],
|
||
"maxItems": 4,
|
||
"minItems": 4
|
||
},
|
||
"SecurityConfig": {
|
||
"description": "Security configuration.\n\nSee more: <https://tauri.app/v1/api/config#securityconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"csp": {
|
||
"description": "The Content Security Policy that will be injected on all HTML files on the built application. If [`dev_csp`](#SecurityConfig.devCsp) is not specified, this value is also injected on dev.\n\nThis is a really important part of the configuration since it helps you ensure your WebView is secured. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/Csp"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"devCsp": {
|
||
"description": "The Content Security Policy that will be injected on all HTML files on development.\n\nThis is a really important part of the configuration since it helps you ensure your WebView is secured. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/Csp"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"freezePrototype": {
|
||
"description": "Freeze the `Object.prototype` when using the custom protocol.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"dangerousDisableAssetCspModification": {
|
||
"description": "Disables the Tauri-injected CSP sources.\n\nAt compile time, Tauri parses all the frontend assets and changes the Content-Security-Policy to only allow loading of your own scripts and styles by injecting nonce and hash sources. This stricts your CSP, which may introduce issues when using along with other flexing sources.\n\nThis configuration option allows both a boolean and a list of strings as value. A boolean instructs Tauri to disable the injection for all CSP injections, and a list of strings indicates the CSP directives that Tauri cannot inject.\n\n**WARNING:** Only disable this if you know what you are doing and have properly configured the CSP. Your application might be vulnerable to XSS attacks without this Tauri protection.",
|
||
"default": false,
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/DisabledCspModificationKind"
|
||
}
|
||
]
|
||
},
|
||
"assetProtocol": {
|
||
"description": "Custom protocol config.",
|
||
"default": {
|
||
"enable": false,
|
||
"scope": []
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/AssetProtocolConfig"
|
||
}
|
||
]
|
||
},
|
||
"pattern": {
|
||
"description": "The pattern to use.",
|
||
"default": {
|
||
"use": "brownfield"
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/PatternKind"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"Csp": {
|
||
"description": "A Content-Security-Policy definition. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.",
|
||
"anyOf": [
|
||
{
|
||
"description": "The entire CSP policy in a single text string.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"description": "An object mapping a directive with its sources values as a list of strings.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/CspDirectiveSources"
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"CspDirectiveSources": {
|
||
"description": "A Content-Security-Policy directive source list. See <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources>.",
|
||
"anyOf": [
|
||
{
|
||
"description": "An inline list of CSP sources. Same as [`Self::List`], but concatenated with a space separator.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"description": "A list of CSP sources. The collection will be concatenated with a space separator for the CSP string.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"DisabledCspModificationKind": {
|
||
"description": "The possible values for the `dangerous_disable_asset_csp_modification` config option.",
|
||
"anyOf": [
|
||
{
|
||
"description": "If `true`, disables all CSP modification. `false` is the default value and it configures Tauri to control the CSP.",
|
||
"type": "boolean"
|
||
},
|
||
{
|
||
"description": "Disables the given list of CSP directives modifications.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"AssetProtocolConfig": {
|
||
"description": "Config for the asset custom protocol.\n\nSee more: <https://tauri.app/v1/api/config#assetprotocolconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"scope": {
|
||
"description": "The access scope for the asset protocol.",
|
||
"default": [],
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/FsScope"
|
||
}
|
||
]
|
||
},
|
||
"enable": {
|
||
"description": "Enables the asset protocol.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"FsScope": {
|
||
"description": "Protocol scope definition. It is a list of glob patterns that restrict the API access from the webview.\n\nEach pattern can start with a variable that resolves to a system base directory. The variables are: `$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`.",
|
||
"anyOf": [
|
||
{
|
||
"description": "A list of paths that are allowed by this scope.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"description": "A complete scope configuration.",
|
||
"type": "object",
|
||
"properties": {
|
||
"allow": {
|
||
"description": "A list of paths that are allowed by this scope.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"deny": {
|
||
"description": "A list of paths that are not allowed by this scope. This gets precedence over the [`Self::Scope::allow`] list.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"requireLiteralLeadingDot": {
|
||
"description": "Whether or not paths that contain components that start with a `.` will require that `.` appears literally in the pattern; `*`, `?`, `**`, or `[...]` will not match. This is useful because such files are conventionally considered hidden on Unix systems and it might be desirable to skip them when listing files.\n\nDefaults to `true` on Unix systems and `false` on Windows",
|
||
"type": [
|
||
"boolean",
|
||
"null"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"PatternKind": {
|
||
"description": "The application pattern.",
|
||
"oneOf": [
|
||
{
|
||
"description": "Brownfield pattern.",
|
||
"type": "object",
|
||
"required": [
|
||
"use"
|
||
],
|
||
"properties": {
|
||
"use": {
|
||
"type": "string",
|
||
"enum": [
|
||
"brownfield"
|
||
]
|
||
}
|
||
}
|
||
},
|
||
{
|
||
"description": "Isolation pattern. Recommended for security purposes.",
|
||
"type": "object",
|
||
"required": [
|
||
"options",
|
||
"use"
|
||
],
|
||
"properties": {
|
||
"use": {
|
||
"type": "string",
|
||
"enum": [
|
||
"isolation"
|
||
]
|
||
},
|
||
"options": {
|
||
"type": "object",
|
||
"required": [
|
||
"dir"
|
||
],
|
||
"properties": {
|
||
"dir": {
|
||
"description": "The dir containing the index.html file that contains the secure isolation application.",
|
||
"type": "string"
|
||
}
|
||
}
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"TrayIconConfig": {
|
||
"description": "Configuration for application tray icon.\n\nSee more: <https://tauri.app/v1/api/config#trayiconconfig>",
|
||
"type": "object",
|
||
"required": [
|
||
"iconPath"
|
||
],
|
||
"properties": {
|
||
"id": {
|
||
"description": "Set an id for this tray icon so you can reference it later, defaults to `main`.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"iconPath": {
|
||
"description": "Path to the default icon to use for the tray icon.",
|
||
"type": "string"
|
||
},
|
||
"iconAsTemplate": {
|
||
"description": "A Boolean value that determines whether the image represents a [template](https://developer.apple.com/documentation/appkit/nsimage/1520017-template?language=objc) image on macOS.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"menuOnLeftClick": {
|
||
"description": "A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"title": {
|
||
"description": "Title for MacOS tray",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"tooltip": {
|
||
"description": "Tray icon tooltip on Windows and macOS",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"BuildConfig": {
|
||
"description": "The Build configuration object.\n\nSee more: <https://tauri.app/v1/api/config#buildconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"runner": {
|
||
"description": "The binary used to build and run the application.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"devUrl": {
|
||
"description": "The URL to load in development.\n\nThis is usually an URL to a dev server, which serves your application assets with hot-reload and HMR. Most modern JavaScript bundlers like [vite](https://vitejs.dev/guide/) provides a way to start a dev server by default.\n\nIf you don't have a dev server or don't want to use one, ignore this option and use [`frontendDist`](BuildConfig::frontend_dist) and point to a web assets directory, and Tauri CLI will run its built-in dev server and provide a simple hot-reload experience.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
],
|
||
"format": "uri"
|
||
},
|
||
"frontendDist": {
|
||
"description": "The path to the application assets (usually the `dist` folder of your javascript bundler) or a URL that could be either a custom protocol registered in the tauri app (for example: `myprotocol://`) or a remote URL (for example: `https://site.com/app`).\n\nWhen a path relative to the configuration file is provided, it is read recursively and all files are embedded in the application binary. Tauri then looks for an `index.html` and serves it as the default entry point for your application.\n\nYou can also provide a list of paths to be embedded, which allows granular control over what files are added to the binary. In this case, all files are added to the root and you must reference it that way in your HTML files.\n\nWhen a URL is provided, the application won't have bundled assets and the application will load that URL by default.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/FrontendDist"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"beforeDevCommand": {
|
||
"description": "A shell command to run before `tauri dev` kicks in.\n\nThe TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/BeforeDevCommand"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"beforeBuildCommand": {
|
||
"description": "A shell command to run before `tauri build` kicks in.\n\nThe TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/HookCommand"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"beforeBundleCommand": {
|
||
"description": "A shell command to run before the bundling phase in `tauri build` kicks in.\n\nThe TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/HookCommand"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"features": {
|
||
"description": "Features passed to `cargo` commands.",
|
||
"type": [
|
||
"array",
|
||
"null"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"FrontendDist": {
|
||
"description": "Defines the URL or assets to embed in the application.",
|
||
"anyOf": [
|
||
{
|
||
"description": "An external URL that should be used as the default application URL.",
|
||
"type": "string",
|
||
"format": "uri"
|
||
},
|
||
{
|
||
"description": "Path to a directory containing the frontend dist assets.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"description": "An array of files to embed on the app.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"BeforeDevCommand": {
|
||
"description": "Describes the shell command to run before `tauri dev`.",
|
||
"anyOf": [
|
||
{
|
||
"description": "Run the given script with the default options.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"description": "Run the given script with custom options.",
|
||
"type": "object",
|
||
"required": [
|
||
"script"
|
||
],
|
||
"properties": {
|
||
"script": {
|
||
"description": "The script to execute.",
|
||
"type": "string"
|
||
},
|
||
"cwd": {
|
||
"description": "The current working directory.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"wait": {
|
||
"description": "Whether `tauri dev` should wait for the command to finish or not. Defaults to `false`.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"HookCommand": {
|
||
"description": "Describes a shell command to be executed when a CLI hook is triggered.",
|
||
"anyOf": [
|
||
{
|
||
"description": "Run the given script with the default options.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"description": "Run the given script with custom options.",
|
||
"type": "object",
|
||
"required": [
|
||
"script"
|
||
],
|
||
"properties": {
|
||
"script": {
|
||
"description": "The script to execute.",
|
||
"type": "string"
|
||
},
|
||
"cwd": {
|
||
"description": "The current working directory.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"BundleConfig": {
|
||
"description": "Configuration for tauri-bundler.\n\nSee more: <https://tauri.app/v1/api/config#bundleconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"active": {
|
||
"description": "Whether Tauri should bundle your application or just output the executable.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"targets": {
|
||
"description": "The bundle targets, currently supports [\"deb\", \"rpm\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\", \"updater\"] or \"all\".",
|
||
"default": "all",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/BundleTarget"
|
||
}
|
||
]
|
||
},
|
||
"publisher": {
|
||
"description": "The application's publisher. Defaults to the second element in the identifier string. Currently maps to the Manufacturer property of the Windows Installer.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"icon": {
|
||
"description": "The app's icons",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"resources": {
|
||
"description": "App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/BundleResources"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"copyright": {
|
||
"description": "A copyright string associated with your application.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"license": {
|
||
"description": "The package's license identifier to be included in the appropriate bundles. If not set, defaults to the license from the Cargo.toml file.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"licenseFile": {
|
||
"description": "The path to the license file to be included in the appropriate bundles.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"category": {
|
||
"description": "The application kind.\n\nShould be one of the following: Business, DeveloperTool, Education, Entertainment, Finance, Game, ActionGame, AdventureGame, ArcadeGame, BoardGame, CardGame, CasinoGame, DiceGame, EducationalGame, FamilyGame, KidsGame, MusicGame, PuzzleGame, RacingGame, RolePlayingGame, SimulationGame, SportsGame, StrategyGame, TriviaGame, WordGame, GraphicsAndDesign, HealthcareAndFitness, Lifestyle, Medical, Music, News, Photography, Productivity, Reference, SocialNetworking, Sports, Travel, Utility, Video, Weather.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"fileAssociations": {
|
||
"description": "File associations to application.",
|
||
"type": [
|
||
"array",
|
||
"null"
|
||
],
|
||
"items": {
|
||
"$ref": "#/definitions/FileAssociation"
|
||
}
|
||
},
|
||
"shortDescription": {
|
||
"description": "A short description of your application.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"longDescription": {
|
||
"description": "A longer, multi-line description of the application.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"externalBin": {
|
||
"description": "A list of—either absolute or relative—paths to binaries to embed with your application.\n\nNote that Tauri will look for system-specific binaries following the pattern \"binary-name{-target-triple}{.system-extension}\".\n\nE.g. for the external binary \"my-binary\", Tauri looks for:\n\n- \"my-binary-x86_64-pc-windows-msvc.exe\" for Windows - \"my-binary-x86_64-apple-darwin\" for macOS - \"my-binary-x86_64-unknown-linux-gnu\" for Linux\n\nso don't forget to provide binaries for all targeted platforms.",
|
||
"type": [
|
||
"array",
|
||
"null"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"windows": {
|
||
"description": "Configuration for the Windows bundles.",
|
||
"default": {
|
||
"allowDowngrades": true,
|
||
"certificateThumbprint": null,
|
||
"digestAlgorithm": null,
|
||
"nsis": null,
|
||
"timestampUrl": null,
|
||
"tsp": false,
|
||
"webviewFixedRuntimePath": null,
|
||
"webviewInstallMode": {
|
||
"silent": true,
|
||
"type": "downloadBootstrapper"
|
||
},
|
||
"wix": null
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/WindowsConfig"
|
||
}
|
||
]
|
||
},
|
||
"linux": {
|
||
"description": "Configuration for the Linux bundles.",
|
||
"default": {
|
||
"appimage": {
|
||
"bundleMediaFramework": false,
|
||
"files": {}
|
||
},
|
||
"deb": {
|
||
"files": {}
|
||
},
|
||
"rpm": {
|
||
"epoch": 0,
|
||
"files": {},
|
||
"release": "1"
|
||
}
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/LinuxConfig"
|
||
}
|
||
]
|
||
},
|
||
"macOS": {
|
||
"description": "Configuration for the macOS bundles.",
|
||
"default": {
|
||
"dmg": {
|
||
"appPosition": {
|
||
"x": 180,
|
||
"y": 170
|
||
},
|
||
"applicationFolderPosition": {
|
||
"x": 480,
|
||
"y": 170
|
||
},
|
||
"windowSize": {
|
||
"height": 400,
|
||
"width": 660
|
||
}
|
||
},
|
||
"files": {},
|
||
"minimumSystemVersion": "10.13"
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/MacConfig"
|
||
}
|
||
]
|
||
},
|
||
"iOS": {
|
||
"description": "iOS configuration.",
|
||
"default": {},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/IosConfig"
|
||
}
|
||
]
|
||
},
|
||
"android": {
|
||
"description": "Android configuration.",
|
||
"default": {
|
||
"minSdkVersion": 24
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/AndroidConfig"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"BundleTarget": {
|
||
"description": "Targets to bundle. Each value is case insensitive.",
|
||
"anyOf": [
|
||
{
|
||
"description": "Bundle all targets.",
|
||
"enum": [
|
||
"all"
|
||
]
|
||
},
|
||
{
|
||
"description": "A list of bundle targets.",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/BundleType"
|
||
}
|
||
},
|
||
{
|
||
"description": "A single bundle target.",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/BundleType"
|
||
}
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"BundleType": {
|
||
"description": "A bundle referenced by tauri-bundler.",
|
||
"oneOf": [
|
||
{
|
||
"description": "The debian bundle (.deb).",
|
||
"type": "string",
|
||
"enum": [
|
||
"deb"
|
||
]
|
||
},
|
||
{
|
||
"description": "The RPM bundle (.rpm).",
|
||
"type": "string",
|
||
"enum": [
|
||
"rpm"
|
||
]
|
||
},
|
||
{
|
||
"description": "The AppImage bundle (.appimage).",
|
||
"type": "string",
|
||
"enum": [
|
||
"appimage"
|
||
]
|
||
},
|
||
{
|
||
"description": "The Microsoft Installer bundle (.msi).",
|
||
"type": "string",
|
||
"enum": [
|
||
"msi"
|
||
]
|
||
},
|
||
{
|
||
"description": "The NSIS bundle (.exe).",
|
||
"type": "string",
|
||
"enum": [
|
||
"nsis"
|
||
]
|
||
},
|
||
{
|
||
"description": "The macOS application bundle (.app).",
|
||
"type": "string",
|
||
"enum": [
|
||
"app"
|
||
]
|
||
},
|
||
{
|
||
"description": "The Apple Disk Image bundle (.dmg).",
|
||
"type": "string",
|
||
"enum": [
|
||
"dmg"
|
||
]
|
||
},
|
||
{
|
||
"description": "The Tauri updater bundle.",
|
||
"type": "string",
|
||
"enum": [
|
||
"updater"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"BundleResources": {
|
||
"description": "Definition for bundle resources. Can be either a list of paths to include or a map of source to target paths.",
|
||
"anyOf": [
|
||
{
|
||
"description": "A list of paths to include.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"description": "A map of source to target paths.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"FileAssociation": {
|
||
"description": "File association",
|
||
"type": "object",
|
||
"required": [
|
||
"ext"
|
||
],
|
||
"properties": {
|
||
"ext": {
|
||
"description": "File extensions to associate with this app. e.g. 'png'",
|
||
"type": "array",
|
||
"items": {
|
||
"$ref": "#/definitions/AssociationExt"
|
||
}
|
||
},
|
||
"name": {
|
||
"description": "The name. Maps to `CFBundleTypeName` on macOS. Default to `ext[0]`",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"description": {
|
||
"description": "The association description. Windows-only. It is displayed on the `Type` column on Windows Explorer.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"role": {
|
||
"description": "The app's role with respect to the type. Maps to `CFBundleTypeRole` on macOS.",
|
||
"default": "Editor",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/BundleTypeRole"
|
||
}
|
||
]
|
||
},
|
||
"mimeType": {
|
||
"description": "The mime-type e.g. 'image/png' or 'text/plain'. Linux-only.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"AssociationExt": {
|
||
"description": "An extension for a [`FileAssociation`].\n\nA leading `.` is automatically stripped.",
|
||
"type": "string"
|
||
},
|
||
"BundleTypeRole": {
|
||
"description": "macOS-only. Corresponds to CFBundleTypeRole",
|
||
"oneOf": [
|
||
{
|
||
"description": "CFBundleTypeRole.Editor. Files can be read and edited.",
|
||
"type": "string",
|
||
"enum": [
|
||
"Editor"
|
||
]
|
||
},
|
||
{
|
||
"description": "CFBundleTypeRole.Viewer. Files can be read.",
|
||
"type": "string",
|
||
"enum": [
|
||
"Viewer"
|
||
]
|
||
},
|
||
{
|
||
"description": "CFBundleTypeRole.Shell",
|
||
"type": "string",
|
||
"enum": [
|
||
"Shell"
|
||
]
|
||
},
|
||
{
|
||
"description": "CFBundleTypeRole.QLGenerator",
|
||
"type": "string",
|
||
"enum": [
|
||
"QLGenerator"
|
||
]
|
||
},
|
||
{
|
||
"description": "CFBundleTypeRole.None",
|
||
"type": "string",
|
||
"enum": [
|
||
"None"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"WindowsConfig": {
|
||
"description": "Windows bundler configuration.\n\nSee more: <https://tauri.app/v1/api/config#windowsconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"digestAlgorithm": {
|
||
"description": "Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"certificateThumbprint": {
|
||
"description": "Specifies the SHA1 hash of the signing certificate.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"timestampUrl": {
|
||
"description": "Server to use during timestamping.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"tsp": {
|
||
"description": "Whether to use Time-Stamp Protocol (TSP, a.k.a. RFC 3161) for the timestamp server. Your code signing provider may use a TSP timestamp server, like e.g. SSL.com does. If so, enable TSP by setting to true.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"webviewInstallMode": {
|
||
"description": "The installation mode for the Webview2 runtime.",
|
||
"default": {
|
||
"silent": true,
|
||
"type": "downloadBootstrapper"
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/WebviewInstallMode"
|
||
}
|
||
]
|
||
},
|
||
"webviewFixedRuntimePath": {
|
||
"description": "Path to the webview fixed runtime to use. Overwrites [`Self::webview_install_mode`] if set.\n\nWill be removed in v2, prefer the [`Self::webview_install_mode`] option.\n\nThe fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). The `.cab` file must be extracted to a folder and this folder path must be defined on this field.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"allowDowngrades": {
|
||
"description": "Validates a second app installation, blocking the user from installing an older version if set to `false`.\n\nFor instance, if `1.2.1` is installed, the user won't be able to install app version `1.2.0` or `1.1.5`.\n\nThe default value of this flag is `true`.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
},
|
||
"wix": {
|
||
"description": "Configuration for the MSI generated with WiX.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/WixConfig"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"nsis": {
|
||
"description": "Configuration for the installer generated with NSIS.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/NsisConfig"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"WebviewInstallMode": {
|
||
"description": "Install modes for the Webview2 runtime. Note that for the updater bundle [`Self::DownloadBootstrapper`] is used.\n\nFor more information see <https://tauri.app/v1/guides/building/windows>.",
|
||
"oneOf": [
|
||
{
|
||
"description": "Do not install the Webview2 as part of the Windows Installer.",
|
||
"type": "object",
|
||
"required": [
|
||
"type"
|
||
],
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"enum": [
|
||
"skip"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
{
|
||
"description": "Download the bootstrapper and run it. Requires an internet connection. Results in a smaller installer size, but is not recommended on Windows 7.",
|
||
"type": "object",
|
||
"required": [
|
||
"type"
|
||
],
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"enum": [
|
||
"downloadBootstrapper"
|
||
]
|
||
},
|
||
"silent": {
|
||
"description": "Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
{
|
||
"description": "Embed the bootstrapper and run it. Requires an internet connection. Increases the installer size by around 1.8MB, but offers better support on Windows 7.",
|
||
"type": "object",
|
||
"required": [
|
||
"type"
|
||
],
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"enum": [
|
||
"embedBootstrapper"
|
||
]
|
||
},
|
||
"silent": {
|
||
"description": "Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
{
|
||
"description": "Embed the offline installer and run it. Does not require an internet connection. Increases the installer size by around 127MB.",
|
||
"type": "object",
|
||
"required": [
|
||
"type"
|
||
],
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"enum": [
|
||
"offlineInstaller"
|
||
]
|
||
},
|
||
"silent": {
|
||
"description": "Instructs the installer to run the installer in silent mode. Defaults to `true`.",
|
||
"default": true,
|
||
"type": "boolean"
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
{
|
||
"description": "Embed a fixed webview2 version and use it at runtime. Increases the installer size by around 180MB.",
|
||
"type": "object",
|
||
"required": [
|
||
"path",
|
||
"type"
|
||
],
|
||
"properties": {
|
||
"type": {
|
||
"type": "string",
|
||
"enum": [
|
||
"fixedRuntime"
|
||
]
|
||
},
|
||
"path": {
|
||
"description": "The path to the fixed runtime to use.\n\nThe fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section). The `.cab` file must be extracted to a folder and this folder path must be defined on this field.",
|
||
"type": "string"
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
}
|
||
]
|
||
},
|
||
"WixConfig": {
|
||
"description": "Configuration for the MSI bundle using WiX.\n\nSee more: <https://tauri.app/v1/api/config#wixconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"language": {
|
||
"description": "The installer languages to build. See <https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables>.",
|
||
"default": "en-US",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/WixLanguage"
|
||
}
|
||
]
|
||
},
|
||
"template": {
|
||
"description": "A custom .wxs template to use.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"fragmentPaths": {
|
||
"description": "A list of paths to .wxs files with WiX fragments to use.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"componentGroupRefs": {
|
||
"description": "The ComponentGroup element ids you want to reference from the fragments.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"componentRefs": {
|
||
"description": "The Component element ids you want to reference from the fragments.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"featureGroupRefs": {
|
||
"description": "The FeatureGroup element ids you want to reference from the fragments.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"featureRefs": {
|
||
"description": "The Feature element ids you want to reference from the fragments.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"mergeRefs": {
|
||
"description": "The Merge element ids you want to reference from the fragments.",
|
||
"default": [],
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"skipWebviewInstall": {
|
||
"description": "Disables the Webview2 runtime installation after app install.\n\nWill be removed in v2, prefer the [`WindowsConfig::webview_install_mode`] option.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"enableElevatedUpdateTask": {
|
||
"description": "Create an elevated update task within Windows Task Scheduler.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"bannerPath": {
|
||
"description": "Path to a bitmap file to use as the installation user interface banner. This bitmap will appear at the top of all but the first page of the installer.\n\nThe required dimensions are 493px × 58px.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"dialogImagePath": {
|
||
"description": "Path to a bitmap file to use on the installation user interface dialogs. It is used on the welcome and completion dialogs. The required dimensions are 493px × 312px.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"WixLanguage": {
|
||
"description": "The languages to build using WiX.",
|
||
"anyOf": [
|
||
{
|
||
"description": "A single language to build, without configuration.",
|
||
"type": "string"
|
||
},
|
||
{
|
||
"description": "A list of languages to build, without configuration.",
|
||
"type": "array",
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
{
|
||
"description": "A map of languages and its configuration.",
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"$ref": "#/definitions/WixLanguageConfig"
|
||
}
|
||
}
|
||
]
|
||
},
|
||
"WixLanguageConfig": {
|
||
"description": "Configuration for a target language for the WiX build.\n\nSee more: <https://tauri.app/v1/api/config#wixlanguageconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"localePath": {
|
||
"description": "The path to a locale (`.wxl`) file. See <https://wixtoolset.org/documentation/manual/v3/howtos/ui_and_localization/build_a_localized_version.html>.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"NsisConfig": {
|
||
"description": "Configuration for the Installer bundle using NSIS.",
|
||
"type": "object",
|
||
"properties": {
|
||
"template": {
|
||
"description": "A custom .nsi template to use.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"headerImage": {
|
||
"description": "The path to a bitmap file to display on the header of installers pages.\n\nThe recommended dimensions are 150px x 57px.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"sidebarImage": {
|
||
"description": "The path to a bitmap file for the Welcome page and the Finish page.\n\nThe recommended dimensions are 164px x 314px.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"installerIcon": {
|
||
"description": "The path to an icon file used as the installer icon.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"installMode": {
|
||
"description": "Whether the installation will be for all users or just the current user.",
|
||
"default": "currentUser",
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/NSISInstallerMode"
|
||
}
|
||
]
|
||
},
|
||
"languages": {
|
||
"description": "A list of installer languages. By default the OS language is used. If the OS language is not in the list of languages, the first language will be used. To allow the user to select the language, set `display_language_selector` to `true`.\n\nSee <https://github.com/kichik/nsis/tree/9465c08046f00ccb6eda985abbdbf52c275c6c4d/Contrib/Language%20files> for the complete list of languages.",
|
||
"type": [
|
||
"array",
|
||
"null"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"customLanguageFiles": {
|
||
"description": "A key-value pair where the key is the language and the value is the path to a custom `.nsh` file that holds the translated text for tauri's custom messages.\n\nSee <https://github.com/tauri-apps/tauri/blob/dev/tooling/bundler/src/bundle/windows/templates/nsis-languages/English.nsh> for an example `.nsh` file.\n\n**Note**: the key must be a valid NSIS language and it must be added to [`NsisConfig`] languages array,",
|
||
"type": [
|
||
"object",
|
||
"null"
|
||
],
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"displayLanguageSelector": {
|
||
"description": "Whether to display a language selector dialog before the installer and uninstaller windows are rendered or not. By default the OS language is selected, with a fallback to the first language in the `languages` array.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"compression": {
|
||
"description": "Set the compression algorithm used to compress files in the installer.\n\nSee <https://nsis.sourceforge.io/Reference/SetCompressor>",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/NsisCompression"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"NSISInstallerMode": {
|
||
"description": "Install Modes for the NSIS installer.",
|
||
"oneOf": [
|
||
{
|
||
"description": "Default mode for the installer.\n\nInstall the app by default in a directory that doesn't require Administrator access.\n\nInstaller metadata will be saved under the `HKCU` registry path.",
|
||
"type": "string",
|
||
"enum": [
|
||
"currentUser"
|
||
]
|
||
},
|
||
{
|
||
"description": "Install the app by default in the `Program Files` folder directory requires Administrator access for the installation.\n\nInstaller metadata will be saved under the `HKLM` registry path.",
|
||
"type": "string",
|
||
"enum": [
|
||
"perMachine"
|
||
]
|
||
},
|
||
{
|
||
"description": "Combines both modes and allows the user to choose at install time whether to install for the current user or per machine. Note that this mode will require Administrator access even if the user wants to install it for the current user only.\n\nInstaller metadata will be saved under the `HKLM` or `HKCU` registry path based on the user's choice.",
|
||
"type": "string",
|
||
"enum": [
|
||
"both"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"NsisCompression": {
|
||
"description": "Compression algorithms used in the NSIS installer.\n\nSee <https://nsis.sourceforge.io/Reference/SetCompressor>",
|
||
"oneOf": [
|
||
{
|
||
"description": "ZLIB uses the deflate algorithm, it is a quick and simple method. With the default compression level it uses about 300 KB of memory.",
|
||
"type": "string",
|
||
"enum": [
|
||
"zlib"
|
||
]
|
||
},
|
||
{
|
||
"description": "BZIP2 usually gives better compression ratios than ZLIB, but it is a bit slower and uses more memory. With the default compression level it uses about 4 MB of memory.",
|
||
"type": "string",
|
||
"enum": [
|
||
"bzip2"
|
||
]
|
||
},
|
||
{
|
||
"description": "LZMA (default) is a new compression method that gives very good compression ratios. The decompression speed is high (10-20 MB/s on a 2 GHz CPU), the compression speed is lower. The memory size that will be used for decompression is the dictionary size plus a few KBs, the default is 8 MB.",
|
||
"type": "string",
|
||
"enum": [
|
||
"lzma"
|
||
]
|
||
}
|
||
]
|
||
},
|
||
"LinuxConfig": {
|
||
"description": "Configuration for Linux bundles.\n\nSee more: <https://tauri.app/v1/api/config#linuxconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"appimage": {
|
||
"description": "Configuration for the AppImage bundle.",
|
||
"default": {
|
||
"bundleMediaFramework": false,
|
||
"files": {}
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/AppImageConfig"
|
||
}
|
||
]
|
||
},
|
||
"deb": {
|
||
"description": "Configuration for the Debian bundle.",
|
||
"default": {
|
||
"files": {}
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/DebConfig"
|
||
}
|
||
]
|
||
},
|
||
"rpm": {
|
||
"description": "Configuration for the RPM bundle.",
|
||
"default": {
|
||
"epoch": 0,
|
||
"files": {},
|
||
"release": "1"
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/RpmConfig"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"AppImageConfig": {
|
||
"description": "Configuration for AppImage bundles.\n\nSee more: <https://tauri.app/v1/api/config#appimageconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"bundleMediaFramework": {
|
||
"description": "Include additional gstreamer dependencies needed for audio and video playback. This increases the bundle size by ~15-35MB depending on your build system.",
|
||
"default": false,
|
||
"type": "boolean"
|
||
},
|
||
"files": {
|
||
"description": "The files to include in the Appimage Binary.",
|
||
"default": {},
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"DebConfig": {
|
||
"description": "Configuration for Debian (.deb) bundles.\n\nSee more: <https://tauri.app/v1/api/config#debconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"depends": {
|
||
"description": "The list of deb dependencies your application relies on.",
|
||
"type": [
|
||
"array",
|
||
"null"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"files": {
|
||
"description": "The files to include on the package.",
|
||
"default": {},
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"desktopTemplate": {
|
||
"description": "Path to a custom desktop file Handlebars template.\n\nAvailable variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"RpmConfig": {
|
||
"description": "Configuration for RPM bundles.",
|
||
"type": "object",
|
||
"properties": {
|
||
"depends": {
|
||
"description": "The list of RPM dependencies your application relies on.",
|
||
"type": [
|
||
"array",
|
||
"null"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"release": {
|
||
"description": "The RPM release tag.",
|
||
"default": "1",
|
||
"type": "string"
|
||
},
|
||
"epoch": {
|
||
"description": "The RPM epoch.",
|
||
"default": 0,
|
||
"type": "integer",
|
||
"format": "uint32",
|
||
"minimum": 0.0
|
||
},
|
||
"files": {
|
||
"description": "The files to include on the package.",
|
||
"default": {},
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"desktopTemplate": {
|
||
"description": "Path to a custom desktop file Handlebars template.\n\nAvailable variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"MacConfig": {
|
||
"description": "Configuration for the macOS bundles.\n\nSee more: <https://tauri.app/v1/api/config#macconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"frameworks": {
|
||
"description": "A list of strings indicating any macOS X frameworks that need to be bundled with the application.\n\nIf a name is used, \".framework\" must be omitted and it will look for standard install locations. You may also use a path to a specific framework.",
|
||
"type": [
|
||
"array",
|
||
"null"
|
||
],
|
||
"items": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"files": {
|
||
"description": "The files to include in the application relative to the Contents directory.",
|
||
"default": {},
|
||
"type": "object",
|
||
"additionalProperties": {
|
||
"type": "string"
|
||
}
|
||
},
|
||
"minimumSystemVersion": {
|
||
"description": "A version string indicating the minimum macOS X version that the bundled application supports. Defaults to `10.13`.\n\nSetting it to `null` completely removes the `LSMinimumSystemVersion` field on the bundle's `Info.plist` and the `MACOSX_DEPLOYMENT_TARGET` environment variable.\n\nAn empty string is considered an invalid value so the default value is used.",
|
||
"default": "10.13",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"exceptionDomain": {
|
||
"description": "Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"signingIdentity": {
|
||
"description": "Identity to use for code signing.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"providerShortName": {
|
||
"description": "Provider short name for notarization.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"entitlements": {
|
||
"description": "Path to the entitlements file.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"dmg": {
|
||
"description": "DMG-specific settings.",
|
||
"default": {
|
||
"appPosition": {
|
||
"x": 180,
|
||
"y": 170
|
||
},
|
||
"applicationFolderPosition": {
|
||
"x": 480,
|
||
"y": 170
|
||
},
|
||
"windowSize": {
|
||
"height": 400,
|
||
"width": 660
|
||
}
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/DmgConfig"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"DmgConfig": {
|
||
"description": "Configuration for Apple Disk Image (.dmg) bundles.\n\nSee more: <https://tauri.app/v1/api/config#dmgconfig>",
|
||
"type": "object",
|
||
"properties": {
|
||
"background": {
|
||
"description": "Image to use as the background in dmg file. Accepted formats: `png`/`jpg`/`gif`.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
},
|
||
"windowPosition": {
|
||
"description": "Position of volume window on screen.",
|
||
"anyOf": [
|
||
{
|
||
"$ref": "#/definitions/Position"
|
||
},
|
||
{
|
||
"type": "null"
|
||
}
|
||
]
|
||
},
|
||
"windowSize": {
|
||
"description": "Size of volume window.",
|
||
"default": {
|
||
"height": 400,
|
||
"width": 660
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/Size"
|
||
}
|
||
]
|
||
},
|
||
"appPosition": {
|
||
"description": "Position of app file on window.",
|
||
"default": {
|
||
"x": 180,
|
||
"y": 170
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/Position"
|
||
}
|
||
]
|
||
},
|
||
"applicationFolderPosition": {
|
||
"description": "Position of application folder on window.",
|
||
"default": {
|
||
"x": 480,
|
||
"y": 170
|
||
},
|
||
"allOf": [
|
||
{
|
||
"$ref": "#/definitions/Position"
|
||
}
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"Position": {
|
||
"description": "Position coordinates struct.",
|
||
"type": "object",
|
||
"required": [
|
||
"x",
|
||
"y"
|
||
],
|
||
"properties": {
|
||
"x": {
|
||
"description": "X coordinate.",
|
||
"type": "integer",
|
||
"format": "uint32",
|
||
"minimum": 0.0
|
||
},
|
||
"y": {
|
||
"description": "Y coordinate.",
|
||
"type": "integer",
|
||
"format": "uint32",
|
||
"minimum": 0.0
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"Size": {
|
||
"description": "Size of the window.",
|
||
"type": "object",
|
||
"required": [
|
||
"height",
|
||
"width"
|
||
],
|
||
"properties": {
|
||
"width": {
|
||
"description": "Width of the window.",
|
||
"type": "integer",
|
||
"format": "uint32",
|
||
"minimum": 0.0
|
||
},
|
||
"height": {
|
||
"description": "Height of the window.",
|
||
"type": "integer",
|
||
"format": "uint32",
|
||
"minimum": 0.0
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"IosConfig": {
|
||
"description": "General configuration for the iOS target.",
|
||
"type": "object",
|
||
"properties": {
|
||
"developmentTeam": {
|
||
"description": "The development team. This value is required for iOS development because code signing is enforced. The `APPLE_DEVELOPMENT_TEAM` environment variable can be set to overwrite it.",
|
||
"type": [
|
||
"string",
|
||
"null"
|
||
]
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"AndroidConfig": {
|
||
"description": "General configuration for the iOS target.",
|
||
"type": "object",
|
||
"properties": {
|
||
"minSdkVersion": {
|
||
"description": "The minimum API level required for the application to run. The Android system will prevent the user from installing the application if the system's API level is lower than the value specified.",
|
||
"default": 24,
|
||
"type": "integer",
|
||
"format": "uint32",
|
||
"minimum": 0.0
|
||
}
|
||
},
|
||
"additionalProperties": false
|
||
},
|
||
"PluginConfig": {
|
||
"description": "The plugin configs holds a HashMap mapping a plugin name to its configuration object.\n\nSee more: <https://tauri.app/v1/api/config#pluginconfig>",
|
||
"type": "object",
|
||
"additionalProperties": true
|
||
}
|
||
}
|
||
} |