Skip to content

Commit ec01c20

Browse files
authored
feat: beta-rc.3 updates (tauri-apps#196)
1 parent 35b1217 commit ec01c20

File tree

4 files changed

+84
-3
lines changed

4 files changed

+84
-3
lines changed

docs/en/api/config.md

Lines changed: 14 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -152,12 +152,24 @@ It's composed of the following properties:
152152
{ property: "longDescription", optional: true, type: "string", description: `A longer, multi-line description of the application.` },
153153
{ property: "deb", optional: true, type: "object", child: <Properties anchorRoot="tauri.bundle.deb" rows={[
154154
{ property: "depends", optional: true, type: "string[]", description: `The list of deb dependencies your application relies on.` },
155-
{ property: "useBootstrapper", optional: true, type: "boolean", description: `Enable the <a href="#bootstrapper">boostrapper script</a>.` }]} />
155+
{ property: "useBootstrapper", optional: true, type: "boolean", description: `Enable the <a href="/en/docs/usage/guides/bundler/debian#bootstrapper">boostrapper script</a>.` },
156+
{ property: "files", optional: true, type: "{ [path: string]: string }", description: `The files to include on the package. See <a href="/en/docs/usage/guides/bundler/debian#custom-files">the debian guide</a>.` }]} />
156157
},
157158
{ property: "windows", optional: true, type: "object", child: <Properties anchorRoot="tauri.bundle.windows" rows={[
158159
{ property: "digestAlgorithm", optional: true, type: "string", description: `Specifies the file digest algorithm to use for creating file signatures. Required for code signing. SHA-256 is recommended.` },
159160
{ property: "certificateThumbprint", optional: true, type: "string[]", description: `Specifies the SHA1 hash of the signing certificate.` },
160-
{ property: "timestampUrl", optional: true, type: "string[]", description: `Server to use during timestamping.` }]} />
161+
{ property: "timestampUrl", optional: true, type: "string[]", description: `Server to use during timestamping.` },
162+
{ property: "wix", optional: true, type: "object", child: <Properties anchorRoot="tauri.bundle.windows.wix" rows={[
163+
{ property: "template", optional: true, type: "string", description: `A custom .wxs template to use.` },
164+
{ property: "fragmentPaths", optional: true, type: "string[]", description: `A list of paths to .wxs files with WiX fragments to use.` },
165+
{ property: "componentGroupRefs", optional: true, type: "string[]", description: `The ComponentGroup element ids you want to reference from the fragments.` },
166+
{ property: "componentRefs", optional: true, type: "string[]", description: `The Component element ids you want to reference from the fragments.` },
167+
{ property: "featureGroupRefs", optional: true, type: "string[]", description: `The FeatureGroup element ids you want to reference from the fragments.` },
168+
{ property: "featureRefs", optional: true, type: "string[]", description: `The Feature element ids you want to reference from the fragments.` },
169+
{ property: "mergeRefs", optional: true, type: "string[]", description: `The Merge element ids you want to reference from the fragments.` },
170+
{ property: "skipWebviewInstall", optional: true, type: "boolean", description: `Disables the Webview2 runtime installation after app install.` }]} />
171+
}
172+
]} />
161173
},
162174
{ property: "macOS", optional: true, type: "object", child: <Properties anchorRoot="tauri.bundle.macOS" rows={[
163175
{ property: "frameworks", optional: true, type: "string[]", description: `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.` },
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Debian packages
3+
---
4+
5+
import Alert from '@theme/Alert'
6+
7+
Tauri allows your app to be packaged as a `.deb` (Debian package) file.
8+
9+
# Bootstrapper
10+
11+
Instead of launching the app directly, you can configure the bundled app to run a script that tries to expose the environment variables to the app; without that you'll have trouble using system programs because the `PATH` environment variable isn't correct. Enable it with the <a href="/docs/api/config#tauri.bundle.deb.useBootstrapper">`useBootstrapper`</a> config.
12+
13+
# Custom files
14+
15+
To include custom files to the debian package, you can configure a mapping on `tauri.conf.json > tauri > bundle > deb > files` as follows:
16+
17+
```json
18+
{
19+
"tauri": {
20+
"bundle": {
21+
"deb": {
22+
"files": {
23+
"/usr/lib/README.md": "../README.md", // copies the README.md file to /usr/lib/README.md
24+
"usr/lib/assets": "../public/" // copies the entire public directory to /usr/lib/assets
25+
}
26+
}
27+
}
28+
}
29+
}
30+
```
31+
32+
<Alert title="Note" icon="info-alt">
33+
Each `files` object key is the path on the debian package, and the value is a path to a file or directory relative to the `tauri.conf.json` file.
34+
</Alert>
Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
---
2+
title: Debian packages
3+
---
4+
5+
import Alert from '@theme/Alert'
6+
7+
Tauri allows your app to be packaged as a `.deb` (Debian package) file.
8+
9+
# Bootstrapper
10+
11+
Instead of launching the app directly, you can configure the bundled app to run a script that tries to expose the environment variables to the app; without that you'll have trouble using system programs because the `PATH` environment variable isn't correct. Enable it with the <a href="/docs/api/config#tauri.bundle.deb.useBootstrapper">`useBootstrapper`</a> config.
12+
13+
# Custom files
14+
15+
To include custom files to the debian package, you can configure a mapping on `tauri.conf.json > tauri > bundle > deb > files` as follows:
16+
17+
```json
18+
{
19+
"tauri": {
20+
"bundle": {
21+
"deb": {
22+
"files": {
23+
"/usr/lib/README.md": "../README.md", // copies the README.md file to /usr/lib/README.md
24+
"usr/lib/assets": "../public/" // copies the entire public directory to /usr/lib/assets
25+
}
26+
}
27+
}
28+
}
29+
}
30+
```
31+
32+
<Alert title="Note" icon="info-alt">
33+
Each `files` object key is the path on the debian package, and the value is a path to a file or directory relative to the `tauri.conf.json` file.
34+
</Alert>

sidebars.json

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,7 +50,8 @@
5050
"items": [
5151
"usage/guides/bundler/introduction",
5252
"usage/guides/bundler/anti-bloat",
53-
"usage/guides/bundler/sidecar"
53+
"usage/guides/bundler/sidecar",
54+
"usage/guides/bundler/debian"
5455
]
5556
},
5657
"usage/guides/cli",

0 commit comments

Comments
 (0)