mirror of https://github.com/tauri-apps/tauri-docs.git synced 2026-01-31 00:35:16 +01:00

Files

tauri 6d4c49663b Update Docs (#3115 )

Co-authored-by: tauri-bot <tauri-bot@users.noreply.github.com>

2025-01-10 22:29:08 +01:00

106 KiB

Raw Permalink Blame History

toc_max_heading_level

toc_max_heading_level
5

Configuration

The Tauri configuration object. It is read from a file where you can define your frontend assets, configure the bundler, enable the app updater, define a system tray, enable APIs via the allowlist and more.

The configuration file is generated by the tauri init command that lives in your Tauri application source directory (src-tauri).

Once generated, you may modify it at will to customize your Tauri application.

File Formats

By default, the configuration is defined as a JSON file named tauri.conf.json.

Tauri 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.

Platform-Specific Configuration

In addition to the default configuration file, Tauri can read a platform-specific configuration from tauri.linux.conf.json, tauri.windows.conf.json, and tauri.macos.conf.json (or Tauri.linux.toml, Tauri.windows.toml and Tauri.macos.toml if the Tauri.toml format is used), which gets merged with the main configuration object.

Configuration Structure

The configuration is composed of the following objects:

package: Package settings
tauri: The Tauri config
build: The build configuration
plugins: The plugins config

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
      }
    ]
  }
}

Type: object

Name	Type	Default	Description
`package`	`PackageConfig`	view	Package settings.
`tauri`	`TauriConfig`	view	The Tauri configuration.
`build`	`BuildConfig`	view	The build configuration.
`plugins`	`PluginConfig`	view	The plugins config.

PackageConfig

The package configuration.

Type: object

Name	Type	Default	Description
`productName`	string?	null	App name.
`version`	string?	null	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.

TauriConfig

The Tauri configuration object.

Type: object

Name	Type	Default	Description
`pattern`	`PatternKind`	view	The pattern to use.
`windows`	`WindowConfig`	[]	The windows configuration.
`cli`	`CliConfig`?	view	The CLI configuration.
`bundle`	`BundleConfig`	view	The bundler configuration.
`allowlist`	`AllowlistConfig`	view	The allowlist configuration.
`security`	`SecurityConfig`	view	Security configuration.
`updater`	`UpdaterConfig`	view	The updater configuration.
`systemTray`	`SystemTrayConfig`?	view	Configuration for app system tray.
`macOSPrivateApi`	boolean	`false`	MacOS private API configuration. Enables the transparent background API and sets the `fullScreenEnabled` preference to `true`.

PatternKind

The application pattern.

Can be any ONE of the following types:

{ "use": "brownfield" }: Brownfield pattern.

Name Type Default Description

use
"brownfield" (required) undefined
{ "use": "isolation", "options": { "dir": string } }: Isolation pattern. Recommended for security purposes.

Name Type Default Description

use
"isolation" (required) undefined

options
{ "dir": string } (required) undefined

Name	Type	Default	Description
`use`	"brownfield" (required)		undefined

Name	Type	Default	Description
`use`	"isolation" (required)		undefined
`options`	{ "dir": string } (required)		undefined

WindowConfig

The window configuration object.

Type: object

