"description":"The tauri.conf.json is a file 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## Platform-Specific Configuration\n\nIn addition to the JSON defined on the `tauri.conf.json` file, Tauri can read a platform-specific configuration from `tauri.linux.conf.json`, `tauri.windows.conf.json`, and `tauri.macos.conf.json` and merges it with the main `tauri.conf.json` configuration.\n\n## Configuration Structure\n\n`tauri.conf.json` is composed of the following objects:\n\n- [`package`](#packageconfig): Package settings - [`tauri`](#tauriconfig): The Tauri config - [`build`](#buildconfig): The build configuration - [`plugins`](#pluginconfig): The plugins config\n\n```json title=\"Example tauri.config.json file\" { \"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 } ] } } ```",
"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.",
"description":"Whether the window is transparent or not.\n\nNote that on `macOS` this requires the `macos-private-api` feature flag, enabled under `tauri.conf.json > tauri > macOSPrivateApi`. WARNING: Using private APIs on `macOS` prevents your application from being accepted to the `App Store`.",
"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.",
"description":"Adds additional help information to be displayed in addition to auto-generated help. This information is displayed before the auto-generated help information. This is often used for header information.",
"description":"Adds additional help information to be displayed in addition to auto-generated help. This information is displayed after the auto-generated help information. This is often used to describe how to use the arguments, or caveats to be noted.",
"description":"The short version of the argument, without the preceding -.\n\nNOTE: Any leading `-` characters will be stripped, and only the first non-character will be used as the short version.",
"type":[
"string",
"null"
],
"maxLength":1,
"minLength":1
},
"name":{
"description":"The unique argument name",
"type":"string"
},
"description":{
"description":"The argument description which will be shown on the help information. Typically, this is a short (one line) description of the arg.",
"type":[
"string",
"null"
]
},
"longDescription":{
"description":"The argument long description which will be shown on the help information. Typically this a more detailed (multi-line) message that describes the argument.",
"type":[
"string",
"null"
]
},
"takesValue":{
"description":"Specifies that the argument takes a value at run time.\n\nNOTE: values for arguments may be specified in any of the following methods - Using a space such as -o value or --option value - Using an equals and no space such as -o=value or --option=value - Use a short and no space such as -ovalue",
"description":"Specifies that the argument may have an unknown number of multiple values. Without any other settings, this argument may appear only once.\n\nFor example, --opt val1 val2 is allowed, but --opt val1 val2 --opt val3 is not.\n\nNOTE: Setting this requires `takes_value` to be set to true.",
"description":"Specifies that the argument may appear more than once. For flags, this results in the number of occurrences of the flag being recorded. For example -ddd or -d -d -d would count as three occurrences. For options or arguments that take a value, this does not affect how many values they can accept. (i.e. only one at a time is allowed)\n\nFor example, --opt val1 --opt val2 is allowed, but --opt val1 val2 is not.",
"description":"Specifies how many values are required to satisfy this argument. For example, if you had a `-f <file>` argument where you wanted exactly 3 'files' you would set `number_of_values = 3`, and this argument wouldn't be satisfied unless the user provided 3 and only 3 values.\n\n**NOTE:** Does *not* require `multiple_occurrences = true` to be set. Setting `multiple_occurrences = true` would allow `-f <file> <file> <file> -f <file> <file> <file>` where as *not* setting it would only allow one occurrence of this argument.\n\n**NOTE:** implicitly sets `takes_value = true` and `multiple_values = true`.",
"description":"Specifies a list of possible values for this argument. At runtime, the CLI verifies that only one of the specified values was used, or fails with an error message.",
"description":"Specifies the minimum number of values for this argument. For example, if you had a -f `<file>` argument where you wanted at least 2 'files', you would set `minValues: 2`, and this argument would be satisfied if the user provided, 2 or more values.",
"description":"Specifies the maximum number of values are for this argument. For example, if you had a -f `<file>` argument where you wanted up to 3 'files', you would set .max_values(3), and this argument would be satisfied if the user provided, 1, 2, or 3 values.",
"description":"Sets whether or not the argument is required by default.\n\n- Required by default means it is required, when no other conflicting rules have been evaluated - Conflicting rules take precedence over being required.",
"description":"Sets args that override this arg's required setting i.e. this arg will be required unless at least one of these other arguments are present.",
"description":"Tets an argument by name that is required when this one is present i.e. when using this argument, the following argument must be present.",
"description":"Sts multiple arguments by names that are required when this one is present i.e. when using this argument, the following arguments must be present.",
"description":"Allows a conditional requirement with the signature [arg, value] the requirement will only become valid if `arg`'s value equals `${value}`.",
"description":"Allows specifying that an argument is required conditionally with the signature [arg, value] the requirement will only become valid if the `arg`'s value equals `${value}`.",
"description":"Requires that options use the --option=val syntax i.e. an equals between the option and associated value.",
"type":[
"boolean",
"null"
]
},
"index":{
"description":"The positional argument index, starting at 1.\n\nThe index refers to position according to other positional argument. It does not define position in the argument list as a whole. When utilized with multiple=true, only the last positional argument may be defined as multiple (i.e. the one with the highest index).",
"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 (.).",
"description":"Configuration for the Debian bundle.",
"default":{
"files":{}
},
"allOf":[
{
"$ref":"#/definitions/DebConfig"
}
]
},
"macOS":{
"description":"Configuration for the macOS bundles.",
"default":{
"minimumSystemVersion":"10.13"
},
"allOf":[
{
"$ref":"#/definitions/MacConfig"
}
]
},
"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.",
"description":"Configuration for AppImage bundles.",
"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.",
"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.",
"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.",
"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.",
"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.",
"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.",
"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>.",
"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 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 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 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.",
"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.",
"description":"Disables the Webview2 runtime installation after app install.\n\nWill be removed in v2, prefer the [`WindowsConfig::webview_install_mode`] option.",
"description":"The path to the license file to render on the installer.\n\nMust be an RTF file, so if a different extension is provided, we convert it to the RTF format.",
"type":[
"string",
"null"
]
},
"enableElevatedUpdateTask":{
"description":"Create an elevated update task within Windows Task Scheduler.",
"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.",
"description":"The path to a locale (`.wxl`) file. See <https://wixtoolset.org/documentation/manual/v3/howtos/ui_and_localization/build_a_localized_version.html>.",
"description":"Filesystem 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`.",
"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.",
"description":"Enable sidecar execution, allowing the JavaScript layer to spawn a sidecar command, an executable that is shipped with the application. For more information see <https://tauri.app/v1/guides/building/sidecar>.",
"description":"Shell scope definition. It is a list of command names and associated CLI arguments that restrict the API access from the webview.",
"type":"array",
"items":{
"$ref":"#/definitions/ShellAllowedCommand"
}
},
"ShellAllowedCommand":{
"description":"A command allowed to be executed by the webview API.",
"type":"object",
"required":[
"name"
],
"properties":{
"name":{
"description":"The name for this allowed shell command configuration.\n\nThis name will be used inside of the webview API to call this command along with any specified arguments.",
"description":"The command name. It 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`.",
"default":"",
"type":"string"
},
"args":{
"description":"The allowed arguments for the command execution.",
"description":"If this command is a sidecar command.",
"default":false,
"type":"boolean"
}
}
},
"ShellAllowedArgs":{
"description":"A set of command arguments allowed to be executed by the webview API.\n\nA value of `true` will allow any arguments to be passed to the command. `false` will disable all arguments. A list of [`ShellAllowedArg`] will set those arguments as the only valid arguments to be passed to the attached command configuration.",
"anyOf":[
{
"description":"Use a simple boolean to allow all or disable all arguments to this command configuration.",
"description":"A specific set of [`ShellAllowedArg`] that are valid to call for the command configuration.",
"type":"array",
"items":{
"$ref":"#/definitions/ShellAllowedArg"
}
}
]
},
"ShellAllowedArg":{
"description":"A command argument allowed to be executed by the webview API.",
"anyOf":[
{
"description":"A non-configurable argument that is passed to the command in the order it was specified.",
"type":"string"
},
{
"description":"A variable that is set while calling the command from the webview API.",
"type":"object",
"required":[
"validator"
],
"properties":{
"validator":{
"description":"[regex] validator to require passed values to conform to an expected input.\n\nThis will require the argument value passed to this variable to match the `validator` regex before it will be executed.\n\n[regex]: https://docs.rs/regex/latest/regex/#syntax",
"type":"string"
}
},
"additionalProperties":false
}
]
},
"ShellAllowlistOpen":{
"description":"Defines the `shell > open` api scope.",
"anyOf":[
{
"description":"If the shell open API should be enabled.\n\nIf enabled, the default validation regex (`^https?://`) is used.",
"type":"boolean"
},
{
"description":"Enable the shell open API, with a custom regex that the opened path must match against.\n\nIf using a custom regex to support a non-http(s) schema, care should be used to prevent values that allow flag-like strings to pass validation. e.g. `--enable-debugging`, `-i`, `/R`.",
"type":"string"
}
]
},
"DialogAllowlistConfig":{
"description":"Allowlist for the dialog APIs.",
"type":"object",
"properties":{
"all":{
"description":"Use this flag to enable all dialog API features.",
"description":"HTTP API scope definition. It is a list of URLs that can be accessed by the webview when using the HTTP APIs. The scoped URL is matched against the request URL using a glob pattern.\n\nExamples: - \"https://**\": allows all HTTPS urls - \"https://*.github.com/tauri-apps/tauri\": allows any subdomain of \"github.com\" with the \"tauri-apps/api\" path - \"https://myapi.service.com/users/*\": allows access to any URLs that begins with \"https://myapi.service.com/users/\"",
"type":"array",
"items":{
"type":"string",
"format":"uri"
}
},
"NotificationAllowlistConfig":{
"description":"Allowlist for the notification APIs.",
"type":"object",
"properties":{
"all":{
"description":"Use this flag to enable all notification API features.",
"default":false,
"type":"boolean"
}
},
"additionalProperties":false
},
"GlobalShortcutAllowlistConfig":{
"description":"Allowlist for the global shortcut APIs.",
"type":"object",
"properties":{
"all":{
"description":"Use this flag to enable all global shortcut API features.",
"description":"Dangerous option that allows macOS to relaunch even if the binary contains a symlink.\n\nThis is due to macOS having less symlink protection. Highly recommended to not set this flag unless you have a very specific reason too, and understand the implications of it.",
"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>.",
"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>.",
"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.",
"description":"The updater endpoints. TLS is enforced on production.\n\nThe updater URL can contain the following variables: - {{current_version}}: The version of the app that is requesting the update - {{target}}: The operating system name (one of `linux`, `windows` or `darwin`). - {{arch}}: The architecture of the machine (one of `x86_64`, `i686`, `aarch64` or `armv7`).\n\n# Examples - \"https://my.cdn.com/latest.json\": a raw JSON endpoint that returns the latest version and download links for each platform. - \"https://updates.app.dev/{{target}}?version={{current_version}}&arch={{arch}}\": a dedicated API with positional and query string arguments.",
"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.",
"description":"The path to the application assets or URL to load in development.\n\nThis is usually an URL to a dev server, which serves your application assets with live reloading. Most modern JavaScript bundlers provides a way to start a dev server by default.\n\nSee [vite](https://vitejs.dev/guide/), [Webpack DevServer](https://webpack.js.org/configuration/dev-server/) and [sirv](https://github.com/lukeed/sirv) for examples on how to set up a dev server.",
"description":"The path to the application assets or URL to load in production.\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` file unless you provide a custom window URL.\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 an URL is provided, the application won't have bundled assets and the application will load that URL by default.",
"description":"A shell command to run before `tauri dev` kicks in.\n\nThe TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
"description":"A shell command to run before `tauri build` kicks in.\n\nThe TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.",
"type":[
"string",
"null"
]
},
"features":{
"description":"Features passed to `cargo` commands.",
