Tauri

On this page you will find an overview of how to configure Tauri (v1 and v2) auto-updater with CrabNebula Cloud. This will allow you to automatically update your application as soon as you publish a new release on Cloud without having to manually handle the update process.

Tip

A more in depth explanation for Tauri v2 can be found in this guide.

For more details on how to configure Tauri updater, please refer to the Tauri documentation for Tauri v1 and Tauri v2 respectively.

Before you can adjust your tauri.conf.json file to configure the update endpoint, you need to generate a cryptographic key pair for your application which will be used to check if the update is valid or might have been tampered with. The public key will be used to verify the update (needs to be put in the tauri.conf.json file) and the private key (has to be kept secret!) will be used to sign the new release when you publish it.

Run the following command to generate a key pair for your application:

macOS/Linux

cargo tauri signer generate -w ~/.tauri/myapp.key

Windows

cargo tauri signer generate -w $HOME/.tauri/myapp.key

You should now see the two keyfiles ~/.tauri/myapp.key and ~/.tauri/myapp.key.pub.

Tauri v1

Now you need to add the following configuration to your tauri.conf.json file:

"tauri": {
  "updater": {
    "active": true,
    "endpoints": [
      "https://cdn.crabnebula.app/update/ORG_NAME/APP_NAME/{{target}}-{{arch}}/{{current_version}}"
    ],
    "dialog": true,
    "pubkey": "PUBKEY"
  },
},

Tauri v2

Before you can configure the update endpoint, you need to install the updater plugin:

cargo tauri add updater

Now you need to add the following configuration to your tauri.conf.json file:

"bundle": {
    "createUpdaterArtifacts": true
},
"plugins": {
  "updater": {
    "endpoints": [
      "https://cdn.crabnebula.app/update/ORG_NAME/APP_NAME/{{target}}-{{arch}}/{{current_version}}"
    ],
    "pubkey": "PUBKEY"
  }
}

Caution

Note that the createUpdaterArtifacts value must be set to true for new applications, but set to "v1Compatible" when updating from a Tauri v1 application.

Make sure to replace ORG_NAME with your organizations name on Cloud, APP_NAME with the apps name on Cloud and PUBKEY with the public key from ~/.tauri/myapp.key.pub.

Caution

It is important to sign the app with the private key from ~/.tauri/myapp.key before you publish a new release as otherwise the update will not be valid.