Name	Type	Default	Description
`label`	string	null	The window identifier. It must be alphanumeric.
`url`	`WindowUrl`	view	The window webview URL.
`userAgent`	string?	null	The user agent for the webview
`fileDropEnabled`	boolean	`true`	Whether the file drop is enabled or not on the webview. By default it is enabled. Disabling it is required to use drag and drop on the frontend on Windows.
`center`	boolean	`false`	Whether or not the window starts centered or not.
`x`	number? (format: `double`)	null	The horizontal position of the window's top left corner
`y`	number? (format: `double`)	null	The vertical position of the window's top left corner
`width`	number (format: `double`)	`800`	The window width.
`height`	number (format: `double`)	`600`	The window height.
`minWidth`	number? (format: `double`)	null	The min window width.
`minHeight`	number? (format: `double`)	null	The min window height.
`maxWidth`	number? (format: `double`)	null	The max window width.
`maxHeight`	number? (format: `double`)	null	The max window height.
`resizable`	boolean	`true`	Whether the window is resizable or not. When resizable is set to false, native window's maximize button is automatically disabled.
`maximizable`	boolean	`true`	Whether the window's native maximize button is enabled or not. If resizable is set to false, this setting is ignored. ## Platform-specific - macOS: Disables the "zoom" button in the window titlebar, which is also used to enter fullscreen mode. - Linux / iOS / Android: Unsupported.
`minimizable`	boolean	`true`	Whether the window's native minimize button is enabled or not. ## Platform-specific - Linux / iOS / Android: Unsupported.
`closable`	boolean	`true`	Whether the window's native close button is enabled or not. ## Platform-specific - 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.
`title`	string	null	The window title.
`fullscreen`	boolean	`false`	Whether the window starts as fullscreen or not.
`focus`	boolean	`true`	Whether the window will be initially focused or not.
`transparent`	boolean	`false`	Whether the window is transparent or not. Note 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`.
`maximized`	boolean	`false`	Whether the window is maximized or not.
`visible`	boolean	`true`	Whether the window is visible or not.
`decorations`	boolean	`true`	Whether the window should have borders and bars.
`alwaysOnTop`	boolean	`false`	Whether the window should always be on top of other windows.
`contentProtected`	boolean	`false`	Prevents the window contents from being captured by other apps.
`skipTaskbar`	boolean	`false`	If `true`, hides the window icon from the taskbar on Windows and Linux.
`theme`	`Theme`?	view	The initial window theme. Defaults to the system theme. Only implemented on Windows and macOS 10.14+.
`titleBarStyle`	`TitleBarStyle`	view	The style of the macOS title bar.
`hiddenTitle`	boolean	`false`	If `true`, sets the window title to be hidden on macOS.
`acceptFirstMouse`	boolean	`false`	Whether clicking an inactive window also clicks through to the webview on macOS.
`tabbingIdentifier`	string?	null	Defines the window tabbing identifier for macOS. Windows with matching tabbing identifiers will be grouped together. If the tabbing identifier is not set, automatic tabbing will be disabled.
`additionalBrowserArgs`	string?	null	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.

WindowUrl

An URL to open on a Tauri webview window.

Can be any of the following types:

string (format: uri): An external URL.
string: The path portion of an app URL. For instance, to load tauri://localhost/users/john, you can simply provide users/john in this configuration.

Theme

System theme.

Can be any ONE of the following types:

"Light": Light theme.
"Dark": Dark theme.

TitleBarStyle

How the window title bar should be displayed on macOS.

Can be any ONE of the following types:

"Visible": A normal title bar.
"Transparent": Makes the title bar transparent, so the window background color is shown instead.

Useful 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.
"Overlay": Shows the title bar as a transparent overlay over the window's content.

Keep in mind:
The height of the title bar is different on different OS versions, which can lead to the window controls and title not being where you expect them to be.
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.

CliConfig

describes a CLI configuration

Type: object

Name	Type	Default	Description
`description`	string?	null	Command description which will be shown on the help information.
`longDescription`	string?	null	Command long description which will be shown on the help information.
`beforeHelp`	string?	null	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.
`afterHelp`	string?	null	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.
`args`	`CliArg`?	null	List of arguments for the command
`subcommands`	`CliConfig`?	null	List of subcommands of this command

CliArg

A CLI argument definition.

Type: object

Name	Type	Default	Description
`short`	string?	null	The short version of the argument, without the preceding -. NOTE: Any leading `-` characters will be stripped, and only the first non-character will be used as the short version.
`name`	string (required)		The unique argument name
`description`	string?	null	The argument description which will be shown on the help information. Typically, this is a short (one line) description of the arg.
`longDescription`	string?	null	The argument long description which will be shown on the help information. Typically this a more detailed (multi-line) message that describes the argument.
`takesValue`	boolean	`false`	Specifies that the argument takes a value at run time. NOTE: 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
`multiple`	boolean	`false`	Specifies that the argument may have an unknown number of multiple values. Without any other settings, this argument may appear only once. For example, --opt val1 val2 is allowed, but --opt val1 val2 --opt val3 is not. NOTE: Setting this requires `takes_value` to be set to true.
`multipleOccurrences`	boolean	`false`	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) For example, --opt val1 --opt val2 is allowed, but --opt val1 val2 is not.
`numberOfValues`	integer? (format: `uint`)	null	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. 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. NOTE: implicitly sets `takes_value = true` and `multiple_values = true`.
`possibleValues`	array?	null	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.
`minValues`	integer? (format: `uint`)	null	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.
`maxValues`	integer? (format: `uint`)	null	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.
`required`	boolean	`false`	Sets whether or not the argument is required by default. - Required by default means it is required, when no other conflicting rules have been evaluated - Conflicting rules take precedence over being required.
`requiredUnlessPresent`	string?	null	Sets an arg that override this arg's required setting i.e. this arg will be required unless this other argument is present.
`requiredUnlessPresentAll`	array?	null	Sets args that override this arg's required setting i.e. this arg will be required unless all these other arguments are present.
`requiredUnlessPresentAny`	array?	null	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.
`conflictsWith`	string?	null	Sets a conflicting argument by name i.e. when using this argument, the following argument can't be present and vice versa.
`conflictsWithAll`	array?	null	The same as conflictsWith but allows specifying multiple two-way conflicts per argument.
`requires`	string?	null	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.
`requiresAll`	array?	null	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.
`requiresIf`	array?	null	Allows a conditional requirement with the signature [arg, value] the requirement will only become valid if `arg`'s value equals `${value}`.
`requiredIfEq`	array?	null	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}`.
`requireEquals`	boolean?	null	Requires that options use the --option=val syntax i.e. an equals between the option and associated value.
`index`	integer? (format: `uint`, minimum: `1`)	null	The positional argument index, starting at 1. The 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).

BundleConfig

Configuration for tauri-bundler.

Type: object

