pub struct Config {
pub schema: Option<String>,
pub package: PackageConfig,
pub tauri: TauriConfig,
pub build: BuildConfig,
pub plugins: PluginConfig,
}
Expand description
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
}
]
}
}
Fields
schema: Option<String>
The JSON schema for the Tauri config.
package: PackageConfig
Package settings.
tauri: TauriConfig
The Tauri configuration.
build: BuildConfig
The build configuration.
plugins: PluginConfig
The plugins config.
Trait Implementations
sourceimpl<'de> Deserialize<'de> for Config
impl<'de> Deserialize<'de> for Config
sourcefn deserialize<__D>(
__deserializer: __D
) -> Result<Config, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
fn deserialize<__D>(
__deserializer: __D
) -> Result<Config, <__D as Deserializer<'de>>::Error>where
__D: Deserializer<'de>,
Deserialize this value from the given Serde deserializer. Read more
sourceimpl PartialEq<Config> for Config
impl PartialEq<Config> for Config
sourceimpl Serialize for Config
impl Serialize for Config
sourcefn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
fn serialize<__S>(
&self,
__serializer: __S
) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where
__S: Serializer,
Serialize this value into the given Serde serializer. Read more
impl StructuralPartialEq for Config
Auto Trait Implementations
impl RefUnwindSafe for Config
impl Send for Config
impl Sync for Config
impl Unpin for Config
impl UnwindSafe for Config
Blanket Implementations
sourceimpl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<'de, D, R> CommandArg<'de, R> for Dwhere
D: Deserialize<'de>,
R: Runtime,
impl<'de, D, R> CommandArg<'de, R> for Dwhere
D: Deserialize<'de>,
R: Runtime,
sourcefn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>
fn from_command(command: CommandItem<'de, R>) -> Result<D, InvokeError>
Derives an instance of Self
from the CommandItem
. Read more