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 settingstauri
: The Tauri configbuild
: The build configurationplugins
: The plugins config
{
"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 |
---|---|---|---|
PackageConfig | view | Package settings. | |
TauriConfig | view | The Tauri configuration. | |
BuildConfig | view | The build configuration. | |
PluginConfig | view | The plugins config. |
PackageConfigβ
The package configuration.
Type: object
Name | Type | Default | Description |
---|---|---|---|
string? | null | App name. | |
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 |
---|---|---|---|
PatternKind | view | The pattern to use. | |
WindowConfig | [] | The windows configuration. | |
CliConfig ? | view | The CLI configuration. | |
BundleConfig | view | The bundler configuration. | |
AllowlistConfig | view | The allowlist configuration. | |
SecurityConfig | view | Security configuration. | |
UpdaterConfig | view | The updater configuration. | |
SystemTrayConfig ? | view | Configuration for app system tray. | |
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 "brownfield" (required) undefined
{ "use": "isolation", "options": { "dir": string } }
: Isolation pattern. Recommended for security purposes.Name Type Default Description "isolation" (required) undefined { "dir": string } (required) undefined
WindowConfigβ
The window configuration object.
Type: object
Name | Type | Default | Description |
---|---|---|---|
string | null | The window identifier. It must be alphanumeric. | |
WindowUrl | view | The window webview URL. | |
string? | null | The user agent for the webview | |
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. | |
boolean | false | Whether or not the window starts centered or not. | |
number? (format: double ) | null | The horizontal position of the window's top left corner | |
number? (format: double ) | null | The vertical position of the window's top left corner | |
number (format: double ) | 800 | The window width. | |
number (format: double ) | 600 | The window height. | |
number? (format: double ) | null | The min window width. | |
number? (format: double ) | null | The min window height. | |
number? (format: double ) | null | The max window width. | |
number? (format: double ) | null | The max window height. | |
boolean | true | Whether the window is resizable or not. When resizable is set to false, native window's maximize button is automatically disabled. | |
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. | |
boolean | true | Whether the window's native minimize button is enabled or not. ## Platform-specific - Linux / iOS / Android: Unsupported. | |
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. | |
string | null | The window title. | |
boolean | false | Whether the window starts as fullscreen or not. | |
boolean | true | Whether the window will be initially focused or not. | |
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 . | |
boolean | false | Whether the window is maximized or not. | |
boolean | true | Whether the window is visible or not. | |
boolean | true | Whether the window should have borders and bars. | |
boolean | false | Whether the window should always be on top of other windows. | |
boolean | false | Prevents the window contents from being captured by other apps. | |
boolean | false | If true , hides the window icon from the taskbar on Windows and Linux. | |
Theme ? | view | The initial window theme. Defaults to the system theme. Only implemented on Windows and macOS 10.14+. | |
TitleBarStyle | view | The style of the macOS title bar. | |
boolean | false | If true , sets the window title to be hidden on macOS. | |
boolean | false | Whether clicking an inactive window also clicks through to the webview on macOS. | |
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. | |
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 loadtauri://localhost/users/john
, you can simply provideusers/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 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.
CliConfigβ
describes a CLI configuration
Type: object
Name | Type | Default | Description |
---|---|---|---|
string? | null | Command description which will be shown on the help information. | |
string? | null | Command long description which will be shown on the help information. | |
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. | |
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. | |
CliArg ? | null | List of arguments for the command | |
CliConfig ? | null | List of subcommands of this command |
CliArgβ
A CLI argument definition.
Type: object
Name | Type | Default | Description |
---|---|---|---|
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. | |
string (required) | The unique argument name | ||
string? | null | The argument description which will be shown on the help information. Typically, this is a short (one line) description of the arg. | |
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. | |
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 | |
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. | |
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. | |
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 . | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
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. | |
string? | null | Sets a conflicting argument by name i.e. when using this argument, the following argument can't be present and vice versa. | |
array? | null | The same as conflictsWith but allows specifying multiple two-way conflicts per argument. | |
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. | |
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. | |
array? | null | Allows a conditional requirement with the signature [arg, value] the requirement will only become valid if arg 's value equals ${value} . | |
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} . | |
boolean? | null | Requires that options use the --option=val syntax i.e. an equals between the option and associated value. | |
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 |
---|---|---|---|
boolean | false | Whether Tauri should bundle your application or just output the executable. | |
BundleTarget | view | The bundle targets, currently supports ["deb", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all". | |
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 (.). | ||
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. | |
string[] | [] | The app's icons | |
BundleResources ? | view | App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported. | |
string? | null | A copyright string associated with your application. | |
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. | |
string? | null | A short description of your application. | |
string? | null | A longer, multi-line description of the application. | |
AppImageConfig | view | Configuration for the AppImage bundle. | |
DebConfig | view | Configuration for the Debian bundle. | |
MacConfig | view | Configuration for the macOS bundles. | |
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. | |
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).
- "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 |
---|---|---|---|
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 |
---|---|---|---|
array? | null | The list of deb dependencies your application relies on. | |
object | null | The files to include on the package. | |
string? | null | Path to a custom desktop file Handlebars template. Available variables: categories , comment (optional), exec , icon and name . | |
string? | null | Define the section in Debian Control file. See : https://www.debian.org/doc/debian-policy/ch-archive.html#s-subsections | |
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 | |
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 |
MacConfigβ
Configuration for the macOS bundles.
Type: object
Name | Type | Default | Description |
---|---|---|---|
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. | |
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. | |
string? | null | Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name. | |
string? | null | The path to the license file to add to the DMG bundle. | |
string? | null | Identity to use for code signing. | |
string? | null | Provider short name for notarization. | |
string? | null | Path to the entitlements file. |
WindowsConfigβ
Windows bundler configuration.
Type: object
Name | Type | Default | Description |
---|---|---|---|
string? | null | Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended. | |
string? | null | Specifies the SHA1 hash of the signing certificate. | |
string? | null | Server to use during timestamping. | |
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 | view | The installation mode for the Webview2 runtime. | |
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. | |
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 . | |
WixConfig ? | view | Configuration for the MSI generated with WiX. | |
NsisConfig ? | view | Configuration for the installer generated with NSIS. |
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 "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 "downloadBootstrapper" (required) undefined 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 "embedBootstrapper" (required) undefined 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 "offlineInstaller" (required) undefined 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 "fixedRuntime" (required) undefined 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 |
---|---|---|---|
WixLanguage | view | The installer languages to build. See https://docs.microsoft.com/en-us/windows/win32/msi/localizing-the-error-and-actiontext-tables. | |
string? | null | A custom .wxs template to use. | |
string[] | [] | A list of paths to .wxs files with WiX fragments to use. | |
string[] | [] | The ComponentGroup element ids you want to reference from the fragments. | |
string[] | [] | The Component element ids you want to reference from the fragments. | |
string[] | [] | The FeatureGroup element ids you want to reference from the fragments. | |
string[] | [] | The Feature element ids you want to reference from the fragments. | |
string[] | [] | The Merge element ids you want to reference from the fragments. | |
boolean | false | Disables the Webview2 runtime installation after app install. Will be removed in v2, prefer the [ WindowsConfig::webview_install_mode ] option. | |
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. | |
boolean | false | Create an elevated update task within Windows Task Scheduler. | |
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. | |
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 |
---|---|---|---|
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 |
---|---|---|---|
string? | null | A custom .nsi template to use. | |
string? | null | The path to the license file to render on the installer. | |
string? | null | The path to a bitmap file to display on the header of installers pages. The recommended dimensions are 150px x 57px. | |
string? | null | The path to a bitmap file for the Welcome page and the Finish page. The recommended dimensions are 164px x 314px. | |
string? | null | The path to an icon file used as the installer icon. | |
NSISInstallerMode | view | Whether the installation will be for all users or just the current user. | |
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. | |
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, | |
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. | |
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
orHKCU
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 whetherhide
is set tofalse
ortrue
in the allowlist.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all API features. | |
FsAllowlistConfig | view | File system API allowlist. | |
WindowAllowlistConfig | view | Window API allowlist. | |
ShellAllowlistConfig | view | Shell API allowlist. | |
DialogAllowlistConfig | view | Dialog API allowlist. | |
HttpAllowlistConfig | view | HTTP API allowlist. | |
NotificationAllowlistConfig | view | Notification API allowlist. | |
GlobalShortcutAllowlistConfig | view | Global shortcut API allowlist. | |
OsAllowlistConfig | view | OS allowlist. | |
PathAllowlistConfig | view | Path API allowlist. | |
ProtocolAllowlistConfig | view | Custom protocol allowlist. | |
ProcessAllowlistConfig | view | Process API allowlist. | |
ClipboardAllowlistConfig | view | Clipboard APIs allowlist. | |
AppAllowlistConfig | view | App APIs allowlist. |
FsAllowlistConfigβ
Allowlist for the file system APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
FsAllowlistScope | [] | The access scope for the filesystem APIs. | |
boolean | false | Use this flag to enable all file system API features. | |
boolean | false | Read file from local filesystem. | |
boolean | false | Write file to local filesystem. | |
boolean | false | Read directory from local filesystem. | |
boolean | false | Copy file from local filesystem. | |
boolean | false | Create directory from local filesystem. | |
boolean | false | Remove directory from local filesystem. | |
boolean | false | Remove file from local filesystem. | |
boolean | false | Rename file from local filesystem. | |
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 string[] [] A list of paths that are allowed by this scope. string[] [] A list of paths that are not allowed by this scope. This gets precedence over the Scope::allow
list.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 totrue
on Unix systems andfalse
on Windows
WindowAllowlistConfigβ
Allowlist for the window APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all window API features. | |
boolean | false | Allows dynamic window creation. | |
boolean | false | Allows centering the window. | |
boolean | false | Allows requesting user attention on the window. | |
boolean | false | Allows setting the resizable flag of the window. | |
boolean | false | Allows setting whether the window's native maximize button is enabled or not. | |
boolean | false | Allows setting whether the window's native minimize button is enabled or not. | |
boolean | false | Allows setting whether the window's native close button is enabled or not. | |
boolean | false | Allows changing the window title. | |
boolean | false | Allows maximizing the window. | |
boolean | false | Allows unmaximizing the window. | |
boolean | false | Allows minimizing the window. | |
boolean | false | Allows unminimizing the window. | |
boolean | false | Allows showing the window. | |
boolean | false | Allows hiding the window. | |
boolean | false | Allows closing the window. | |
boolean | false | Allows setting the decorations flag of the window. | |
boolean | false | Allows setting the always_on_top flag of the window. | |
boolean | false | Allows preventing the window contents from being captured by other apps. | |
boolean | false | Allows setting the window size. | |
boolean | false | Allows setting the window minimum size. | |
boolean | false | Allows setting the window maximum size. | |
boolean | false | Allows changing the position of the window. | |
boolean | false | Allows setting the fullscreen flag of the window. | |
boolean | false | Allows focusing the window. | |
boolean | false | Allows changing the window icon. | |
boolean | false | Allows setting the skip_taskbar flag of the window. | |
boolean | false | Allows grabbing the cursor. | |
boolean | false | Allows setting the cursor visibility. | |
boolean | false | Allows changing the cursor icon. | |
boolean | false | Allows setting the cursor position. | |
boolean | false | Allows ignoring cursor events. | |
boolean | false | Allows start dragging on the window. | |
boolean | false | Allows opening the system dialog to print the window content. |
ShellAllowlistConfigβ
Allowlist for the shell APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
ShellAllowlistScope | [] | Access scope for the binary execution APIs. Sidecars are automatically enabled. | |
boolean | false | Use this flag to enable all shell API features. | |
boolean | false | Enable binary execution. | |
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. | |
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 |
---|---|---|---|
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. | ||
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 . | |
ShellAllowedArgs | false | The allowed arguments for the command execution. | |
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 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 thevalidator
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 |
---|---|---|---|
boolean | false | Use this flag to enable all dialog API features. | |
boolean | false | Allows the API to open a dialog window to pick files. | |
boolean | false | Allows the API to open a dialog window to pick where to save files. | |
boolean | false | Allows the API to show a message dialog window. | |
boolean | false | Allows the API to show a dialog window with Yes/No buttons. | |
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 |
---|---|---|---|
HttpAllowlistScope | [] | The access scope for the HTTP APIs. | |
boolean | false | Use this flag to enable all HTTP API features. | |
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 |
---|---|---|---|
boolean | false | Use this flag to enable all notification API features. |
GlobalShortcutAllowlistConfigβ
Allowlist for the global shortcut APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all global shortcut API features. |
OsAllowlistConfigβ
Allowlist for the OS APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all OS API features. |
PathAllowlistConfigβ
Allowlist for the path APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all path API features. |
ProtocolAllowlistConfigβ
Allowlist for the custom protocols.
Type: object
Name | Type | Default | Description |
---|---|---|---|
FsAllowlistScope | [] | The access scope for the asset protocol. | |
boolean | false | Use this flag to enable all custom protocols. | |
boolean | false | Enables the asset protocol. |
ProcessAllowlistConfigβ
Allowlist for the process APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all process APIs. | |
boolean | false | Enables the relaunch API. | |
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. | |
boolean | false | Enables the exit API. |
ClipboardAllowlistConfigβ
Allowlist for the clipboard APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all clipboard APIs. | |
boolean | false | Enables the clipboard's writeText API. | |
boolean | false | Enables the clipboard's readText API. |
AppAllowlistConfigβ
Allowlist for the app APIs.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Use this flag to enable all app APIs. | |
boolean | false | Enables the app's show API. | |
boolean | false | Enables the app's hide API. |
SecurityConfigβ
Security configuration.
Type: object
Name | Type | Default | Description |
---|---|---|---|
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. | |
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. | |
boolean | false | Freeze the Object.prototype when using the custom protocol. | |
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. | |
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. | |
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 asList
, 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
: Iftrue
, 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 |
---|---|---|---|
string? | null | The URL scheme to allow. By default, all schemas are allowed. | |
string (required) | The domain to allow. | ||
string[] (required) | The list of window labels this scope applies to. | ||
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 . | |
boolean | false | Enables access to the Tauri API. |
UpdaterConfigβ
The Updater configuration object.
Type: object
Name | Type | Default | Description |
---|---|---|---|
boolean | false | Whether the updater is active or not. | |
boolean | true | Display built-in dialog or use event system if disabled. | |
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. | |
string | null | Signature public key. | |
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 |
---|---|---|---|
string[] | [] | Additional arguments given to the NSIS or WiX installer. | |
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 |
---|---|---|---|
string (required) | Path to the default icon to use on the system tray. | ||
boolean | false | A Boolean value that determines whether the image represents a template image on macOS. | |
boolean | true | A Boolean value that determines whether the menu should appear when the tray icon receives a left click on macOS. | |
string? | null | Title for MacOS tray |
BuildConfigβ
The Build configuration object.
Type: object
Name | Type | Default | Description |
---|---|---|---|
string? | null | The binary used to build and run the application. | |
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. | |
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 ? | 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. | |
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. | |
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. | |
array? | null | Features passed to cargo commands. | |
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 string (required) The script to execute. string? null The current working directory. boolean false
Whether tauri dev
should wait for the command to finish or not. Defaults tofalse
.
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 string (required) The script to execute. string? null The current working directory.
PluginConfigβ
The plugin configs holds a HashMap mapping a plugin name to its configuration object.
Type: object