Name	Type	Default	Description
`active`	boolean	`false`	Whether Tauri should bundle your application or just output the executable.
`targets`	`BundleTarget`	view	The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all".
`identifier`	string (required)		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 (.).
`publisher`	string?	null	The application's publisher. Defaults to the second element in the identifier string. Currently maps to the Manufacturer property of the Windows Installer.
`icon`	string[]	[]	The app's icons
`resources`	`BundleResources`?	view	App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported.
`copyright`	string?	null	A copyright string associated with your application.
`category`	string?	null	The application kind. Should 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.
`shortDescription`	string?	null	A short description of your application.
`longDescription`	string?	null	A longer, multi-line description of the application.
`useLocalToolsDir`	boolean	`false`	Whether to use the project's `target` directory, for caching build tools (e.g., Wix and NSIS) when building this application. Defaults to `false`. If true, tools will be cached in `target\.tauri-tools`. If false, tools will be cached in the current user's platform-specific cache directory. An example where it can be appropriate to set this to `true` is when building this application as a Windows System user (e.g., AWS EC2 workloads), because the Window system's app data directory is restricted.
`appimage`	`AppImageConfig`	view	Configuration for the AppImage bundle.
`deb`	`DebConfig`	view	Configuration for the Debian bundle.
`rpm`	`RpmConfig`	view	Configuration for the RPM bundle.
`dmg`	`DmgConfig`	view	DMG-specific settings.
`macOS`	`MacConfig`	view	Configuration for the macOS bundles.
`externalBin`	array?	null	A list of—either absolute or relative—paths to binaries to embed with your application. Note that Tauri will look for system-specific binaries following the pattern "binary-name{-target-triple}{.system-extension}". E.g. for the external binary "my-binary", Tauri looks for: - "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 so don't forget to provide binaries for all targeted platforms.
`windows`	`WindowsConfig`	view	Configuration for the Windows bundle.

BundleTarget

Targets to bundle. Each value is case insensitive.

Can be any of the following types:

"all": Bundle all targets.
BundleType: A list of bundle targets.
BundleType: A single bundle target.

BundleType

A bundle referenced by tauri-bundler.

Can be any ONE of the following types:

"deb": The debian bundle (.deb).
"rpm": The RPM bundle (.rpm).
"appimage": The AppImage bundle (.appimage).
"msi": The Microsoft Installer bundle (.msi).
"nsis": The NSIS bundle (.exe).
"app": The macOS application bundle (.app).
"dmg": The Apple Disk Image bundle (.dmg).
"updater": The Tauri updater bundle.

BundleResources

Definition for bundle resources. Can be either a list of paths to include or a map of source to target paths.

Can be any of the following types:

string[]: A list of paths to include.
object: A map of source to target paths.

AppImageConfig

Configuration for AppImage bundles.

Type: object

Name	Type	Default	Description
`bundleMediaFramework`	boolean	`false`	Include additional gstreamer dependencies needed for audio and video playback. This increases the bundle size by ~15-35MB depending on your build system.

DebConfig

Configuration for Debian (.deb) bundles.

Type: object

Name	Type	Default	Description
`depends`	array?	null	The list of deb dependencies your application relies on.
`provides`	array?	null	The list of dependencies the package provides.
`conflicts`	array?	null	The list of package conflicts.
`replaces`	array?	null	The list of package replaces.
`files`	object	null	The files to include on the package.
`desktopTemplate`	string?	null	Path to a custom desktop file Handlebars template. Available variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.
`section`	string?	null	Define the section in Debian Control file. See : https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections
`priority`	string?	null	Change the priority of the Debian Package. By default, it is set to `optional`. Recognized Priorities as of now are : `required`, `important`, `standard`, `optional`, `extra`
`changelog`	string?	null	Path of the uncompressed Changelog file, to be stored at /usr/share/doc/package-name/changelog.gz. See https://www.debian.org/doc/debian-policy/ch-docs.html#changelog-files-and-release-notes

RpmConfig

Configuration for RPM bundles.

Type: object

Name	Type	Default	Description
`license`	string?	null	The package's license identifier. If not set, defaults to the license from the Cargo.toml file.
`depends`	array?	null	The list of RPM dependencies your application relies on.
`provides`	array?	null	The list of RPM dependencies your application provides.
`conflicts`	array?	null	The list of RPM dependencies your application conflicts with. They must not be present in order for the package to be installed.
`obsoletes`	array?	null	The list of RPM dependencies your application supersedes - if this package is installed, packages listed as "obsoletes" will be automatically removed (if they are present).
`release`	string	null	The RPM release tag.
`epoch`	integer (format: `uint32`)	`0`	The RPM epoch.
`files`	object	null	The files to include on the package.
`desktopTemplate`	string?	null	Path to a custom desktop file Handlebars template. Available variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.

DmgConfig

Configuration for Apple Disk Image (.dmg) bundles.

Type: object

Name	Type	Default	Description
`background`	string?	null	Image to use as the background in dmg file. Accepted formats: `png`/`jpg`/`gif`.
`windowPosition`	`Position`?	view	Position of volume window on screen.
`windowSize`	`Size`	view	Size of volume window.
`appPosition`	`Position`	view	Position of app file on window.
`applicationFolderPosition`	`Position`	view	Position of application folder on window.

Position

Position coordinates struct.

Type: object

Name	Type	Default	Description
`x`	integer (format: `uint32`) (required)		X coordinate.
`y`	integer (format: `uint32`) (required)		Y coordinate.

Size

Size of the window.

Type: object

Name	Type	Default	Description
`width`	integer (format: `uint32`) (required)		Width of the window.
`height`	integer (format: `uint32`) (required)		Height of the window.

MacConfig

Configuration for the macOS bundles.

Type: object

