You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/api/config.md
+7-4Lines changed: 7 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -29,7 +29,9 @@ The configuration is composed of the following objects:
29
29
-[`build`](#buildconfig): The build configuration
30
30
-[`plugins`](#pluginconfig): The plugins config
31
31
32
-
```json title="Example tauri.config.json file"
32
+
Example tauri.config.json file:
33
+
34
+
```json
33
35
{
34
36
"build": {
35
37
"beforeBuildCommand": "",
@@ -204,7 +206,7 @@ Can be any **ONE** of the following types:
204
206
- "Overlay": Shows the title bar as a transparent overlay over the window's content.
205
207
206
208
Keep in mind:
207
-
- 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.
209
+
- 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.
208
210
- 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>.
209
211
- The color of the window title depends on the system theme.
210
212
@@ -267,7 +269,7 @@ Type: `object`
267
269
| ---- | ---- | ------- | ----------- |
268
270
| <divclassName="anchor-with-padding"id="bundleconfig.active">`active`<aclass="hash-link"href="#bundleconfig.active"></a></div> | boolean |`false`| Whether Tauri should bundle your application or just output the executable. |
269
271
| <divclassName="anchor-with-padding"id="bundleconfig.targets">`targets`<aclass="hash-link"href="#bundleconfig.targets"></a></div> |[`BundleTarget`](#bundletarget)|[view](#bundletarget)| The bundle targets, currently supports ["deb", "rpm", "appimage", "nsis", "msi", "app", "dmg", "updater"] or "all". |
270
-
| <divclassName="anchor-with-padding"id="bundleconfig.identifier">`identifier`<aclass="hash-link"href="#bundleconfig.identifier"></a></div> | 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 (.). |
272
+
| <divclassName="anchor-with-padding"id="bundleconfig.identifier">`identifier`<aclass="hash-link"href="#bundleconfig.identifier"></a></div> | 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 (.). |
271
273
| <divclassName="anchor-with-padding"id="bundleconfig.publisher">`publisher`<aclass="hash-link"href="#bundleconfig.publisher"></a></div> | 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. |
272
274
| <divclassName="anchor-with-padding"id="bundleconfig.icon">`icon`<aclass="hash-link"href="#bundleconfig.icon"></a></div> | string[]|[]| The app's icons |
273
275
| <divclassName="anchor-with-padding"id="bundleconfig.resources">`resources`<aclass="hash-link"href="#bundleconfig.resources"></a></div> |[`BundleResources`](#bundleresources)? |[view](#bundleresources)| App resources to bundle. Each resource is a path to a file or directory. Glob patterns are supported. |
@@ -361,7 +363,7 @@ Type: `object`
361
363
| <divclassName="anchor-with-padding"id="rpmconfig.depends">`depends`<aclass="hash-link"href="#rpmconfig.depends"></a></div> | array? |_null_| The list of RPM dependencies your application relies on. |
362
364
| <divclassName="anchor-with-padding"id="rpmconfig.provides">`provides`<aclass="hash-link"href="#rpmconfig.provides"></a></div> | array? |_null_| The list of RPM dependencies your application provides. |
363
365
| <divclassName="anchor-with-padding"id="rpmconfig.conflicts">`conflicts`<aclass="hash-link"href="#rpmconfig.conflicts"></a></div> | array? |_null_| The list of RPM dependencies your application conflicts with. They must not be present in order for the package to be installed. |
364
-
| <divclassName="anchor-with-padding"id="rpmconfig.obsoletes">`obsoletes`<aclass="hash-link"href="#rpmconfig.obsoletes"></a></div> | array? |_null_| The list of RPM dependencies your application supersedes<br />- if this package is installed, packages listed as “obsoletes” will be automatically removed (if they are present). |
366
+
| <divclassName="anchor-with-padding"id="rpmconfig.obsoletes">`obsoletes`<aclass="hash-link"href="#rpmconfig.obsoletes"></a></div> | array? |_null_| The list of RPM dependencies your application supersedes<br />- if this package is installed, packages listed as "obsoletes" will be automatically removed (if they are present). |
365
367
| <divclassName="anchor-with-padding"id="rpmconfig.release">`release`<aclass="hash-link"href="#rpmconfig.release"></a></div> | string |_null_| The RPM release tag. |
366
368
| <divclassName="anchor-with-padding"id="rpmconfig.epoch">`epoch`<aclass="hash-link"href="#rpmconfig.epoch"></a></div> | integer _(format: `uint32`)_|`0`| The RPM epoch. |
367
369
| <divclassName="anchor-with-padding"id="rpmconfig.files">`files`<aclass="hash-link"href="#rpmconfig.files"></a></div> | object |_null_| The files to include on the package. |
@@ -420,6 +422,7 @@ Type: `object`
420
422
| <divclassName="anchor-with-padding"id="macconfig.exceptiondomain">`exceptionDomain`<aclass="hash-link"href="#macconfig.exceptiondomain"></a></div> | string? |_null_| Allows your application to communicate with the outside world. It should be a lowercase, without port and protocol domain name. |
421
423
| <divclassName="anchor-with-padding"id="macconfig.license">`license`<aclass="hash-link"href="#macconfig.license"></a></div> | string? |_null_| The path to the license file to add to the DMG bundle. |
422
424
| <divclassName="anchor-with-padding"id="macconfig.signingidentity">`signingIdentity`<aclass="hash-link"href="#macconfig.signingidentity"></a></div> | string? |_null_| Identity to use for code signing. |
425
+
| <divclassName="anchor-with-padding"id="macconfig.hardenedruntime">`hardenedRuntime`<aclass="hash-link"href="#macconfig.hardenedruntime"></a></div> | boolean |`true`| Whether the codesign should enable [hardened runtime](https://developer.apple.com/documentation/security/hardened_runtime) (for executables) or not. |
423
426
| <divclassName="anchor-with-padding"id="macconfig.providershortname">`providerShortName`<aclass="hash-link"href="#macconfig.providershortname"></a></div> | string? |_null_| Provider short name for notarization. |
424
427
| <divclassName="anchor-with-padding"id="macconfig.entitlements">`entitlements`<aclass="hash-link"href="#macconfig.entitlements"></a></div> | string? |_null_| Path to the entitlements file. |
0 commit comments