@tauri-apps/cli 2.0.0-beta.20 → 2.0.0-beta.21
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +35 -0
- package/package.json +14 -14
- package/schema.json +205 -146
package/schema.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"$schema": "http://json-schema.org/draft-07/schema#",
|
|
3
3
|
"title": "Config",
|
|
4
|
-
"description": "The Tauri configuration object
|
|
4
|
+
"description": "The Tauri configuration object.\n It is read from a file where you can define your frontend assets,\n configure the bundler and define a tray icon.\n\n The configuration file is generated by the\n [`tauri init`](https://tauri.app/v1/api/cli#init) command that lives in\n your Tauri application source directory (src-tauri).\n\n Once generated, you may modify it at will to customize your Tauri application.\n\n ## File Formats\n\n By default, the configuration is defined as a JSON file named `tauri.conf.json`.\n\n Tauri also supports JSON5 and TOML files via the `config-json5` and `config-toml` Cargo features, respectively.\n The JSON5 file name must be either `tauri.conf.json` or `tauri.conf.json5`.\n The TOML file name is `Tauri.toml`.\n\n ## Platform-Specific Configuration\n\n In addition to the default configuration file, Tauri can\n read a platform-specific configuration from `tauri.linux.conf.json`,\n `tauri.windows.conf.json`, `tauri.macos.conf.json`, `tauri.android.conf.json` and `tauri.ios.conf.json`\n (or `Tauri.linux.toml`, `Tauri.windows.toml`, `Tauri.macos.toml`, `Tauri.android.toml` and `Tauri.ios.toml` if the `Tauri.toml` format is used),\n which gets merged with the main configuration object.\n\n ## Configuration Structure\n\n The configuration is composed of the following objects:\n\n - [`app`](#appconfig): The Tauri configuration\n - [`build`](#buildconfig): The build configuration\n - [`bundle`](#bundleconfig): The bundle configurations\n - [`plugins`](#pluginconfig): The plugins configuration\n\n ```json title=\"Example tauri.config.json file\"\n {\n \"productName\": \"tauri-app\",\n \"version\": \"0.1.0\"\n \"build\": {\n \"beforeBuildCommand\": \"\",\n \"beforeDevCommand\": \"\",\n \"devUrl\": \"../dist\",\n \"frontendDist\": \"../dist\"\n },\n \"app\": {\n \"security\": {\n \"csp\": null\n },\n \"windows\": [\n {\n \"fullscreen\": false,\n \"height\": 600,\n \"resizable\": true,\n \"title\": \"Tauri App\",\n \"width\": 800\n }\n ]\n },\n \"bundle\": {},\n \"plugins\": {}\n }\n ```",
|
|
5
5
|
"type": "object",
|
|
6
6
|
"properties": {
|
|
7
7
|
"$schema": {
|
|
@@ -20,14 +20,14 @@
|
|
|
20
20
|
"pattern": "^[^/\\:*?\"<>|]+$"
|
|
21
21
|
},
|
|
22
22
|
"version": {
|
|
23
|
-
"description": "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.\n\
|
|
23
|
+
"description": "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.\n\n By default version 1.0 is used on Android.",
|
|
24
24
|
"type": [
|
|
25
25
|
"string",
|
|
26
26
|
"null"
|
|
27
27
|
]
|
|
28
28
|
},
|
|
29
29
|
"identifier": {
|
|
30
|
-
"description": "The application identifier in reverse domain name notation (e.g. `com.tauri.example`)
|
|
30
|
+
"description": "The application identifier in reverse domain name notation (e.g. `com.tauri.example`).\n This string must be unique across applications since it is used in system configurations like\n the bundle ID and path to the webview data directory.\n This string must contain only alphanumeric characters (A–Z, a–z, and 0–9), hyphens (-),\n and periods (.).",
|
|
31
31
|
"default": "",
|
|
32
32
|
"type": "string"
|
|
33
33
|
},
|
|
@@ -72,6 +72,7 @@
|
|
|
72
72
|
"android": {
|
|
73
73
|
"minSdkVersion": 24
|
|
74
74
|
},
|
|
75
|
+
"createUpdaterArtifacts": false,
|
|
75
76
|
"iOS": {},
|
|
76
77
|
"icon": [],
|
|
77
78
|
"linux": {
|
|
@@ -104,6 +105,7 @@
|
|
|
104
105
|
}
|
|
105
106
|
},
|
|
106
107
|
"files": {},
|
|
108
|
+
"hardenedRuntime": true,
|
|
107
109
|
"minimumSystemVersion": "10.13"
|
|
108
110
|
},
|
|
109
111
|
"targets": "all",
|
|
@@ -142,7 +144,7 @@
|
|
|
142
144
|
"additionalProperties": false,
|
|
143
145
|
"definitions": {
|
|
144
146
|
"AppConfig": {
|
|
145
|
-
"description": "The App configuration object.\n\
|
|
147
|
+
"description": "The App configuration object.\n\n See more: <https://tauri.app/v1/api/config#appconfig>",
|
|
146
148
|
"type": "object",
|
|
147
149
|
"properties": {
|
|
148
150
|
"windows": {
|
|
@@ -198,7 +200,7 @@
|
|
|
198
200
|
"additionalProperties": false
|
|
199
201
|
},
|
|
200
202
|
"WindowConfig": {
|
|
201
|
-
"description": "The window configuration object.\n\
|
|
203
|
+
"description": "The window configuration object.\n\n See more: <https://tauri.app/v1/api/config#windowconfig>",
|
|
202
204
|
"type": "object",
|
|
203
205
|
"properties": {
|
|
204
206
|
"label": {
|
|
@@ -223,7 +225,7 @@
|
|
|
223
225
|
]
|
|
224
226
|
},
|
|
225
227
|
"dragDropEnabled": {
|
|
226
|
-
"description": "Whether the drag and drop is enabled or not on the webview. By default it is enabled.\n\
|
|
228
|
+
"description": "Whether the drag and drop is enabled or not on the webview. By default it is enabled.\n\n Disabling it is required to use HTML5 drag and drop on the frontend on Windows.",
|
|
227
229
|
"default": true,
|
|
228
230
|
"type": "boolean"
|
|
229
231
|
},
|
|
@@ -298,17 +300,17 @@
|
|
|
298
300
|
"type": "boolean"
|
|
299
301
|
},
|
|
300
302
|
"maximizable": {
|
|
301
|
-
"description": "Whether the window's native maximize button is enabled or not
|
|
303
|
+
"description": "Whether the window's native maximize button is enabled or not.\n If resizable is set to false, this setting is ignored.\n\n ## Platform-specific\n\n - **macOS:** Disables the \"zoom\" button in the window titlebar, which is also used to enter fullscreen mode.\n - **Linux / iOS / Android:** Unsupported.",
|
|
302
304
|
"default": true,
|
|
303
305
|
"type": "boolean"
|
|
304
306
|
},
|
|
305
307
|
"minimizable": {
|
|
306
|
-
"description": "Whether the window's native minimize button is enabled or not.\n\n## Platform-specific\n\n- **Linux / iOS / Android:** Unsupported.",
|
|
308
|
+
"description": "Whether the window's native minimize button is enabled or not.\n\n ## Platform-specific\n\n - **Linux / iOS / Android:** Unsupported.",
|
|
307
309
|
"default": true,
|
|
308
310
|
"type": "boolean"
|
|
309
311
|
},
|
|
310
312
|
"closable": {
|
|
311
|
-
"description": "Whether the window's native close button is enabled or not.\n\n## Platform-specific\n\n- **Linux:** \"GTK+ will do its best to convince the window manager not to show a close button
|
|
313
|
+
"description": "Whether the window's native close button is enabled or not.\n\n ## Platform-specific\n\n - **Linux:** \"GTK+ will do its best to convince the window manager not to show a close button.\n Depending on the system, this function may not have any effect when called on a window that is already visible\"\n - **iOS / Android:** Unsupported.",
|
|
312
314
|
"default": true,
|
|
313
315
|
"type": "boolean"
|
|
314
316
|
},
|
|
@@ -328,7 +330,7 @@
|
|
|
328
330
|
"type": "boolean"
|
|
329
331
|
},
|
|
330
332
|
"transparent": {
|
|
331
|
-
"description": "Whether the window is transparent or not.\n\
|
|
333
|
+
"description": "Whether the window is transparent or not.\n\n Note that on `macOS` this requires the `macos-private-api` feature flag, enabled under `tauri > macOSPrivateApi`.\n WARNING: Using private APIs on `macOS` prevents your application from being accepted to the `App Store`.",
|
|
332
334
|
"default": false,
|
|
333
335
|
"type": "boolean"
|
|
334
336
|
},
|
|
@@ -358,7 +360,7 @@
|
|
|
358
360
|
"type": "boolean"
|
|
359
361
|
},
|
|
360
362
|
"visibleOnAllWorkspaces": {
|
|
361
|
-
"description": "Whether the window should be visible on all workspaces or virtual desktops.\n\n## Platform-specific\n\n- **Windows / iOS / Android:** Unsupported.",
|
|
363
|
+
"description": "Whether the window should be visible on all workspaces or virtual desktops.\n\n ## Platform-specific\n\n - **Windows / iOS / Android:** Unsupported.",
|
|
362
364
|
"default": false,
|
|
363
365
|
"type": "boolean"
|
|
364
366
|
},
|
|
@@ -403,26 +405,26 @@
|
|
|
403
405
|
"type": "boolean"
|
|
404
406
|
},
|
|
405
407
|
"tabbingIdentifier": {
|
|
406
|
-
"description": "Defines the window [tabbing identifier] for macOS.\n\
|
|
408
|
+
"description": "Defines the window [tabbing identifier] for macOS.\n\n Windows with matching tabbing identifiers will be grouped together.\n If the tabbing identifier is not set, automatic tabbing will be disabled.\n\n [tabbing identifier]: <https://developer.apple.com/documentation/appkit/nswindow/1644704-tabbingidentifier>",
|
|
407
409
|
"type": [
|
|
408
410
|
"string",
|
|
409
411
|
"null"
|
|
410
412
|
]
|
|
411
413
|
},
|
|
412
414
|
"additionalBrowserArgs": {
|
|
413
|
-
"description": "Defines additional browser arguments on Windows. By default wry passes `--disable-features=msWebOOUI,msPdfOOUI,msSmartScreenProtection
|
|
415
|
+
"description": "Defines additional browser arguments on Windows. By default wry passes `--disable-features=msWebOOUI,msPdfOOUI,msSmartScreenProtection`\n so if you use this method, you also need to disable these components by yourself if you want.",
|
|
414
416
|
"type": [
|
|
415
417
|
"string",
|
|
416
418
|
"null"
|
|
417
419
|
]
|
|
418
420
|
},
|
|
419
421
|
"shadow": {
|
|
420
|
-
"description": "Whether or not the window has shadow.\n\n## Platform-specific\n\n- **Windows
|
|
422
|
+
"description": "Whether or not the window has shadow.\n\n ## Platform-specific\n\n - **Windows:**\n - `false` has no effect on decorated window, shadow are always ON.\n - `true` will make ndecorated window have a 1px white border,\n and on Windows 11, it will have a rounded corners.\n - **Linux:** Unsupported.",
|
|
421
423
|
"default": true,
|
|
422
424
|
"type": "boolean"
|
|
423
425
|
},
|
|
424
426
|
"windowEffects": {
|
|
425
|
-
"description": "Window effects.\n\
|
|
427
|
+
"description": "Window effects.\n\n Requires the window to be transparent.\n\n ## Platform-specific:\n\n - **Windows**: If using decorations or shadows, you may want to try this workaround <https://github.com/tauri-apps/tao/issues/72#issuecomment-975607891>\n - **Linux**: Unsupported",
|
|
426
428
|
"anyOf": [
|
|
427
429
|
{
|
|
428
430
|
"$ref": "#/definitions/WindowEffectsConfig"
|
|
@@ -433,19 +435,19 @@
|
|
|
433
435
|
]
|
|
434
436
|
},
|
|
435
437
|
"incognito": {
|
|
436
|
-
"description": "Whether or not the webview should be launched in incognito mode.\n\n## Platform-specific:\n\n- **Android**: Unsupported.",
|
|
438
|
+
"description": "Whether or not the webview should be launched in incognito mode.\n\n ## Platform-specific:\n\n - **Android**: Unsupported.",
|
|
437
439
|
"default": false,
|
|
438
440
|
"type": "boolean"
|
|
439
441
|
},
|
|
440
442
|
"parent": {
|
|
441
|
-
"description": "Sets the window associated with this label to be the parent of the window to be created.\n\n## Platform-specific\n\n- **Windows**: This sets the passed parent as an owner window to the window to be created
|
|
443
|
+
"description": "Sets the window associated with this label to be the parent of the window to be created.\n\n ## Platform-specific\n\n - **Windows**: This sets the passed parent as an owner window to the window to be created.\n From [MSDN owned windows docs](https://docs.microsoft.com/en-us/windows/win32/winmsg/window-features#owned-windows):\n - An owned window is always above its owner in the z-order.\n - The system automatically destroys an owned window when its owner is destroyed.\n - An owned window is hidden when its owner is minimized.\n - **Linux**: This makes the new window transient for parent, see <https://docs.gtk.org/gtk3/method.Window.set_transient_for.html>\n - **macOS**: This adds the window as a child of parent, see <https://developer.apple.com/documentation/appkit/nswindow/1419152-addchildwindow?language=objc>",
|
|
442
444
|
"type": [
|
|
443
445
|
"string",
|
|
444
446
|
"null"
|
|
445
447
|
]
|
|
446
448
|
},
|
|
447
449
|
"proxyUrl": {
|
|
448
|
-
"description": "The proxy URL for the WebView for all network requests.\n\
|
|
450
|
+
"description": "The proxy URL for the WebView for all network requests.\n\n Must be either a `http://` or a `socks5://` URL.\n\n ## Platform-specific\n\n - **macOS**: Requires the `macos-proxy` feature flag and only compiles for macOS 14+.",
|
|
449
451
|
"type": [
|
|
450
452
|
"string",
|
|
451
453
|
"null"
|
|
@@ -453,7 +455,7 @@
|
|
|
453
455
|
"format": "uri"
|
|
454
456
|
},
|
|
455
457
|
"zoomHotkeysEnabled": {
|
|
456
|
-
"description": "Whether page zooming by hotkeys is enabled\n\n## Platform-specific:\n\n- **Windows**: Controls WebView2's [`IsZoomControlEnabled`](https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2settings?view=webview2-winrt-1.0.2420.47#iszoomcontrolenabled) setting
|
|
458
|
+
"description": "Whether page zooming by hotkeys is enabled\n\n ## Platform-specific:\n\n - **Windows**: Controls WebView2's [`IsZoomControlEnabled`](https://learn.microsoft.com/en-us/microsoft-edge/webview2/reference/winrt/microsoft_web_webview2_core/corewebview2settings?view=webview2-winrt-1.0.2420.47#iszoomcontrolenabled) setting.\n - **MacOS / Linux**: Injects a polyfill that zooms in and out with `ctrl/command` + `-/=`,\n 20% in each step, ranging from 20% to 1000%. Requires `webview:allow-set-webview-zoom` permission\n\n - **Android / iOS**: Unsupported.",
|
|
457
459
|
"default": false,
|
|
458
460
|
"type": "boolean"
|
|
459
461
|
}
|
|
@@ -469,7 +471,7 @@
|
|
|
469
471
|
"format": "uri"
|
|
470
472
|
},
|
|
471
473
|
{
|
|
472
|
-
"description": "The path portion of an app URL
|
|
474
|
+
"description": "The path portion of an app URL.\n For instance, to load `tauri://localhost/users/john`,\n you can simply provide `users/john` in this configuration.",
|
|
473
475
|
"type": "string"
|
|
474
476
|
},
|
|
475
477
|
{
|
|
@@ -509,14 +511,14 @@
|
|
|
509
511
|
]
|
|
510
512
|
},
|
|
511
513
|
{
|
|
512
|
-
"description": "Makes the title bar transparent, so the window background color is shown instead.\n\
|
|
514
|
+
"description": "Makes the title bar transparent, so the window background color is shown instead.\n\n 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.",
|
|
513
515
|
"type": "string",
|
|
514
516
|
"enum": [
|
|
515
517
|
"Transparent"
|
|
516
518
|
]
|
|
517
519
|
},
|
|
518
520
|
{
|
|
519
|
-
"description": "Shows the title bar as a transparent overlay over the window's content.\n\
|
|
521
|
+
"description": "Shows the title bar as a transparent overlay over the window's content.\n\n Keep in mind:\n - 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.\n - 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>.\n - The color of the window title depends on the system theme.",
|
|
520
522
|
"type": "string",
|
|
521
523
|
"enum": [
|
|
522
524
|
"Overlay"
|
|
@@ -532,7 +534,7 @@
|
|
|
532
534
|
],
|
|
533
535
|
"properties": {
|
|
534
536
|
"effects": {
|
|
535
|
-
"description": "List of Window effects to apply to the Window
|
|
537
|
+
"description": "List of Window effects to apply to the Window.\n Conflicting effects will apply the first one and ignore the rest.",
|
|
536
538
|
"type": "array",
|
|
537
539
|
"items": {
|
|
538
540
|
"$ref": "#/definitions/WindowEffect"
|
|
@@ -558,7 +560,7 @@
|
|
|
558
560
|
"format": "double"
|
|
559
561
|
},
|
|
560
562
|
"color": {
|
|
561
|
-
"description": "Window effect color. Affects [`WindowEffect::Blur`] and [`WindowEffect::Acrylic`] only on Windows 10 v1903+. Doesn't have any effect on Windows 7 or Windows 11.",
|
|
563
|
+
"description": "Window effect color. Affects [`WindowEffect::Blur`] and [`WindowEffect::Acrylic`] only\n on Windows 10 v1903+. Doesn't have any effect on Windows 7 or Windows 11.",
|
|
562
564
|
"anyOf": [
|
|
563
565
|
{
|
|
564
566
|
"$ref": "#/definitions/Color"
|
|
@@ -583,7 +585,7 @@
|
|
|
583
585
|
]
|
|
584
586
|
},
|
|
585
587
|
{
|
|
586
|
-
"description": "
|
|
588
|
+
"description": "**macOS 10.14-**",
|
|
587
589
|
"deprecated": true,
|
|
588
590
|
"type": "string",
|
|
589
591
|
"enum": [
|
|
@@ -591,7 +593,7 @@
|
|
|
591
593
|
]
|
|
592
594
|
},
|
|
593
595
|
{
|
|
594
|
-
"description": "
|
|
596
|
+
"description": "**macOS 10.14-**",
|
|
595
597
|
"deprecated": true,
|
|
596
598
|
"type": "string",
|
|
597
599
|
"enum": [
|
|
@@ -599,7 +601,7 @@
|
|
|
599
601
|
]
|
|
600
602
|
},
|
|
601
603
|
{
|
|
602
|
-
"description": "
|
|
604
|
+
"description": "**macOS 10.14-**",
|
|
603
605
|
"deprecated": true,
|
|
604
606
|
"type": "string",
|
|
605
607
|
"enum": [
|
|
@@ -607,7 +609,7 @@
|
|
|
607
609
|
]
|
|
608
610
|
},
|
|
609
611
|
{
|
|
610
|
-
"description": "
|
|
612
|
+
"description": "**macOS 10.14-**",
|
|
611
613
|
"deprecated": true,
|
|
612
614
|
"type": "string",
|
|
613
615
|
"enum": [
|
|
@@ -615,98 +617,98 @@
|
|
|
615
617
|
]
|
|
616
618
|
},
|
|
617
619
|
{
|
|
618
|
-
"description": "
|
|
620
|
+
"description": "**macOS 10.10+**",
|
|
619
621
|
"type": "string",
|
|
620
622
|
"enum": [
|
|
621
623
|
"titlebar"
|
|
622
624
|
]
|
|
623
625
|
},
|
|
624
626
|
{
|
|
625
|
-
"description": "
|
|
627
|
+
"description": "**macOS 10.10+**",
|
|
626
628
|
"type": "string",
|
|
627
629
|
"enum": [
|
|
628
630
|
"selection"
|
|
629
631
|
]
|
|
630
632
|
},
|
|
631
633
|
{
|
|
632
|
-
"description": "
|
|
634
|
+
"description": "**macOS 10.11+**",
|
|
633
635
|
"type": "string",
|
|
634
636
|
"enum": [
|
|
635
637
|
"menu"
|
|
636
638
|
]
|
|
637
639
|
},
|
|
638
640
|
{
|
|
639
|
-
"description": "
|
|
641
|
+
"description": "**macOS 10.11+**",
|
|
640
642
|
"type": "string",
|
|
641
643
|
"enum": [
|
|
642
644
|
"popover"
|
|
643
645
|
]
|
|
644
646
|
},
|
|
645
647
|
{
|
|
646
|
-
"description": "
|
|
648
|
+
"description": "**macOS 10.11+**",
|
|
647
649
|
"type": "string",
|
|
648
650
|
"enum": [
|
|
649
651
|
"sidebar"
|
|
650
652
|
]
|
|
651
653
|
},
|
|
652
654
|
{
|
|
653
|
-
"description": "
|
|
655
|
+
"description": "**macOS 10.14+**",
|
|
654
656
|
"type": "string",
|
|
655
657
|
"enum": [
|
|
656
658
|
"headerView"
|
|
657
659
|
]
|
|
658
660
|
},
|
|
659
661
|
{
|
|
660
|
-
"description": "
|
|
662
|
+
"description": "**macOS 10.14+**",
|
|
661
663
|
"type": "string",
|
|
662
664
|
"enum": [
|
|
663
665
|
"sheet"
|
|
664
666
|
]
|
|
665
667
|
},
|
|
666
668
|
{
|
|
667
|
-
"description": "
|
|
669
|
+
"description": "**macOS 10.14+**",
|
|
668
670
|
"type": "string",
|
|
669
671
|
"enum": [
|
|
670
672
|
"windowBackground"
|
|
671
673
|
]
|
|
672
674
|
},
|
|
673
675
|
{
|
|
674
|
-
"description": "
|
|
676
|
+
"description": "**macOS 10.14+**",
|
|
675
677
|
"type": "string",
|
|
676
678
|
"enum": [
|
|
677
679
|
"hudWindow"
|
|
678
680
|
]
|
|
679
681
|
},
|
|
680
682
|
{
|
|
681
|
-
"description": "
|
|
683
|
+
"description": "**macOS 10.14+**",
|
|
682
684
|
"type": "string",
|
|
683
685
|
"enum": [
|
|
684
686
|
"fullScreenUI"
|
|
685
687
|
]
|
|
686
688
|
},
|
|
687
689
|
{
|
|
688
|
-
"description": "
|
|
690
|
+
"description": "**macOS 10.14+**",
|
|
689
691
|
"type": "string",
|
|
690
692
|
"enum": [
|
|
691
693
|
"tooltip"
|
|
692
694
|
]
|
|
693
695
|
},
|
|
694
696
|
{
|
|
695
|
-
"description": "
|
|
697
|
+
"description": "**macOS 10.14+**",
|
|
696
698
|
"type": "string",
|
|
697
699
|
"enum": [
|
|
698
700
|
"contentBackground"
|
|
699
701
|
]
|
|
700
702
|
},
|
|
701
703
|
{
|
|
702
|
-
"description": "
|
|
704
|
+
"description": "**macOS 10.14+**",
|
|
703
705
|
"type": "string",
|
|
704
706
|
"enum": [
|
|
705
707
|
"underWindowBackground"
|
|
706
708
|
]
|
|
707
709
|
},
|
|
708
710
|
{
|
|
709
|
-
"description": "
|
|
711
|
+
"description": "**macOS 10.14+**",
|
|
710
712
|
"type": "string",
|
|
711
713
|
"enum": [
|
|
712
714
|
"underPageBackground"
|
|
@@ -755,14 +757,14 @@
|
|
|
755
757
|
]
|
|
756
758
|
},
|
|
757
759
|
{
|
|
758
|
-
"description": "**Windows 7/10/11(22H1) Only**\n\n## Notes\n\
|
|
760
|
+
"description": "**Windows 7/10/11(22H1) Only**\n\n ## Notes\n\n This effect has bad performance when resizing/dragging the window on Windows 11 build 22621.",
|
|
759
761
|
"type": "string",
|
|
760
762
|
"enum": [
|
|
761
763
|
"blur"
|
|
762
764
|
]
|
|
763
765
|
},
|
|
764
766
|
{
|
|
765
|
-
"description": "**Windows 10/11 Only**\n\n## Notes\n\
|
|
767
|
+
"description": "**Windows 10/11 Only**\n\n ## Notes\n\n This effect has bad performance when resizing/dragging the window on Windows 10 v1903+ and Windows 11 build 22000.",
|
|
766
768
|
"type": "string",
|
|
767
769
|
"enum": [
|
|
768
770
|
"acrylic"
|
|
@@ -771,7 +773,7 @@
|
|
|
771
773
|
]
|
|
772
774
|
},
|
|
773
775
|
"WindowEffectState": {
|
|
774
|
-
"description": "Window effect state **macOS only**\n\n<https://developer.apple.com/documentation/appkit/nsvisualeffectview/state>",
|
|
776
|
+
"description": "Window effect state **macOS only**\n\n <https://developer.apple.com/documentation/appkit/nsvisualeffectview/state>",
|
|
775
777
|
"oneOf": [
|
|
776
778
|
{
|
|
777
779
|
"description": "Make window effect state follow the window's active state",
|
|
@@ -825,11 +827,11 @@
|
|
|
825
827
|
"minItems": 4
|
|
826
828
|
},
|
|
827
829
|
"SecurityConfig": {
|
|
828
|
-
"description": "Security configuration.\n\
|
|
830
|
+
"description": "Security configuration.\n\n See more: <https://tauri.app/v1/api/config#securityconfig>",
|
|
829
831
|
"type": "object",
|
|
830
832
|
"properties": {
|
|
831
833
|
"csp": {
|
|
832
|
-
"description": "The Content Security Policy that will be injected on all HTML files on the built application
|
|
834
|
+
"description": "The Content Security Policy that will be injected on all HTML files on the built application.\n If [`dev_csp`](#SecurityConfig.devCsp) is not specified, this value is also injected on dev.\n\n This is a really important part of the configuration since it helps you ensure your WebView is secured.\n See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.",
|
|
833
835
|
"anyOf": [
|
|
834
836
|
{
|
|
835
837
|
"$ref": "#/definitions/Csp"
|
|
@@ -840,7 +842,7 @@
|
|
|
840
842
|
]
|
|
841
843
|
},
|
|
842
844
|
"devCsp": {
|
|
843
|
-
"description": "The Content Security Policy that will be injected on all HTML files on development.\n\
|
|
845
|
+
"description": "The Content Security Policy that will be injected on all HTML files on development.\n\n This is a really important part of the configuration since it helps you ensure your WebView is secured.\n See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.",
|
|
844
846
|
"anyOf": [
|
|
845
847
|
{
|
|
846
848
|
"$ref": "#/definitions/Csp"
|
|
@@ -856,7 +858,7 @@
|
|
|
856
858
|
"type": "boolean"
|
|
857
859
|
},
|
|
858
860
|
"dangerousDisableAssetCspModification": {
|
|
859
|
-
"description": "Disables the Tauri-injected CSP sources.\n\
|
|
861
|
+
"description": "Disables the Tauri-injected CSP sources.\n\n At compile time, Tauri parses all the frontend assets and changes the Content-Security-Policy\n to only allow loading of your own scripts and styles by injecting nonce and hash sources.\n This stricts your CSP, which may introduce issues when using along with other flexing sources.\n\n This configuration option allows both a boolean and a list of strings as value.\n A boolean instructs Tauri to disable the injection for all CSP injections,\n and a list of strings indicates the CSP directives that Tauri cannot inject.\n\n **WARNING:** Only disable this if you know what you are doing and have properly configured the CSP.\n Your application might be vulnerable to XSS attacks without this Tauri protection.",
|
|
860
862
|
"default": false,
|
|
861
863
|
"allOf": [
|
|
862
864
|
{
|
|
@@ -888,7 +890,7 @@
|
|
|
888
890
|
]
|
|
889
891
|
},
|
|
890
892
|
"capabilities": {
|
|
891
|
-
"description": "List of capabilities that are enabled on the application.\n\
|
|
893
|
+
"description": "List of capabilities that are enabled on the application.\n\n If the list is empty, all capabilities are included.",
|
|
892
894
|
"default": [],
|
|
893
895
|
"type": "array",
|
|
894
896
|
"items": {
|
|
@@ -899,7 +901,7 @@
|
|
|
899
901
|
"additionalProperties": false
|
|
900
902
|
},
|
|
901
903
|
"Csp": {
|
|
902
|
-
"description": "A Content-Security-Policy definition
|
|
904
|
+
"description": "A Content-Security-Policy definition.\n See <https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP>.",
|
|
903
905
|
"anyOf": [
|
|
904
906
|
{
|
|
905
907
|
"description": "The entire CSP policy in a single text string.",
|
|
@@ -915,7 +917,7 @@
|
|
|
915
917
|
]
|
|
916
918
|
},
|
|
917
919
|
"CspDirectiveSources": {
|
|
918
|
-
"description": "A Content-Security-Policy directive source list
|
|
920
|
+
"description": "A Content-Security-Policy directive source list.\n See <https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy/Sources#sources>.",
|
|
919
921
|
"anyOf": [
|
|
920
922
|
{
|
|
921
923
|
"description": "An inline list of CSP sources. Same as [`Self::List`], but concatenated with a space separator.",
|
|
@@ -934,7 +936,7 @@
|
|
|
934
936
|
"description": "The possible values for the `dangerous_disable_asset_csp_modification` config option.",
|
|
935
937
|
"anyOf": [
|
|
936
938
|
{
|
|
937
|
-
"description": "If `true`, disables all CSP modification
|
|
939
|
+
"description": "If `true`, disables all CSP modification.\n `false` is the default value and it configures Tauri to control the CSP.",
|
|
938
940
|
"type": "boolean"
|
|
939
941
|
},
|
|
940
942
|
{
|
|
@@ -947,7 +949,7 @@
|
|
|
947
949
|
]
|
|
948
950
|
},
|
|
949
951
|
"AssetProtocolConfig": {
|
|
950
|
-
"description": "Config for the asset custom protocol.\n\
|
|
952
|
+
"description": "Config for the asset custom protocol.\n\n See more: <https://tauri.app/v1/api/config#assetprotocolconfig>",
|
|
951
953
|
"type": "object",
|
|
952
954
|
"properties": {
|
|
953
955
|
"scope": {
|
|
@@ -968,7 +970,7 @@
|
|
|
968
970
|
"additionalProperties": false
|
|
969
971
|
},
|
|
970
972
|
"FsScope": {
|
|
971
|
-
"description": "Protocol scope definition
|
|
973
|
+
"description": "Protocol scope definition.\n It is a list of glob patterns that restrict the API access from the webview.\n\n Each pattern can start with a variable that resolves to a system base directory.\n The variables are: `$AUDIO`, `$CACHE`, `$CONFIG`, `$DATA`, `$LOCALDATA`, `$DESKTOP`,\n `$DOCUMENT`, `$DOWNLOAD`, `$EXE`, `$FONT`, `$HOME`, `$PICTURE`, `$PUBLIC`, `$RUNTIME`,\n `$TEMPLATE`, `$VIDEO`, `$RESOURCE`, `$APP`, `$LOG`, `$TEMP`, `$APPCONFIG`, `$APPDATA`,\n `$APPLOCALDATA`, `$APPCACHE`, `$APPLOG`.",
|
|
972
974
|
"anyOf": [
|
|
973
975
|
{
|
|
974
976
|
"description": "A list of paths that are allowed by this scope.",
|
|
@@ -990,7 +992,7 @@
|
|
|
990
992
|
}
|
|
991
993
|
},
|
|
992
994
|
"deny": {
|
|
993
|
-
"description": "A list of paths that are not allowed by this scope
|
|
995
|
+
"description": "A list of paths that are not allowed by this scope.\n This gets precedence over the [`Self::Scope::allow`] list.",
|
|
994
996
|
"default": [],
|
|
995
997
|
"type": "array",
|
|
996
998
|
"items": {
|
|
@@ -998,7 +1000,7 @@
|
|
|
998
1000
|
}
|
|
999
1001
|
},
|
|
1000
1002
|
"requireLiteralLeadingDot": {
|
|
1001
|
-
"description": "Whether or not paths that contain components that start with a
|
|
1003
|
+
"description": "Whether or not paths that contain components that start with a `.`\n will require that `.` appears literally in the pattern; `*`, `?`, `**`,\n or `[...]` will not match. This is useful because such files are\n conventionally considered hidden on Unix systems and it might be\n desirable to skip them when listing files.\n\n Defaults to `true` on Unix systems and `false` on Windows",
|
|
1002
1004
|
"type": [
|
|
1003
1005
|
"boolean",
|
|
1004
1006
|
"null"
|
|
@@ -1074,7 +1076,7 @@
|
|
|
1074
1076
|
]
|
|
1075
1077
|
},
|
|
1076
1078
|
"Capability": {
|
|
1077
|
-
"description": "A grouping and boundary mechanism developers can use to
|
|
1079
|
+
"description": "A grouping and boundary mechanism developers can use to isolate access to the IPC layer.\n\n It controls application windows fine grained access to the Tauri core, application, or plugin commands.\n If a window is not matching any capability then it has no access to the IPC layer at all.\n\n This can be done to create groups of windows, based on their required system access, which can reduce\n impact of frontend vulnerabilities in less privileged windows.\n Windows can be added to a capability by exact name (e.g. `main-window`) or glob patterns like `*` or `admin-*`.\n A Window can have none, one, or multiple associated capabilities.\n\n ## Example\n\n ```json\n {\n \"identifier\": \"main-user-files-write\",\n \"description\": \"This capability allows the `main` window on macOS and Windows access to `filesystem` write related commands and `dialog` commands to enable programatic access to files selected by the user.\",\n \"windows\": [\n \"main\"\n ],\n \"permissions\": [\n \"path:default\",\n \"dialog:open\",\n {\n \"identifier\": \"fs:allow-write-text-file\",\n \"allow\": [{ \"path\": \"$HOME/test.txt\" }]\n },\n \"platforms\": [\"macOS\",\"windows\"]\n }\n ```",
|
|
1078
1080
|
"type": "object",
|
|
1079
1081
|
"required": [
|
|
1080
1082
|
"identifier",
|
|
@@ -1082,16 +1084,16 @@
|
|
|
1082
1084
|
],
|
|
1083
1085
|
"properties": {
|
|
1084
1086
|
"identifier": {
|
|
1085
|
-
"description": "Identifier of the capability
|
|
1087
|
+
"description": "Identifier of the capability.\n\n ## Example\n\n `main-user-files-write`",
|
|
1086
1088
|
"type": "string"
|
|
1087
1089
|
},
|
|
1088
1090
|
"description": {
|
|
1089
|
-
"description": "Description of the capability.",
|
|
1091
|
+
"description": "Description of what the capability is intended to allow on associated windows.\n\n It should contain a description of what the grouped permissions should allow.\n\n ## Example\n\n This capability allows the `main` window access to `filesystem` write related\n commands and `dialog` commands to enable programatic access to files selected by the user.",
|
|
1090
1092
|
"default": "",
|
|
1091
1093
|
"type": "string"
|
|
1092
1094
|
},
|
|
1093
1095
|
"remote": {
|
|
1094
|
-
"description": "Configure remote URLs that can use the capability permissions.",
|
|
1096
|
+
"description": "Configure remote URLs that can use the capability permissions.\n\n This setting is optional and defaults to not being set, as our\n default use case is that the content is served from our local application.\n\n :::caution\n Make sure you understand the security implications of providing remote\n sources with local system access.\n :::\n\n ## Example\n\n ```json\n {\n \"urls\": [\"https://*.mydomain.dev\"]\n }\n ```",
|
|
1095
1097
|
"anyOf": [
|
|
1096
1098
|
{
|
|
1097
1099
|
"$ref": "#/definitions/CapabilityRemote"
|
|
@@ -1107,28 +1109,29 @@
|
|
|
1107
1109
|
"type": "boolean"
|
|
1108
1110
|
},
|
|
1109
1111
|
"windows": {
|
|
1110
|
-
"description": "List of windows that
|
|
1112
|
+
"description": "List of windows that are affected by this capability. Can be a glob pattern.\n\n On multiwebview windows, prefer [`Self::webviews`] for a fine grained access control.\n\n ## Example\n\n `[\"main\"]`",
|
|
1111
1113
|
"type": "array",
|
|
1112
1114
|
"items": {
|
|
1113
1115
|
"type": "string"
|
|
1114
1116
|
}
|
|
1115
1117
|
},
|
|
1116
1118
|
"webviews": {
|
|
1117
|
-
"description": "List of webviews that
|
|
1119
|
+
"description": "List of webviews that are affected by this capability. Can be a glob pattern.\n\n This is only required when using on multiwebview contexts, by default\n all child webviews of a window that matches [`Self::windows`] are linked.\n\n ## Example\n\n `[\"sub-webview-one\", \"sub-webview-two\"]`",
|
|
1118
1120
|
"type": "array",
|
|
1119
1121
|
"items": {
|
|
1120
1122
|
"type": "string"
|
|
1121
1123
|
}
|
|
1122
1124
|
},
|
|
1123
1125
|
"permissions": {
|
|
1124
|
-
"description": "List of permissions attached to this capability
|
|
1126
|
+
"description": "List of permissions attached to this capability.\n\n Must include the plugin name as prefix in the form of `${plugin-name}:${permission-name}`.\n For commands directly implemented in the application itself only `${permission-name}`\n is required.\n\n ## Example\n\n ```json\n [\n \"path:default\",\n \"event:default\",\n \"window:default\",\n \"app:default\",\n \"image:default\",\n \"resources:default\",\n \"menu:default\",\n \"tray:default\",\n \"shell:allow-open\",\n \"dialog:open\",\n {\n \"identifier\": \"fs:allow-write-text-file\",\n \"allow\": [{ \"path\": \"$HOME/test.txt\" }]\n }\n ```",
|
|
1125
1127
|
"type": "array",
|
|
1126
1128
|
"items": {
|
|
1127
1129
|
"$ref": "#/definitions/PermissionEntry"
|
|
1128
|
-
}
|
|
1130
|
+
},
|
|
1131
|
+
"uniqueItems": true
|
|
1129
1132
|
},
|
|
1130
1133
|
"platforms": {
|
|
1131
|
-
"description": "
|
|
1134
|
+
"description": "Limit which target platforms this capability applies to.\n\n By default all platforms are targeted.\n\n ## Example\n\n `[\"macOS\",\"windows\"]`",
|
|
1132
1135
|
"type": [
|
|
1133
1136
|
"array",
|
|
1134
1137
|
"null"
|
|
@@ -1147,7 +1150,7 @@
|
|
|
1147
1150
|
],
|
|
1148
1151
|
"properties": {
|
|
1149
1152
|
"urls": {
|
|
1150
|
-
"description": "Remote domains this capability refers to using the [URLPattern standard](https://urlpattern.spec.whatwg.org/).\n\n
|
|
1153
|
+
"description": "Remote domains this capability refers to using the [URLPattern standard](https://urlpattern.spec.whatwg.org/).\n\n ## Examples\n\n - \"https://*.mydomain.dev\": allows subdomains of mydomain.dev\n - \"https://mydomain.dev/api/*\": allows any subpath of mydomain.dev/api",
|
|
1151
1154
|
"type": "array",
|
|
1152
1155
|
"items": {
|
|
1153
1156
|
"type": "string"
|
|
@@ -1156,7 +1159,7 @@
|
|
|
1156
1159
|
}
|
|
1157
1160
|
},
|
|
1158
1161
|
"PermissionEntry": {
|
|
1159
|
-
"description": "An entry for a permission value in a [`Capability`] can be either a raw permission [`Identifier`] or an object that references a permission and extends its scope.",
|
|
1162
|
+
"description": "An entry for a permission value in a [`Capability`] can be either a raw permission [`Identifier`]\n or an object that references a permission and extends its scope.",
|
|
1160
1163
|
"anyOf": [
|
|
1161
1164
|
{
|
|
1162
1165
|
"description": "Reference a permission or permission set by identifier.",
|
|
@@ -1192,7 +1195,7 @@
|
|
|
1192
1195
|
}
|
|
1193
1196
|
},
|
|
1194
1197
|
"deny": {
|
|
1195
|
-
"description": "Data that defines what is denied by the scope.",
|
|
1198
|
+
"description": "Data that defines what is denied by the scope. This should be prioritized by validation logic.",
|
|
1196
1199
|
"type": [
|
|
1197
1200
|
"array",
|
|
1198
1201
|
"null"
|
|
@@ -1303,7 +1306,7 @@
|
|
|
1303
1306
|
]
|
|
1304
1307
|
},
|
|
1305
1308
|
"TrayIconConfig": {
|
|
1306
|
-
"description": "Configuration for application tray icon.\n\
|
|
1309
|
+
"description": "Configuration for application tray icon.\n\n See more: <https://tauri.app/v1/api/config#trayiconconfig>",
|
|
1307
1310
|
"type": "object",
|
|
1308
1311
|
"required": [
|
|
1309
1312
|
"iconPath"
|
|
@@ -1317,7 +1320,7 @@
|
|
|
1317
1320
|
]
|
|
1318
1321
|
},
|
|
1319
1322
|
"iconPath": {
|
|
1320
|
-
"description": "Path to the default icon to use for the tray icon
|
|
1323
|
+
"description": "Path to the default icon to use for the tray icon.\n\n Note: this stores the image in raw pixels to the final binary,\n so keep the icon size (width and height) small\n or else it's going to bloat your final executable",
|
|
1321
1324
|
"type": "string"
|
|
1322
1325
|
},
|
|
1323
1326
|
"iconAsTemplate": {
|
|
@@ -1348,7 +1351,7 @@
|
|
|
1348
1351
|
"additionalProperties": false
|
|
1349
1352
|
},
|
|
1350
1353
|
"BuildConfig": {
|
|
1351
|
-
"description": "The Build configuration object.\n\
|
|
1354
|
+
"description": "The Build configuration object.\n\n See more: <https://tauri.app/v1/api/config#buildconfig>",
|
|
1352
1355
|
"type": "object",
|
|
1353
1356
|
"properties": {
|
|
1354
1357
|
"runner": {
|
|
@@ -1359,7 +1362,7 @@
|
|
|
1359
1362
|
]
|
|
1360
1363
|
},
|
|
1361
1364
|
"devUrl": {
|
|
1362
|
-
"description": "The URL to load in development.\n\
|
|
1365
|
+
"description": "The URL to load in development.\n\n This is usually an URL to a dev server, which serves your application assets with hot-reload and HMR.\n Most modern JavaScript bundlers like [vite](https://vitejs.dev/guide/) provides a way to start a dev server by default.\n\n If you don't have a dev server or don't want to use one, ignore this option and use [`frontendDist`](BuildConfig::frontend_dist)\n and point to a web assets directory, and Tauri CLI will run its built-in dev server and provide a simple hot-reload experience.",
|
|
1363
1366
|
"type": [
|
|
1364
1367
|
"string",
|
|
1365
1368
|
"null"
|
|
@@ -1367,7 +1370,7 @@
|
|
|
1367
1370
|
"format": "uri"
|
|
1368
1371
|
},
|
|
1369
1372
|
"frontendDist": {
|
|
1370
|
-
"description": "The path to the application assets (usually the `dist` folder of your javascript bundler) or a URL that could be either a custom protocol registered in the tauri app (for example: `myprotocol://`) or a remote URL (for example: `https://site.com/app`).\n\
|
|
1373
|
+
"description": "The path to the application assets (usually the `dist` folder of your javascript bundler)\n or a URL that could be either a custom protocol registered in the tauri app (for example: `myprotocol://`)\n or a remote URL (for example: `https://site.com/app`).\n\n When a path relative to the configuration file is provided,\n it is read recursively and all files are embedded in the application binary.\n Tauri then looks for an `index.html` and serves it as the default entry point for your application.\n\n You can also provide a list of paths to be embedded, which allows granular control over what files are added to the binary.\n In this case, all files are added to the root and you must reference it that way in your HTML files.\n\n When a URL is provided, the application won't have bundled assets\n and the application will load that URL by default.",
|
|
1371
1374
|
"anyOf": [
|
|
1372
1375
|
{
|
|
1373
1376
|
"$ref": "#/definitions/FrontendDist"
|
|
@@ -1378,7 +1381,7 @@
|
|
|
1378
1381
|
]
|
|
1379
1382
|
},
|
|
1380
1383
|
"beforeDevCommand": {
|
|
1381
|
-
"description": "A shell command to run before `tauri dev` kicks in.\n\
|
|
1384
|
+
"description": "A shell command to run before `tauri dev` kicks in.\n\n The TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.",
|
|
1382
1385
|
"anyOf": [
|
|
1383
1386
|
{
|
|
1384
1387
|
"$ref": "#/definitions/BeforeDevCommand"
|
|
@@ -1389,7 +1392,7 @@
|
|
|
1389
1392
|
]
|
|
1390
1393
|
},
|
|
1391
1394
|
"beforeBuildCommand": {
|
|
1392
|
-
"description": "A shell command to run before `tauri build` kicks in.\n\
|
|
1395
|
+
"description": "A shell command to run before `tauri build` kicks in.\n\n The TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.",
|
|
1393
1396
|
"anyOf": [
|
|
1394
1397
|
{
|
|
1395
1398
|
"$ref": "#/definitions/HookCommand"
|
|
@@ -1400,7 +1403,7 @@
|
|
|
1400
1403
|
]
|
|
1401
1404
|
},
|
|
1402
1405
|
"beforeBundleCommand": {
|
|
1403
|
-
"description": "A shell command to run before the bundling phase in `tauri build` kicks in.\n\
|
|
1406
|
+
"description": "A shell command to run before the bundling phase in `tauri build` kicks in.\n\n The TAURI_ENV_PLATFORM, TAURI_ENV_ARCH, TAURI_ENV_FAMILY, TAURI_ENV_PLATFORM_VERSION, TAURI_ENV_PLATFORM_TYPE and TAURI_ENV_DEBUG environment variables are set if you perform conditional compilation.",
|
|
1404
1407
|
"anyOf": [
|
|
1405
1408
|
{
|
|
1406
1409
|
"$ref": "#/definitions/HookCommand"
|
|
@@ -1508,7 +1511,7 @@
|
|
|
1508
1511
|
]
|
|
1509
1512
|
},
|
|
1510
1513
|
"BundleConfig": {
|
|
1511
|
-
"description": "Configuration for tauri-bundler.\n\
|
|
1514
|
+
"description": "Configuration for tauri-bundler.\n\n See more: <https://tauri.app/v1/api/config#bundleconfig>",
|
|
1512
1515
|
"type": "object",
|
|
1513
1516
|
"properties": {
|
|
1514
1517
|
"active": {
|
|
@@ -1517,7 +1520,7 @@
|
|
|
1517
1520
|
"type": "boolean"
|
|
1518
1521
|
},
|
|
1519
1522
|
"targets": {
|
|
1520
|
-
"description": "The bundle targets, currently supports [\"deb\", \"rpm\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\"
|
|
1523
|
+
"description": "The bundle targets, currently supports [\"deb\", \"rpm\", \"appimage\", \"nsis\", \"msi\", \"app\", \"dmg\"] or \"all\".",
|
|
1521
1524
|
"default": "all",
|
|
1522
1525
|
"allOf": [
|
|
1523
1526
|
{
|
|
@@ -1525,8 +1528,24 @@
|
|
|
1525
1528
|
}
|
|
1526
1529
|
]
|
|
1527
1530
|
},
|
|
1531
|
+
"createUpdaterArtifacts": {
|
|
1532
|
+
"description": "Produce updaters and their signatures or not",
|
|
1533
|
+
"default": false,
|
|
1534
|
+
"allOf": [
|
|
1535
|
+
{
|
|
1536
|
+
"$ref": "#/definitions/Updater"
|
|
1537
|
+
}
|
|
1538
|
+
]
|
|
1539
|
+
},
|
|
1528
1540
|
"publisher": {
|
|
1529
|
-
"description": "The application's publisher. Defaults to the second element in the identifier string
|
|
1541
|
+
"description": "The application's publisher. Defaults to the second element in the identifier string.\n Currently maps to the Manufacturer property of the Windows Installer.",
|
|
1542
|
+
"type": [
|
|
1543
|
+
"string",
|
|
1544
|
+
"null"
|
|
1545
|
+
]
|
|
1546
|
+
},
|
|
1547
|
+
"homepage": {
|
|
1548
|
+
"description": "A url to the home page of your application. If unset, will\n fallback to `homepage` defined in `Cargo.toml`.\n\n Supported bundle targets: `deb`, `rpm`, `nsis` and `msi`.",
|
|
1530
1549
|
"type": [
|
|
1531
1550
|
"string",
|
|
1532
1551
|
"null"
|
|
@@ -1541,7 +1560,7 @@
|
|
|
1541
1560
|
}
|
|
1542
1561
|
},
|
|
1543
1562
|
"resources": {
|
|
1544
|
-
"description": "App resources to bundle
|
|
1563
|
+
"description": "App resources to bundle.\n Each resource is a path to a file or directory.\n Glob patterns are supported.",
|
|
1545
1564
|
"anyOf": [
|
|
1546
1565
|
{
|
|
1547
1566
|
"$ref": "#/definitions/BundleResources"
|
|
@@ -1559,7 +1578,7 @@
|
|
|
1559
1578
|
]
|
|
1560
1579
|
},
|
|
1561
1580
|
"license": {
|
|
1562
|
-
"description": "The package's license identifier to be included in the appropriate bundles
|
|
1581
|
+
"description": "The package's license identifier to be included in the appropriate bundles.\n If not set, defaults to the license from the Cargo.toml file.",
|
|
1563
1582
|
"type": [
|
|
1564
1583
|
"string",
|
|
1565
1584
|
"null"
|
|
@@ -1573,7 +1592,7 @@
|
|
|
1573
1592
|
]
|
|
1574
1593
|
},
|
|
1575
1594
|
"category": {
|
|
1576
|
-
"description": "The application kind.\n\
|
|
1595
|
+
"description": "The application kind.\n\n Should be one of the following:\n 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.",
|
|
1577
1596
|
"type": [
|
|
1578
1597
|
"string",
|
|
1579
1598
|
"null"
|
|
@@ -1604,7 +1623,7 @@
|
|
|
1604
1623
|
]
|
|
1605
1624
|
},
|
|
1606
1625
|
"externalBin": {
|
|
1607
|
-
"description": "A list of—either absolute or relative—paths to binaries to embed with your application.\n\
|
|
1626
|
+
"description": "A list of—either absolute or relative—paths to binaries to embed with your application.\n\n Note that Tauri will look for system-specific binaries following the pattern \"binary-name{-target-triple}{.system-extension}\".\n\n E.g. for the external binary \"my-binary\", Tauri looks for:\n\n - \"my-binary-x86_64-pc-windows-msvc.exe\" for Windows\n - \"my-binary-x86_64-apple-darwin\" for macOS\n - \"my-binary-x86_64-unknown-linux-gnu\" for Linux\n\n so don't forget to provide binaries for all targeted platforms.",
|
|
1608
1627
|
"type": [
|
|
1609
1628
|
"array",
|
|
1610
1629
|
"null"
|
|
@@ -1676,6 +1695,7 @@
|
|
|
1676
1695
|
}
|
|
1677
1696
|
},
|
|
1678
1697
|
"files": {},
|
|
1698
|
+
"hardenedRuntime": true,
|
|
1679
1699
|
"minimumSystemVersion": "10.13"
|
|
1680
1700
|
},
|
|
1681
1701
|
"allOf": [
|
|
@@ -1784,18 +1804,40 @@
|
|
|
1784
1804
|
"enum": [
|
|
1785
1805
|
"dmg"
|
|
1786
1806
|
]
|
|
1807
|
+
}
|
|
1808
|
+
]
|
|
1809
|
+
},
|
|
1810
|
+
"Updater": {
|
|
1811
|
+
"description": "Updater type",
|
|
1812
|
+
"anyOf": [
|
|
1813
|
+
{
|
|
1814
|
+
"description": "Generates lagacy zipped v1 compatible updaters",
|
|
1815
|
+
"allOf": [
|
|
1816
|
+
{
|
|
1817
|
+
"$ref": "#/definitions/V1Compatible"
|
|
1818
|
+
}
|
|
1819
|
+
]
|
|
1787
1820
|
},
|
|
1788
1821
|
{
|
|
1789
|
-
"description": "
|
|
1822
|
+
"description": "Produce updaters and their signatures or not",
|
|
1823
|
+
"type": "boolean"
|
|
1824
|
+
}
|
|
1825
|
+
]
|
|
1826
|
+
},
|
|
1827
|
+
"V1Compatible": {
|
|
1828
|
+
"description": "Generates lagacy zipped v1 compatible updaters",
|
|
1829
|
+
"oneOf": [
|
|
1830
|
+
{
|
|
1831
|
+
"description": "Generates lagacy zipped v1 compatible updaters",
|
|
1790
1832
|
"type": "string",
|
|
1791
1833
|
"enum": [
|
|
1792
|
-
"
|
|
1834
|
+
"v1Compatible"
|
|
1793
1835
|
]
|
|
1794
1836
|
}
|
|
1795
1837
|
]
|
|
1796
1838
|
},
|
|
1797
1839
|
"BundleResources": {
|
|
1798
|
-
"description": "Definition for bundle resources
|
|
1840
|
+
"description": "Definition for bundle resources.\n Can be either a list of paths to include or a map of source to target paths.",
|
|
1799
1841
|
"anyOf": [
|
|
1800
1842
|
{
|
|
1801
1843
|
"description": "A list of paths to include.",
|
|
@@ -1861,7 +1903,7 @@
|
|
|
1861
1903
|
"additionalProperties": false
|
|
1862
1904
|
},
|
|
1863
1905
|
"AssociationExt": {
|
|
1864
|
-
"description": "An extension for a [`FileAssociation`].\n\
|
|
1906
|
+
"description": "An extension for a [`FileAssociation`].\n\n A leading `.` is automatically stripped.",
|
|
1865
1907
|
"type": "string"
|
|
1866
1908
|
},
|
|
1867
1909
|
"BundleTypeRole": {
|
|
@@ -1905,11 +1947,11 @@
|
|
|
1905
1947
|
]
|
|
1906
1948
|
},
|
|
1907
1949
|
"WindowsConfig": {
|
|
1908
|
-
"description": "Windows bundler configuration.\n\
|
|
1950
|
+
"description": "Windows bundler configuration.\n\n See more: <https://tauri.app/v1/api/config#windowsconfig>",
|
|
1909
1951
|
"type": "object",
|
|
1910
1952
|
"properties": {
|
|
1911
1953
|
"digestAlgorithm": {
|
|
1912
|
-
"description": "Specifies the file digest algorithm to use for creating file signatures
|
|
1954
|
+
"description": "Specifies the file digest algorithm to use for creating file signatures.\n Required for code signing. SHA-256 is recommended.",
|
|
1913
1955
|
"type": [
|
|
1914
1956
|
"string",
|
|
1915
1957
|
"null"
|
|
@@ -1930,7 +1972,7 @@
|
|
|
1930
1972
|
]
|
|
1931
1973
|
},
|
|
1932
1974
|
"tsp": {
|
|
1933
|
-
"description": "Whether to use Time-Stamp Protocol (TSP, a.k.a. RFC 3161) for the timestamp server. Your code signing provider may use a TSP timestamp server, like e.g. SSL.com does. If so, enable TSP by setting to true.",
|
|
1975
|
+
"description": "Whether to use Time-Stamp Protocol (TSP, a.k.a. RFC 3161) for the timestamp server. Your code signing provider may\n use a TSP timestamp server, like e.g. SSL.com does. If so, enable TSP by setting to true.",
|
|
1934
1976
|
"default": false,
|
|
1935
1977
|
"type": "boolean"
|
|
1936
1978
|
},
|
|
@@ -1947,14 +1989,14 @@
|
|
|
1947
1989
|
]
|
|
1948
1990
|
},
|
|
1949
1991
|
"webviewFixedRuntimePath": {
|
|
1950
|
-
"description": "Path to the webview fixed runtime to use. Overwrites [`Self::webview_install_mode`] if set.\n\
|
|
1992
|
+
"description": "Path to the webview fixed runtime to use. Overwrites [`Self::webview_install_mode`] if set.\n\n Will be removed in v2, prefer the [`Self::webview_install_mode`] option.\n\n The fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section).\n The `.cab` file must be extracted to a folder and this folder path must be defined on this field.",
|
|
1951
1993
|
"type": [
|
|
1952
1994
|
"string",
|
|
1953
1995
|
"null"
|
|
1954
1996
|
]
|
|
1955
1997
|
},
|
|
1956
1998
|
"allowDowngrades": {
|
|
1957
|
-
"description": "Validates a second app installation, blocking the user from installing an older version if set to `false`.\n\
|
|
1999
|
+
"description": "Validates a second app installation, blocking the user from installing an older version if set to `false`.\n\n 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`.\n\n The default value of this flag is `true`.",
|
|
1958
2000
|
"default": true,
|
|
1959
2001
|
"type": "boolean"
|
|
1960
2002
|
},
|
|
@@ -1981,7 +2023,7 @@
|
|
|
1981
2023
|
]
|
|
1982
2024
|
},
|
|
1983
2025
|
"signCommand": {
|
|
1984
|
-
"description": "Specify a custom command to sign the binaries
|
|
2026
|
+
"description": "Specify a custom command to sign the binaries.\n This command needs to have a `%1` in it which is just a placeholder for the binary path,\n which we will detect and replace before calling the command.\n\n Example:\n ```text\n sign-cli --arg1 --arg2 %1\n ```\n\n By Default we use `signtool.exe` which can be found only on Windows so\n if you are on another platform and want to cross-compile and sign you will\n need to use another tool like `osslsigncode`.",
|
|
1985
2027
|
"type": [
|
|
1986
2028
|
"string",
|
|
1987
2029
|
"null"
|
|
@@ -1991,7 +2033,7 @@
|
|
|
1991
2033
|
"additionalProperties": false
|
|
1992
2034
|
},
|
|
1993
2035
|
"WebviewInstallMode": {
|
|
1994
|
-
"description": "Install modes for the Webview2 runtime
|
|
2036
|
+
"description": "Install modes for the Webview2 runtime.\n Note that for the updater bundle [`Self::DownloadBootstrapper`] is used.\n\n For more information see <https://tauri.app/v1/guides/building/windows>.",
|
|
1995
2037
|
"oneOf": [
|
|
1996
2038
|
{
|
|
1997
2039
|
"description": "Do not install the Webview2 as part of the Windows Installer.",
|
|
@@ -2010,7 +2052,7 @@
|
|
|
2010
2052
|
"additionalProperties": false
|
|
2011
2053
|
},
|
|
2012
2054
|
{
|
|
2013
|
-
"description": "Download the bootstrapper and run it
|
|
2055
|
+
"description": "Download the bootstrapper and run it.\n Requires an internet connection.\n Results in a smaller installer size, but is not recommended on Windows 7.",
|
|
2014
2056
|
"type": "object",
|
|
2015
2057
|
"required": [
|
|
2016
2058
|
"type"
|
|
@@ -2031,7 +2073,7 @@
|
|
|
2031
2073
|
"additionalProperties": false
|
|
2032
2074
|
},
|
|
2033
2075
|
{
|
|
2034
|
-
"description": "Embed the bootstrapper and run it
|
|
2076
|
+
"description": "Embed the bootstrapper and run it.\n Requires an internet connection.\n Increases the installer size by around 1.8MB, but offers better support on Windows 7.",
|
|
2035
2077
|
"type": "object",
|
|
2036
2078
|
"required": [
|
|
2037
2079
|
"type"
|
|
@@ -2052,7 +2094,7 @@
|
|
|
2052
2094
|
"additionalProperties": false
|
|
2053
2095
|
},
|
|
2054
2096
|
{
|
|
2055
|
-
"description": "Embed the offline installer and run it
|
|
2097
|
+
"description": "Embed the offline installer and run it.\n Does not require an internet connection.\n Increases the installer size by around 127MB.",
|
|
2056
2098
|
"type": "object",
|
|
2057
2099
|
"required": [
|
|
2058
2100
|
"type"
|
|
@@ -2073,7 +2115,7 @@
|
|
|
2073
2115
|
"additionalProperties": false
|
|
2074
2116
|
},
|
|
2075
2117
|
{
|
|
2076
|
-
"description": "Embed a fixed webview2 version and use it at runtime
|
|
2118
|
+
"description": "Embed a fixed webview2 version and use it at runtime.\n Increases the installer size by around 180MB.",
|
|
2077
2119
|
"type": "object",
|
|
2078
2120
|
"required": [
|
|
2079
2121
|
"path",
|
|
@@ -2087,7 +2129,7 @@
|
|
|
2087
2129
|
]
|
|
2088
2130
|
},
|
|
2089
2131
|
"path": {
|
|
2090
|
-
"description": "The path to the fixed runtime to use.\n\
|
|
2132
|
+
"description": "The path to the fixed runtime to use.\n\n The fixed version can be downloaded [on the official website](https://developer.microsoft.com/en-us/microsoft-edge/webview2/#download-section).\n The `.cab` file must be extracted to a folder and this folder path must be defined on this field.",
|
|
2091
2133
|
"type": "string"
|
|
2092
2134
|
}
|
|
2093
2135
|
},
|
|
@@ -2096,7 +2138,7 @@
|
|
|
2096
2138
|
]
|
|
2097
2139
|
},
|
|
2098
2140
|
"WixConfig": {
|
|
2099
|
-
"description": "Configuration for the MSI bundle using WiX.\n\
|
|
2141
|
+
"description": "Configuration for the MSI bundle using WiX.\n\n See more: <https://tauri.app/v1/api/config#wixconfig>",
|
|
2100
2142
|
"type": "object",
|
|
2101
2143
|
"properties": {
|
|
2102
2144
|
"language": {
|
|
@@ -2169,14 +2211,14 @@
|
|
|
2169
2211
|
"type": "boolean"
|
|
2170
2212
|
},
|
|
2171
2213
|
"bannerPath": {
|
|
2172
|
-
"description": "Path to a bitmap file to use as the installation user interface banner
|
|
2214
|
+
"description": "Path to a bitmap file to use as the installation user interface banner.\n This bitmap will appear at the top of all but the first page of the installer.\n\n The required dimensions are 493px × 58px.",
|
|
2173
2215
|
"type": [
|
|
2174
2216
|
"string",
|
|
2175
2217
|
"null"
|
|
2176
2218
|
]
|
|
2177
2219
|
},
|
|
2178
2220
|
"dialogImagePath": {
|
|
2179
|
-
"description": "Path to a bitmap file to use on the installation user interface dialogs
|
|
2221
|
+
"description": "Path to a bitmap file to use on the installation user interface dialogs.\n It is used on the welcome and completion dialogs.\n The required dimensions are 493px × 312px.",
|
|
2180
2222
|
"type": [
|
|
2181
2223
|
"string",
|
|
2182
2224
|
"null"
|
|
@@ -2209,7 +2251,7 @@
|
|
|
2209
2251
|
]
|
|
2210
2252
|
},
|
|
2211
2253
|
"WixLanguageConfig": {
|
|
2212
|
-
"description": "Configuration for a target language for the WiX build.\n\
|
|
2254
|
+
"description": "Configuration for a target language for the WiX build.\n\n See more: <https://tauri.app/v1/api/config#wixlanguageconfig>",
|
|
2213
2255
|
"type": "object",
|
|
2214
2256
|
"properties": {
|
|
2215
2257
|
"localePath": {
|
|
@@ -2234,14 +2276,14 @@
|
|
|
2234
2276
|
]
|
|
2235
2277
|
},
|
|
2236
2278
|
"headerImage": {
|
|
2237
|
-
"description": "The path to a bitmap file to display on the header of installers pages.\n\
|
|
2279
|
+
"description": "The path to a bitmap file to display on the header of installers pages.\n\n The recommended dimensions are 150px x 57px.",
|
|
2238
2280
|
"type": [
|
|
2239
2281
|
"string",
|
|
2240
2282
|
"null"
|
|
2241
2283
|
]
|
|
2242
2284
|
},
|
|
2243
2285
|
"sidebarImage": {
|
|
2244
|
-
"description": "The path to a bitmap file for the Welcome page and the Finish page.\n\
|
|
2286
|
+
"description": "The path to a bitmap file for the Welcome page and the Finish page.\n\n The recommended dimensions are 164px x 314px.",
|
|
2245
2287
|
"type": [
|
|
2246
2288
|
"string",
|
|
2247
2289
|
"null"
|
|
@@ -2264,7 +2306,7 @@
|
|
|
2264
2306
|
]
|
|
2265
2307
|
},
|
|
2266
2308
|
"languages": {
|
|
2267
|
-
"description": "A list of installer languages
|
|
2309
|
+
"description": "A list of installer languages.\n By default the OS language is used. If the OS language is not in the list of languages, the first language will be used.\n To allow the user to select the language, set `display_language_selector` to `true`.\n\n See <https://github.com/kichik/nsis/tree/9465c08046f00ccb6eda985abbdbf52c275c6c4d/Contrib/Language%20files> for the complete list of languages.",
|
|
2268
2310
|
"type": [
|
|
2269
2311
|
"array",
|
|
2270
2312
|
"null"
|
|
@@ -2274,7 +2316,7 @@
|
|
|
2274
2316
|
}
|
|
2275
2317
|
},
|
|
2276
2318
|
"customLanguageFiles": {
|
|
2277
|
-
"description": "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.\n\
|
|
2319
|
+
"description": "A key-value pair where the key is the language and the\n value is the path to a custom `.nsh` file that holds the translated text for tauri's custom messages.\n\n See <https://github.com/tauri-apps/tauri/blob/dev/tooling/bundler/src/bundle/windows/templates/nsis-languages/English.nsh> for an example `.nsh` file.\n\n **Note**: the key must be a valid NSIS language and it must be added to [`NsisConfig`] languages array,",
|
|
2278
2320
|
"type": [
|
|
2279
2321
|
"object",
|
|
2280
2322
|
"null"
|
|
@@ -2284,23 +2326,28 @@
|
|
|
2284
2326
|
}
|
|
2285
2327
|
},
|
|
2286
2328
|
"displayLanguageSelector": {
|
|
2287
|
-
"description": "Whether to display a language selector dialog before the installer and uninstaller windows are rendered or not
|
|
2329
|
+
"description": "Whether to display a language selector dialog before the installer and uninstaller windows are rendered or not.\n By default the OS language is selected, with a fallback to the first language in the `languages` array.",
|
|
2288
2330
|
"default": false,
|
|
2289
2331
|
"type": "boolean"
|
|
2290
2332
|
},
|
|
2291
2333
|
"compression": {
|
|
2292
|
-
"description": "Set the compression algorithm used to compress files in the installer.\n\
|
|
2293
|
-
"
|
|
2334
|
+
"description": "Set the compression algorithm used to compress files in the installer.\n\n See <https://nsis.sourceforge.io/Reference/SetCompressor>",
|
|
2335
|
+
"default": "lzma",
|
|
2336
|
+
"allOf": [
|
|
2294
2337
|
{
|
|
2295
2338
|
"$ref": "#/definitions/NsisCompression"
|
|
2296
|
-
},
|
|
2297
|
-
{
|
|
2298
|
-
"type": "null"
|
|
2299
2339
|
}
|
|
2300
2340
|
]
|
|
2301
2341
|
},
|
|
2342
|
+
"startMenuFolder": {
|
|
2343
|
+
"description": "Set the folder name for the start menu shortcut.\n\n Use this option if you have multiple apps and wish to group their shortcuts under one folder\n or if you generally prefer to set your shortcut inside a folder.\n\n Examples:\n - `AwesomePublisher`, shortcut will be placed in `%AppData%\\Microsoft\\Windows\\Start Menu\\Programs\\AwesomePublisher\\<your-app>.lnk`\n - If unset, shortcut will be placed in `%AppData%\\Microsoft\\Windows\\Start Menu\\Programs\\<your-app>.lnk`",
|
|
2344
|
+
"type": [
|
|
2345
|
+
"string",
|
|
2346
|
+
"null"
|
|
2347
|
+
]
|
|
2348
|
+
},
|
|
2302
2349
|
"installerHooks": {
|
|
2303
|
-
"description": "A path to a `.nsh` file that contains special NSIS macros to be hooked into the main installer.nsi script.\n\
|
|
2350
|
+
"description": "A path to a `.nsh` file that contains special NSIS macros to be hooked into the\n main installer.nsi script.\n\n Supported hooks are:\n - `NSIS_HOOK_PREINSTALL`: This hook runs before copying files, setting registry key values and creating shortcuts.\n - `NSIS_HOOK_POSTINSTALL`: This hook runs after the installer has finished copying all files, setting the registry keys and created shortcuts.\n - `NSIS_HOOK_PREUNINSTALL`: This hook runs before removing any files, registry keys and shortcuts.\n - `NSIS_HOOK_POSTUNINSTALL`: This hook runs after files, registry keys and shortcuts have been removed.\n\n\n ### Example\n\n ```nsh\n !define NSIS_HOOK_PREINSTALL \"NSIS_HOOK_PREINSTALL_\"\n !macro NSIS_HOOK_PREINSTALL_\n MessageBox MB_OK \"PreInstall\"\n !macroend\n\n !define NSIS_HOOK_POSTINSTALL \"NSIS_HOOK_POSTINSTALL_\"\n !macro NSIS_HOOK_POSTINSTALL_\n MessageBox MB_OK \"PostInstall\"\n !macroend\n\n !define NSIS_HOOK_PREUNINSTALL \"NSIS_HOOK_PREUNINSTALL_\"\n !macro NSIS_HOOK_PREUNINSTALL_\n MessageBox MB_OK \"PreUnInstall\"\n !macroend\n\n !define NSIS_HOOK_POSTUNINSTALL \"NSIS_HOOK_POSTUNINSTALL_\"\n !macro NSIS_HOOK_POSTUNINSTALL_\n MessageBox MB_OK \"PostUninstall\"\n !macroend\n\n ```",
|
|
2304
2351
|
"type": [
|
|
2305
2352
|
"string",
|
|
2306
2353
|
"null"
|
|
@@ -2313,21 +2360,21 @@
|
|
|
2313
2360
|
"description": "Install Modes for the NSIS installer.",
|
|
2314
2361
|
"oneOf": [
|
|
2315
2362
|
{
|
|
2316
|
-
"description": "Default mode for the installer.\n\
|
|
2363
|
+
"description": "Default mode for the installer.\n\n Install the app by default in a directory that doesn't require Administrator access.\n\n Installer metadata will be saved under the `HKCU` registry path.",
|
|
2317
2364
|
"type": "string",
|
|
2318
2365
|
"enum": [
|
|
2319
2366
|
"currentUser"
|
|
2320
2367
|
]
|
|
2321
2368
|
},
|
|
2322
2369
|
{
|
|
2323
|
-
"description": "Install the app by default in the `Program Files` folder directory requires Administrator access for the installation.\n\
|
|
2370
|
+
"description": "Install the app by default in the `Program Files` folder directory requires Administrator\n access for the installation.\n\n Installer metadata will be saved under the `HKLM` registry path.",
|
|
2324
2371
|
"type": "string",
|
|
2325
2372
|
"enum": [
|
|
2326
2373
|
"perMachine"
|
|
2327
2374
|
]
|
|
2328
2375
|
},
|
|
2329
2376
|
{
|
|
2330
|
-
"description": "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.\n\
|
|
2377
|
+
"description": "Combines both modes and allows the user to choose at install time\n whether to install for the current user or per machine. Note that this mode\n will require Administrator access even if the user wants to install it for the current user only.\n\n Installer metadata will be saved under the `HKLM` or `HKCU` registry path based on the user's choice.",
|
|
2331
2378
|
"type": "string",
|
|
2332
2379
|
"enum": [
|
|
2333
2380
|
"both"
|
|
@@ -2336,7 +2383,7 @@
|
|
|
2336
2383
|
]
|
|
2337
2384
|
},
|
|
2338
2385
|
"NsisCompression": {
|
|
2339
|
-
"description": "Compression algorithms used in the NSIS installer.\n\
|
|
2386
|
+
"description": "Compression algorithms used in the NSIS installer.\n\n See <https://nsis.sourceforge.io/Reference/SetCompressor>",
|
|
2340
2387
|
"oneOf": [
|
|
2341
2388
|
{
|
|
2342
2389
|
"description": "ZLIB uses the deflate algorithm, it is a quick and simple method. With the default compression level it uses about 300 KB of memory.",
|
|
@@ -2358,11 +2405,18 @@
|
|
|
2358
2405
|
"enum": [
|
|
2359
2406
|
"lzma"
|
|
2360
2407
|
]
|
|
2408
|
+
},
|
|
2409
|
+
{
|
|
2410
|
+
"description": "Disable compression",
|
|
2411
|
+
"type": "string",
|
|
2412
|
+
"enum": [
|
|
2413
|
+
"none"
|
|
2414
|
+
]
|
|
2361
2415
|
}
|
|
2362
2416
|
]
|
|
2363
2417
|
},
|
|
2364
2418
|
"LinuxConfig": {
|
|
2365
|
-
"description": "Configuration for Linux bundles.\n\
|
|
2419
|
+
"description": "Configuration for Linux bundles.\n\n See more: <https://tauri.app/v1/api/config#linuxconfig>",
|
|
2366
2420
|
"type": "object",
|
|
2367
2421
|
"properties": {
|
|
2368
2422
|
"appimage": {
|
|
@@ -2405,11 +2459,11 @@
|
|
|
2405
2459
|
"additionalProperties": false
|
|
2406
2460
|
},
|
|
2407
2461
|
"AppImageConfig": {
|
|
2408
|
-
"description": "Configuration for AppImage bundles.\n\
|
|
2462
|
+
"description": "Configuration for AppImage bundles.\n\n See more: <https://tauri.app/v1/api/config#appimageconfig>",
|
|
2409
2463
|
"type": "object",
|
|
2410
2464
|
"properties": {
|
|
2411
2465
|
"bundleMediaFramework": {
|
|
2412
|
-
"description": "Include additional gstreamer dependencies needed for audio and video playback
|
|
2466
|
+
"description": "Include additional gstreamer dependencies needed for audio and video playback.\n This increases the bundle size by ~15-35MB depending on your build system.",
|
|
2413
2467
|
"default": false,
|
|
2414
2468
|
"type": "boolean"
|
|
2415
2469
|
},
|
|
@@ -2425,7 +2479,7 @@
|
|
|
2425
2479
|
"additionalProperties": false
|
|
2426
2480
|
},
|
|
2427
2481
|
"DebConfig": {
|
|
2428
|
-
"description": "Configuration for Debian (.deb) bundles.\n\
|
|
2482
|
+
"description": "Configuration for Debian (.deb) bundles.\n\n See more: <https://tauri.app/v1/api/config#debconfig>",
|
|
2429
2483
|
"type": "object",
|
|
2430
2484
|
"properties": {
|
|
2431
2485
|
"depends": {
|
|
@@ -2484,49 +2538,49 @@
|
|
|
2484
2538
|
]
|
|
2485
2539
|
},
|
|
2486
2540
|
"priority": {
|
|
2487
|
-
"description": "Change the priority of the Debian Package. By default, it is set to `optional
|
|
2541
|
+
"description": "Change the priority of the Debian Package. By default, it is set to `optional`.\n Recognized Priorities as of now are : `required`, `important`, `standard`, `optional`, `extra`",
|
|
2488
2542
|
"type": [
|
|
2489
2543
|
"string",
|
|
2490
2544
|
"null"
|
|
2491
2545
|
]
|
|
2492
2546
|
},
|
|
2493
2547
|
"changelog": {
|
|
2494
|
-
"description": "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",
|
|
2548
|
+
"description": "Path of the uncompressed Changelog file, to be stored at /usr/share/doc/package-name/changelog.gz. See\n https://www.debian.org/doc/debian-policy/ch-docs.html#changelog-files-and-release-notes",
|
|
2495
2549
|
"type": [
|
|
2496
2550
|
"string",
|
|
2497
2551
|
"null"
|
|
2498
2552
|
]
|
|
2499
2553
|
},
|
|
2500
2554
|
"desktopTemplate": {
|
|
2501
|
-
"description": "Path to a custom desktop file Handlebars template.\n\
|
|
2555
|
+
"description": "Path to a custom desktop file Handlebars template.\n\n Available variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.",
|
|
2502
2556
|
"type": [
|
|
2503
2557
|
"string",
|
|
2504
2558
|
"null"
|
|
2505
2559
|
]
|
|
2506
2560
|
},
|
|
2507
2561
|
"preInstallScript": {
|
|
2508
|
-
"description": "Path to script that will be executed before the package is unpacked. See https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2562
|
+
"description": "Path to script that will be executed before the package is unpacked. See\n https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2509
2563
|
"type": [
|
|
2510
2564
|
"string",
|
|
2511
2565
|
"null"
|
|
2512
2566
|
]
|
|
2513
2567
|
},
|
|
2514
2568
|
"postInstallScript": {
|
|
2515
|
-
"description": "Path to script that will be executed after the package is unpacked. See https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2569
|
+
"description": "Path to script that will be executed after the package is unpacked. See\n https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2516
2570
|
"type": [
|
|
2517
2571
|
"string",
|
|
2518
2572
|
"null"
|
|
2519
2573
|
]
|
|
2520
2574
|
},
|
|
2521
2575
|
"preRemoveScript": {
|
|
2522
|
-
"description": "Path to script that will be executed before the package is removed. See https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2576
|
+
"description": "Path to script that will be executed before the package is removed. See\n https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2523
2577
|
"type": [
|
|
2524
2578
|
"string",
|
|
2525
2579
|
"null"
|
|
2526
2580
|
]
|
|
2527
2581
|
},
|
|
2528
2582
|
"postRemoveScript": {
|
|
2529
|
-
"description": "Path to script that will be executed after the package is removed. See https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2583
|
+
"description": "Path to script that will be executed after the package is removed. See\n https://www.debian.org/doc/debian-policy/ch-maintainerscripts.html",
|
|
2530
2584
|
"type": [
|
|
2531
2585
|
"string",
|
|
2532
2586
|
"null"
|
|
@@ -2560,7 +2614,7 @@
|
|
|
2560
2614
|
}
|
|
2561
2615
|
},
|
|
2562
2616
|
"conflicts": {
|
|
2563
|
-
"description": "The list of RPM dependencies your application conflicts with. They must not be present in order for the package to be installed.",
|
|
2617
|
+
"description": "The list of RPM dependencies your application conflicts with. They must not be present\n in order for the package to be installed.",
|
|
2564
2618
|
"type": [
|
|
2565
2619
|
"array",
|
|
2566
2620
|
"null"
|
|
@@ -2570,7 +2624,7 @@
|
|
|
2570
2624
|
}
|
|
2571
2625
|
},
|
|
2572
2626
|
"obsoletes": {
|
|
2573
|
-
"description": "The list of RPM dependencies your application supersedes - if this package is installed
|
|
2627
|
+
"description": "The list of RPM dependencies your application supersedes - if this package is installed,\n packages listed as “obsoletes” will be automatically removed (if they are present).",
|
|
2574
2628
|
"type": [
|
|
2575
2629
|
"array",
|
|
2576
2630
|
"null"
|
|
@@ -2600,35 +2654,35 @@
|
|
|
2600
2654
|
}
|
|
2601
2655
|
},
|
|
2602
2656
|
"desktopTemplate": {
|
|
2603
|
-
"description": "Path to a custom desktop file Handlebars template.\n\
|
|
2657
|
+
"description": "Path to a custom desktop file Handlebars template.\n\n Available variables: `categories`, `comment` (optional), `exec`, `icon` and `name`.",
|
|
2604
2658
|
"type": [
|
|
2605
2659
|
"string",
|
|
2606
2660
|
"null"
|
|
2607
2661
|
]
|
|
2608
2662
|
},
|
|
2609
2663
|
"preInstallScript": {
|
|
2610
|
-
"description": "Path to script that will be executed before the package is unpacked. See http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2664
|
+
"description": "Path to script that will be executed before the package is unpacked. See\n http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2611
2665
|
"type": [
|
|
2612
2666
|
"string",
|
|
2613
2667
|
"null"
|
|
2614
2668
|
]
|
|
2615
2669
|
},
|
|
2616
2670
|
"postInstallScript": {
|
|
2617
|
-
"description": "Path to script that will be executed after the package is unpacked. See http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2671
|
+
"description": "Path to script that will be executed after the package is unpacked. See\n http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2618
2672
|
"type": [
|
|
2619
2673
|
"string",
|
|
2620
2674
|
"null"
|
|
2621
2675
|
]
|
|
2622
2676
|
},
|
|
2623
2677
|
"preRemoveScript": {
|
|
2624
|
-
"description": "Path to script that will be executed before the package is removed. See http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2678
|
+
"description": "Path to script that will be executed before the package is removed. See\n http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2625
2679
|
"type": [
|
|
2626
2680
|
"string",
|
|
2627
2681
|
"null"
|
|
2628
2682
|
]
|
|
2629
2683
|
},
|
|
2630
2684
|
"postRemoveScript": {
|
|
2631
|
-
"description": "Path to script that will be executed after the package is removed. See http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2685
|
+
"description": "Path to script that will be executed after the package is removed. See\n http://ftp.rpm.org/max-rpm/s1-rpm-inside-scripts.html",
|
|
2632
2686
|
"type": [
|
|
2633
2687
|
"string",
|
|
2634
2688
|
"null"
|
|
@@ -2638,11 +2692,11 @@
|
|
|
2638
2692
|
"additionalProperties": false
|
|
2639
2693
|
},
|
|
2640
2694
|
"MacConfig": {
|
|
2641
|
-
"description": "Configuration for the macOS bundles.\n\
|
|
2695
|
+
"description": "Configuration for the macOS bundles.\n\n See more: <https://tauri.app/v1/api/config#macconfig>",
|
|
2642
2696
|
"type": "object",
|
|
2643
2697
|
"properties": {
|
|
2644
2698
|
"frameworks": {
|
|
2645
|
-
"description": "A list of strings indicating any macOS X frameworks that need to be bundled with the application.\n\
|
|
2699
|
+
"description": "A list of strings indicating any macOS X frameworks that need to be bundled with the application.\n\n 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.",
|
|
2646
2700
|
"type": [
|
|
2647
2701
|
"array",
|
|
2648
2702
|
"null"
|
|
@@ -2660,7 +2714,7 @@
|
|
|
2660
2714
|
}
|
|
2661
2715
|
},
|
|
2662
2716
|
"minimumSystemVersion": {
|
|
2663
|
-
"description": "A version string indicating the minimum macOS X version that the bundled application supports. Defaults to `10.13`.\n\
|
|
2717
|
+
"description": "A version string indicating the minimum macOS X version that the bundled application supports. Defaults to `10.13`.\n\n Setting it to `null` completely removes the `LSMinimumSystemVersion` field on the bundle's `Info.plist`\n and the `MACOSX_DEPLOYMENT_TARGET` environment variable.\n\n An empty string is considered an invalid value so the default value is used.",
|
|
2664
2718
|
"default": "10.13",
|
|
2665
2719
|
"type": [
|
|
2666
2720
|
"string",
|
|
@@ -2668,7 +2722,7 @@
|
|
|
2668
2722
|
]
|
|
2669
2723
|
},
|
|
2670
2724
|
"exceptionDomain": {
|
|
2671
|
-
"description": "Allows your application to communicate with the outside world
|
|
2725
|
+
"description": "Allows your application to communicate with the outside world.\n It should be a lowercase, without port and protocol domain name.",
|
|
2672
2726
|
"type": [
|
|
2673
2727
|
"string",
|
|
2674
2728
|
"null"
|
|
@@ -2681,6 +2735,11 @@
|
|
|
2681
2735
|
"null"
|
|
2682
2736
|
]
|
|
2683
2737
|
},
|
|
2738
|
+
"hardenedRuntime": {
|
|
2739
|
+
"description": "Whether the codesign should enable [hardened runtime] (for executables) or not.\n\n [hardened runtime]: <https://developer.apple.com/documentation/security/hardened_runtime>",
|
|
2740
|
+
"default": true,
|
|
2741
|
+
"type": "boolean"
|
|
2742
|
+
},
|
|
2684
2743
|
"providerShortName": {
|
|
2685
2744
|
"description": "Provider short name for notarization.",
|
|
2686
2745
|
"type": [
|
|
@@ -2721,7 +2780,7 @@
|
|
|
2721
2780
|
"additionalProperties": false
|
|
2722
2781
|
},
|
|
2723
2782
|
"DmgConfig": {
|
|
2724
|
-
"description": "Configuration for Apple Disk Image (.dmg) bundles.\n\
|
|
2783
|
+
"description": "Configuration for Apple Disk Image (.dmg) bundles.\n\n See more: <https://tauri.app/v1/api/config#dmgconfig>",
|
|
2725
2784
|
"type": "object",
|
|
2726
2785
|
"properties": {
|
|
2727
2786
|
"background": {
|
|
@@ -2832,7 +2891,7 @@
|
|
|
2832
2891
|
"type": "object",
|
|
2833
2892
|
"properties": {
|
|
2834
2893
|
"developmentTeam": {
|
|
2835
|
-
"description": "The development team. This value is required for iOS development because code signing is enforced
|
|
2894
|
+
"description": "The development team. This value is required for iOS development because code signing is enforced.\n The `APPLE_DEVELOPMENT_TEAM` environment variable can be set to overwrite it.",
|
|
2836
2895
|
"type": [
|
|
2837
2896
|
"string",
|
|
2838
2897
|
"null"
|
|
@@ -2846,14 +2905,14 @@
|
|
|
2846
2905
|
"type": "object",
|
|
2847
2906
|
"properties": {
|
|
2848
2907
|
"minSdkVersion": {
|
|
2849
|
-
"description": "The minimum API level required for the application to run
|
|
2908
|
+
"description": "The minimum API level required for the application to run.\n The Android system will prevent the user from installing the application if the system's API level is lower than the value specified.",
|
|
2850
2909
|
"default": 24,
|
|
2851
2910
|
"type": "integer",
|
|
2852
2911
|
"format": "uint32",
|
|
2853
2912
|
"minimum": 0.0
|
|
2854
2913
|
},
|
|
2855
2914
|
"versionCode": {
|
|
2856
|
-
"description": "The version code of the application
|
|
2915
|
+
"description": "The version code of the application.\n It is limited to 2,100,000,000 as per Google Play Store requirements.\n\n By default we use your configured version and perform the following math:\n versionCode = version.major * 1000000 + version.minor * 1000 + version.patch",
|
|
2857
2916
|
"type": [
|
|
2858
2917
|
"integer",
|
|
2859
2918
|
"null"
|
|
@@ -2866,7 +2925,7 @@
|
|
|
2866
2925
|
"additionalProperties": false
|
|
2867
2926
|
},
|
|
2868
2927
|
"PluginConfig": {
|
|
2869
|
-
"description": "The plugin configs holds a HashMap mapping a plugin name to its configuration object.\n\
|
|
2928
|
+
"description": "The plugin configs holds a HashMap mapping a plugin name to its configuration object.\n\n See more: <https://tauri.app/v1/api/config#pluginconfig>",
|
|
2870
2929
|
"type": "object",
|
|
2871
2930
|
"additionalProperties": true
|
|
2872
2931
|
}
|