Name	Type	Default	Description
`frameworks`	array?	null	A list of strings indicating any macOS X frameworks that need to be bundled with the application. If 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.
`minimumSystemVersion`	string?	null	A version string indicating the minimum macOS X version that the bundled application supports. Defaults to `10.13`. Setting it to `null` completely removes the `LSMinimumSystemVersion` field on the bundle's `Info.plist` and the `MACOSX_DEPLOYMENT_TARGET` environment variable. An empty string is considered an invalid value so the default value is used.
`exceptionDomain`	string?	null	Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name.
`license`	string?	null	The path to the license file to add to the DMG bundle.
`signingIdentity`	string?	null	Identity to use for code signing.
`hardenedRuntime`	boolean	`true`	Whether the codesign should enable hardened runtime (for executables) or not.
`providerShortName`	string?	null	Provider short name for notarization.
`entitlements`	string?	null	Path to the entitlements file.

WindowsConfig

Windows bundler configuration.

Type: object

Name	Type	Default	Description
`digestAlgorithm`	string?	null	Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended.
`certificateThumbprint`	string?	null	Specifies the SHA1 hash of the signing certificate.
`timestampUrl`	string?	null	Server to use during timestamping.
`tsp`	boolean	`false`	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.
`webviewInstallMode`	`WebviewInstallMode`	view	The installation mode for the Webview2 runtime.
`webviewFixedRuntimePath`	string?	null	Path to the webview fixed runtime to use. Overwrites `webview_install_mode` if set. Will be removed in v2, prefer the `webview_install_mode` option. The fixed version can be downloaded on the official website. The `.cab` file must be extracted to a folder and this folder path must be defined on this field.
`allowDowngrades`	boolean	`true`	Validates a second app installation, blocking the user from installing an older version if set to `false`. For instance, if `1.2.1` is installed, the user won't be able to install app version `1.2.0` or `1.1.5`. The default value of this flag is `true`.
`wix`	`WixConfig`?	view	Configuration for the MSI generated with WiX.
`nsis`	`NsisConfig`?	view	Configuration for the installer generated with NSIS.
`signCommand`	string?	null	Specify a custom command to sign the binaries. This command needs to have a `%1` in it which is just a placeholder for the binary path, which we will detect and replace before calling the command. Example: `text sign-cli --arg1 --arg2 %1` By Default we use `signtool.exe` which can be found only on Windows so if you are on another platform and want to cross-compile and sign you will need to use another tool like `osslsigncode`.

WebviewInstallMode

Install modes for the Webview2 runtime. Note that for the updater bundle DownloadBootstrapper is used.

For more information see https://tauri.app/v1/guides/building/windows.

Can be any ONE of the following types:

{ "type": "skip" }: Do not install the Webview2 as part of the Windows Installer.

Name Type Default Description

type
"skip" (required) undefined
{ "type": "downloadBootstrapper", "silent": boolean }: Download the bootstrapper and run it. Requires an internet connection. Results in a smaller installer size, but is not recommended on Windows 7.

Name Type Default Description

type
"downloadBootstrapper" (required) undefined

silent
boolean true Instructs the installer to run the bootstrapper in silent mode. Defaults to true.
{ "type": "embedBootstrapper", "silent": boolean }: 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.

Name Type Default Description

type
"embedBootstrapper" (required) undefined

silent
boolean true Instructs the installer to run the bootstrapper in silent mode. Defaults to true.
{ "type": "offlineInstaller", "silent": boolean }: Embed the offline installer and run it. Does not require an internet connection. Increases the installer size by around 127MB.

Name Type Default Description

type
"offlineInstaller" (required) undefined

silent
boolean true Instructs the installer to run the installer in silent mode. Defaults to true.

Name	Type	Default	Description
`type`	"skip" (required)		undefined

Name	Type	Default	Description
`type`	"downloadBootstrapper" (required)		undefined
`silent`	boolean	`true`	Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.

Name	Type	Default	Description
`type`	"embedBootstrapper" (required)		undefined
`silent`	boolean	`true`	Instructs the installer to run the bootstrapper in silent mode. Defaults to `true`.

Name	Type	Default	Description
`type`	"offlineInstaller" (required)		undefined
`silent`	boolean	`true`	Instructs the installer to run the installer in silent mode. Defaults to `true`.

{ "type": "fixedRuntime", "path": string }: Embed a fixed webview2 version and use it at runtime. Increases the installer size by around 180MB.

Name	Type	Default	Description
`type`	"fixedRuntime" (required)		undefined
`path`	string (required)		The path to the fixed runtime to use. The fixed version can be downloaded on the official website. The `.cab` file must be extracted to a folder and this folder path must be defined on this field.

WixConfig

Configuration for the MSI bundle using WiX.

Type: object

Name	Type	Default	Description
`language`	`WixLanguage`	view	The installer languages to build. See https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables.
`template`	string?	null	A custom .wxs template to use.
`fragmentPaths`	string[]	[]	A list of paths to .wxs files with WiX fragments to use.
`componentGroupRefs`	string[]	[]	The ComponentGroup element ids you want to reference from the fragments.
`componentRefs`	string[]	[]	The Component element ids you want to reference from the fragments.
`featureGroupRefs`	string[]	[]	The FeatureGroup element ids you want to reference from the fragments.
`featureRefs`	string[]	[]	The Feature element ids you want to reference from the fragments.
`mergeRefs`	string[]	[]	The Merge element ids you want to reference from the fragments.
`skipWebviewInstall`	boolean	`false`	Disables the Webview2 runtime installation after app install. Will be removed in v2, prefer the [`WindowsConfig::webview_install_mode`] option.
`license`	string?	null	The path to the license file to render on the installer. Must be an RTF file, so if a different extension is provided, we convert it to the RTF format.
`enableElevatedUpdateTask`	boolean	`false`	Create an elevated update task within Windows Task Scheduler.
`bannerPath`	string?	null	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. The required dimensions are 493px × 58px.
`dialogImagePath`	string?	null	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.

WixLanguage

The languages to build using WiX.

Can be any of the following types:

string: A single language to build, without configuration.
string[]: A list of languages to build, without configuration.
WixLanguageConfig: A map of languages and its configuration.

WixLanguageConfig

Configuration for a target language for the WiX build.

Type: object

Name	Type	Default	Description
`localePath`	string?	null	The path to a locale (`.wxl`) file. See https://wixtoolset.org/documentation/manual/v3/howtos/ui_and_localization/build_a_localized_version.html.

NsisConfig

Configuration for the Installer bundle using NSIS.

Type: object

Name	Type	Default	Description
`template`	string?	null	A custom .nsi template to use.
`license`	string?	null	The path to the license file to render on the installer.
`headerImage`	string?	null	The path to a bitmap file to display on the header of installers pages. The recommended dimensions are 150px x 57px.
`sidebarImage`	string?	null	The path to a bitmap file for the Welcome page and the Finish page. The recommended dimensions are 164px x 314px.
`installerIcon`	string?	null	The path to an icon file used as the installer icon.
`installMode`	`NSISInstallerMode`	view	Whether the installation will be for all users or just the current user.
`languages`	array?	null	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`. See https://github.com/kichik/nsis/tree/9465c08046f00ccb6eda985abbdbf52c275c6c4d/Contrib/Language%20files for the complete list of languages.
`customLanguageFiles`	object?	null	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. See https://github.com/tauri-apps/tauri/blob/dev/tooling/bundler/src/bundle/windows/templates/nsis-languages/English.nsh for an example `.nsh` file. Note: the key must be a valid NSIS language and it must be added to [`NsisConfig`] languages array,
`displayLanguageSelector`	boolean	`false`	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.
`compression`	`NsisCompression`?	view	Set the compression algorithm used to compress files in the installer. See https://nsis.sourceforge.io/Reference/SetCompressor

NSISInstallerMode

Install Modes for the NSIS installer.

Can be any ONE of the following types:

"currentUser": Default mode for the installer.

Install the app by default in a directory that doesn't require Administrator access.

Installer metadata will be saved under the HKCU registry path.

"perMachine": Install the app by default in the Program Files folder directory requires Administrator access for the installation.

Installer metadata will be saved under the HKLM registry path.
"both": 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.

Installer metadata will be saved under the HKLM or HKCU registry path based on the user's choice.

NsisCompression

Compression algorithms used in the NSIS installer.

See https://nsis.sourceforge.io/Reference/SetCompressor

Can be any ONE of the following types:

"zlib": ZLIB uses the deflate algorithm, it is a quick and simple method. With the default compression level it uses about 300 KB of memory.
"bzip2": 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.
"lzma": 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.

AllowlistConfig

Allowlist configuration. The allowlist is a translation of the Cargo allowlist features.

Notes

Endpoints that don't have their own allowlist option are enabled by default.
There is only "opt-in", no "opt-out". Setting an option to false has no effect.

Examples

- "app-all": true will make the hide endpoint be available regardless of whether hide is set to false or true in the allowlist.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all API features.
`fs`	`FsAllowlistConfig`	view	File system API allowlist.
`window`	`WindowAllowlistConfig`	view	Window API allowlist.
`shell`	`ShellAllowlistConfig`	view	Shell API allowlist.
`dialog`	`DialogAllowlistConfig`	view	Dialog API allowlist.
`http`	`HttpAllowlistConfig`	view	HTTP API allowlist.
`notification`	`NotificationAllowlistConfig`	view	Notification API allowlist.
`globalShortcut`	`GlobalShortcutAllowlistConfig`	view	Global shortcut API allowlist.
`os`	`OsAllowlistConfig`	view	OS allowlist.
`path`	`PathAllowlistConfig`	view	Path API allowlist.
`protocol`	`ProtocolAllowlistConfig`	view	Custom protocol allowlist.
`process`	`ProcessAllowlistConfig`	view	Process API allowlist.
`clipboard`	`ClipboardAllowlistConfig`	view	Clipboard APIs allowlist.
`app`	`AppAllowlistConfig`	view	App APIs allowlist.

FsAllowlistConfig

Allowlist for the file system APIs.

Type: object

Name	Type	Default	Description
`scope`	`FsAllowlistScope`	[]	The access scope for the filesystem APIs.
`all`	boolean	`false`	Use this flag to enable all file system API features.
`readFile`	boolean	`false`	Read file from local filesystem.
`writeFile`	boolean	`false`	Write file to local filesystem.
`readDir`	boolean	`false`	Read directory from local filesystem.
`copyFile`	boolean	`false`	Copy file from local filesystem.
`createDir`	boolean	`false`	Create directory from local filesystem.
`removeDir`	boolean	`false`	Remove directory from local filesystem.
`removeFile`	boolean	`false`	Remove file from local filesystem.
`renameFile`	boolean	`false`	Rename file from local filesystem.
`exists`	boolean	`false`	Check if path exists on the local filesystem.

FsAllowlistScope

Filesystem scope definition. It is a list of glob patterns that restrict the API access from the webview.

Each 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.

Can be any of the following types:

string[]: A list of paths that are allowed by this scope.

{ "allow": string[], "deny": string[], "requireLiteralLeadingDot": boolean? }: A complete scope configuration.

Name	Type	Default	Description
`allow`	string[]	[]	A list of paths that are allowed by this scope.
`deny`	string[]	[]	A list of paths that are not allowed by this scope. This gets precedence over the `Scope::allow` list.
`requireLiteralLeadingDot`	boolean?	null	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. Defaults to `true` on Unix systems and `false` on Windows

WindowAllowlistConfig

Allowlist for the window APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all window API features.
`create`	boolean	`false`	Allows dynamic window creation.
`center`	boolean	`false`	Allows centering the window.
`requestUserAttention`	boolean	`false`	Allows requesting user attention on the window.
`setResizable`	boolean	`false`	Allows setting the resizable flag of the window.
`setMaximizable`	boolean	`false`	Allows setting whether the window's native maximize button is enabled or not.
`setMinimizable`	boolean	`false`	Allows setting whether the window's native minimize button is enabled or not.
`setClosable`	boolean	`false`	Allows setting whether the window's native close button is enabled or not.
`setTitle`	boolean	`false`	Allows changing the window title.
`maximize`	boolean	`false`	Allows maximizing the window.
`unmaximize`	boolean	`false`	Allows unmaximizing the window.
`minimize`	boolean	`false`	Allows minimizing the window.
`unminimize`	boolean	`false`	Allows unminimizing the window.
`show`	boolean	`false`	Allows showing the window.
`hide`	boolean	`false`	Allows hiding the window.
`close`	boolean	`false`	Allows closing the window.
`setDecorations`	boolean	`false`	Allows setting the decorations flag of the window.
`setAlwaysOnTop`	boolean	`false`	Allows setting the always_on_top flag of the window.
`setContentProtected`	boolean	`false`	Allows preventing the window contents from being captured by other apps.
`setSize`	boolean	`false`	Allows setting the window size.
`setMinSize`	boolean	`false`	Allows setting the window minimum size.
`setMaxSize`	boolean	`false`	Allows setting the window maximum size.
`setPosition`	boolean	`false`	Allows changing the position of the window.
`setFullscreen`	boolean	`false`	Allows setting the fullscreen flag of the window.
`setFocus`	boolean	`false`	Allows focusing the window.
`setIcon`	boolean	`false`	Allows changing the window icon.
`setSkipTaskbar`	boolean	`false`	Allows setting the skip_taskbar flag of the window.
`setCursorGrab`	boolean	`false`	Allows grabbing the cursor.
`setCursorVisible`	boolean	`false`	Allows setting the cursor visibility.
`setCursorIcon`	boolean	`false`	Allows changing the cursor icon.
`setCursorPosition`	boolean	`false`	Allows setting the cursor position.
`setIgnoreCursorEvents`	boolean	`false`	Allows ignoring cursor events.
`startDragging`	boolean	`false`	Allows start dragging on the window.
`print`	boolean	`false`	Allows opening the system dialog to print the window content.

ShellAllowlistConfig

Allowlist for the shell APIs.

Type: object

Name	Type	Default	Description
`scope`	`ShellAllowlistScope`	[]	Access scope for the binary execution APIs. Sidecars are automatically enabled.
`all`	boolean	`false`	Use this flag to enable all shell API features.
`execute`	boolean	`false`	Enable binary execution.
`sidecar`	boolean	`false`	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.
`open`	`ShellAllowlistOpen`	`false`	Open URL with the user's default application.

ShellAllowlistScope

Shell scope definition. It is a list of command names and associated CLI arguments that restrict the API access from the webview.

Type: ShellAllowedCommand

ShellAllowedCommand

A command allowed to be executed by the webview API.

Type: object

Name	Type	Default	Description
`name`	string (required)		The name for this allowed shell command configuration. This name will be used inside of the webview API to call this command along with any specified arguments.
`cmd`	string	null	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`, `$APPCONFIG`, `$APPDATA`, `$APPLOCALDATA`, `$APPCACHE`, `$APPLOG`.
`args`	`ShellAllowedArgs`	`false`	The allowed arguments for the command execution.
`sidecar`	boolean	`false`	If this command is a sidecar command.

ShellAllowedArgs

A set of command arguments allowed to be executed by the webview API.

A 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.

Can be any of the following types:

boolean: Use a simple boolean to allow all or disable all arguments to this command configuration.
ShellAllowedArg: A specific set of [ShellAllowedArg] that are valid to call for the command configuration.

ShellAllowedArg

A command argument allowed to be executed by the webview API.

Can be any of the following types:

string: A non-configurable argument that is passed to the command in the order it was specified.

{ "validator": string }: A variable that is set while calling the command from the webview API.

Name	Type	Default	Description
`validator`	string (required)		regex validator to require passed values to conform to an expected input. This will require the argument value passed to this variable to match the `validator` regex before it will be executed.

ShellAllowlistOpen

Defines the shell > open api scope.

Can be any of the following types:

boolean: If the shell open API should be enabled.

If enabled, the default validation regex (^((mailto:\w+)|(tel:\w+)|(https?://\w+)).+) is used.
string: Enable the shell open API, with a custom regex that the opened path must match against.

If 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.

DialogAllowlistConfig

Allowlist for the dialog APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all dialog API features.
`open`	boolean	`false`	Allows the API to open a dialog window to pick files.
`save`	boolean	`false`	Allows the API to open a dialog window to pick where to save files.
`message`	boolean	`false`	Allows the API to show a message dialog window.
`ask`	boolean	`false`	Allows the API to show a dialog window with Yes/No buttons.
`confirm`	boolean	`false`	Allows the API to show a dialog window with Ok/Cancel buttons.

HttpAllowlistConfig

Allowlist for the HTTP APIs.

Type: object

Name	Type	Default	Description
`scope`	`HttpAllowlistScope`	[]	The access scope for the HTTP APIs.
`all`	boolean	`false`	Use this flag to enable all HTTP API features.
`request`	boolean	`false`	Allows making HTTP requests.

HttpAllowlistScope

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.

Examples:

"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: string _(format: uri)_[]

NotificationAllowlistConfig

Allowlist for the notification APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all notification API features.

GlobalShortcutAllowlistConfig

Allowlist for the global shortcut APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all global shortcut API features.

OsAllowlistConfig

Allowlist for the OS APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all OS API features.

PathAllowlistConfig

Allowlist for the path APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all path API features.

ProtocolAllowlistConfig

Allowlist for the custom protocols.

Type: object

Name	Type	Default	Description
`assetScope`	`FsAllowlistScope`	[]	The access scope for the asset protocol.
`all`	boolean	`false`	Use this flag to enable all custom protocols.
`asset`	boolean	`false`	Enables the asset protocol.

ProcessAllowlistConfig

Allowlist for the process APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all process APIs.
`relaunch`	boolean	`false`	Enables the relaunch API.
`relaunchDangerousAllowSymlinkMacos`	boolean	`false`	Dangerous option that allows macOS to relaunch even if the binary contains a symlink. This 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.
`exit`	boolean	`false`	Enables the exit API.

ClipboardAllowlistConfig

Allowlist for the clipboard APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all clipboard APIs.
`writeText`	boolean	`false`	Enables the clipboard's `writeText` API.
`readText`	boolean	`false`	Enables the clipboard's `readText` API.

AppAllowlistConfig

Allowlist for the app APIs.

Type: object

Name	Type	Default	Description
`all`	boolean	`false`	Use this flag to enable all app APIs.
`show`	boolean	`false`	Enables the app's `show` API.
`hide`	boolean	`false`	Enables the app's `hide` API.

SecurityConfig

Security configuration.

Type: object

Name	Type	Default	Description
`csp`	`Csp`?	view	The Content Security Policy that will be injected on all HTML files on the built application. If `dev_csp` is not specified, this value is also injected on dev. This 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.
`devCsp`	`Csp`?	view	The Content Security Policy that will be injected on all HTML files on development. This 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.
`freezePrototype`	boolean	`false`	Freeze the `Object.prototype` when using the custom protocol.
`dangerousDisableAssetCspModification`	`DisabledCspModificationKind`	`false`	Disables the Tauri-injected CSP sources. At 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. This 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. 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.
`dangerousRemoteDomainIpcAccess`	`RemoteDomainAccessScope`	[]	Allow external domains to send command to Tauri. By default, external domains do not have access to `window.__TAURI__`, which means they cannot communicate with the commands defined in Rust. This prevents attacks where an externally loaded malicious or compromised sites could start executing commands on the user's device. This configuration allows a set of external domains to have access to the Tauri commands. When you configure a domain to be allowed to access the IPC, all subpaths are allowed. Subdomains are not allowed. WARNING: Only use this option if you either have internal checks against malicious external sites or you can trust the allowed external sites. You application might be vulnerable to dangerous Tauri command related attacks otherwise.
`dangerousUseHttpScheme`	boolean	`false`	Sets whether the custom protocols should use `http://<scheme>.localhost` instead of the default `https://<scheme>.localhost` on Windows. WARNING: Using a `http` scheme will allow mixed content when trying to fetch `http` endpoints and is therefore less secure but will match the behavior of the `<scheme>://localhost` protocols used on macOS and Linux.

Csp

A Content-Security-Policy definition. See https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP.

Can be any of the following types:

string: The entire CSP policy in a single text string.
CspDirectiveSources: An object mapping a directive with its sources values as a list of strings.

CspDirectiveSources

A Content-Security-Policy directive source list. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources.

Can be any of the following types:

string: An inline list of CSP sources. Same as List, but concatenated with a space separator.
string[]: A list of CSP sources. The collection will be concatenated with a space separator for the CSP string.

DisabledCspModificationKind

The possible values for the dangerous_disable_asset_csp_modification config option.

Can be any of the following types:

boolean: If true, disables all CSP modification. false is the default value and it configures Tauri to control the CSP.
string[]: Disables the given list of CSP directives modifications.

RemoteDomainAccessScope

External command access definition.

Type: object

Name	Type	Default	Description
`scheme`	string?	null	The URL scheme to allow. By default, all schemas are allowed.
`domain`	string (required)		The domain to allow.
`windows`	string[] (required)		The list of window labels this scope applies to.
`plugins`	string[]	[]	The list of plugins that are allowed in this scope. The names should be without the `tauri-plugin-` prefix, for example `"store"` for `tauri-plugin-store`.
`enableTauriAPI`	boolean	`false`	Enables access to the Tauri API.

UpdaterConfig

The Updater configuration object.

Type: object

Name	Type	Default	Description
`active`	boolean	`false`	Whether the updater is active or not.
`dialog`	boolean	`true`	Display built-in dialog or use event system if disabled.
`endpoints`	`UpdaterEndpoint`?	null	The updater endpoints. TLS is enforced on production. The 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`). # 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.
`pubkey`	string	null	Signature public key.
`windows`	`UpdaterWindowsConfig`	view	The Windows configuration for the updater.

UpdaterEndpoint

A URL to an updater server.

The URL must use the https scheme on production.

Type: string (format: uri)

UpdaterWindowsConfig

The updater configuration for Windows.

Type: object

Name	Type	Default	Description
`installerArgs`	string[]	[]	Additional arguments given to the NSIS or WiX installer.
`installMode`	`WindowsUpdateInstallMode`	view	The installation mode for the update on Windows. Defaults to `passive`.

WindowsUpdateInstallMode

Install modes for the Windows update.

Can be any ONE of the following types:

"basicUi": Specifies there's a basic UI during the installation process, including a final dialog box at the end.
"quiet": The quiet mode means there's no user interaction required. Requires admin privileges if the installer does.
"passive": Specifies unattended mode, which means the installation only shows a progress bar.

SystemTrayConfig

Configuration for application system tray icon.

Type: object

Name	Type	Default	Description
`iconPath`	string (required)		Path to the default icon to use on the system tray.
`iconAsTemplate`	boolean	`false`	A Boolean value that determines whether the image represents a template image on macOS.
`menuOnLeftClick`	boolean	`true`	A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS.
`title`	string?	null	Title for MacOS tray

BuildConfig

The Build configuration object.

Type: object

Name	Type	Default	Description
`runner`	string?	null	The binary used to build and run the application.
`devPath`	`AppUrl`	view	The path to the application assets or URL to load in development. This 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. See vite, Webpack DevServer and sirv for examples on how to set up a dev server.
`distDir`	`AppUrl`	view	The path to the application assets or URL to load in production. When 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. You 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. When an URL is provided, the application won't have bundled assets and the application will load that URL by default.
`beforeDevCommand`	`BeforeDevCommand`?	view	A shell command to run before `tauri dev` kicks in. The TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.
`beforeBuildCommand`	`HookCommand`?	view	A shell command to run before `tauri build` kicks in. The TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.
`beforeBundleCommand`	`HookCommand`?	view	A shell command to run before the bundling phase in `tauri build` kicks in. The TAURI_PLATFORM, TAURI_ARCH, TAURI_FAMILY, TAURI_PLATFORM_VERSION, TAURI_PLATFORM_TYPE and TAURI_DEBUG environment variables are set if you perform conditional compilation.
`features`	array?	null	Features passed to `cargo` commands.
`withGlobalTauri`	boolean	`false`	Whether we should inject the Tauri API on `window.__TAURI__` or not.

AppUrl

Defines the URL or assets to embed in the application.

Can be any of the following types:

WindowUrl: The app's external URL, or the path to the directory containing the app assets.
string[]: An array of files to embed on the app.

BeforeDevCommand

Describes the shell command to run before tauri dev.

Can be any of the following types:

string: Run the given script with the default options.

{ "script": string, "cwd": string?, "wait": boolean }: Run the given script with custom options.

Name	Type	Default	Description
`script`	string (required)		The script to execute.
`cwd`	string?	null	The current working directory.
`wait`	boolean	`false`	Whether `tauri dev` should wait for the command to finish or not. Defaults to `false`.

HookCommand

Describes a shell command to be executed when a CLI hook is triggered.

Can be any of the following types:

string: Run the given script with the default options.
{ "script": string, "cwd": string? }: Run the given script with custom options.

Name Type Default Description

script
string (required) The script to execute.

cwd
string? null The current working directory.

PluginConfig

The plugin configs holds a HashMap mapping a plugin name to its configuration object.

Type: object

106 KiB Raw Permalink Blame History Unescape Escape

Configuration

File Formats

Platform-Specific Configuration

Configuration Structure

PackageConfig

TauriConfig

PatternKind

WindowConfig

WindowUrl

Theme

TitleBarStyle

CliConfig

CliArg

BundleConfig

BundleTarget

BundleType

BundleResources

AppImageConfig

DebConfig

RpmConfig

DmgConfig

Position

Size

MacConfig

WindowsConfig

WebviewInstallMode

WixConfig

WixLanguage

WixLanguageConfig

NsisConfig

NSISInstallerMode

NsisCompression

AllowlistConfig

Notes

Examples

FsAllowlistConfig

FsAllowlistScope

WindowAllowlistConfig

ShellAllowlistConfig

ShellAllowlistScope

ShellAllowedCommand

ShellAllowedArgs

ShellAllowedArg

ShellAllowlistOpen

DialogAllowlistConfig

HttpAllowlistConfig

HttpAllowlistScope

NotificationAllowlistConfig

GlobalShortcutAllowlistConfig

OsAllowlistConfig

PathAllowlistConfig

ProtocolAllowlistConfig

ProcessAllowlistConfig

ClipboardAllowlistConfig

AppAllowlistConfig

SecurityConfig

Csp

CspDirectiveSources

DisabledCspModificationKind

RemoteDomainAccessScope

UpdaterConfig

UpdaterEndpoint

UpdaterWindowsConfig

WindowsUpdateInstallMode

SystemTrayConfig

BuildConfig

AppUrl

BeforeDevCommand

HookCommand

PluginConfig

106 KiB

Raw Permalink Blame History