Updater Configuration

On this page you will find an overview of how to configure supported updater services and frameworks to work 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.

Right now we support the following options:

• Tauri v1
• Tauri v2
• Cargo Packager

Tauri

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:

"build": {
    "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.

Cargo Packager

Tip

A more in depth explanation for Cargo Packager can be found in this guide.

Detailed documentation for the updater can be found in the docs and the GitHub repository.

Packager includes a built-in updater which can be configured to automatically update your application as soon as you publish a new release on Cloud.

Start off by adding the cargo-packager-updater dependency to your project:

cargo add cargo-packager-updater

Afterwards you need to generate a cryptographic key pair which will be used to verify the integrity of the update. New updates will be signed with the private key and the public key will be used to confirm the integrity of the update.

cargo packager signer generate

Save the private key in a secure location as it will be used to sign the new release when you publish it. For the configuration of the updater code you will only need the public key.

In your Rust project navigate to the specific file where you want to add the updater code and add the following imports:

use cargo_packager_updater::{semver::Version, url::Url};

Now add the following code:

    let config = cargo_packager_updater::Config {
        endpoints: vec![Url::parse("https://cdn.crabnebula.app/update/YOUR_ORG_SLUG/YOUR_APP_SLUG/{{target}}-{{arch}}/{{current_version}}").expect("Failed to parse URL")], // REPLACE: YOUR_ORG_SLUG and YOUR_APP_SLUG of the app in CN Cloud
        pubkey: String::from("YOUR_PUBLIC_KEY"), // REPLACE: YOUR_PUBLIC_KEY generated by the signer
        ..Default::default()
    };
    let current_version =
        Version::parse(env!("CARGO_PKG_VERSION")).expect("Failed to parse version");

    println!("Current version: {}", current_version);

    if let Some(update) = cargo_packager_updater::check_update(current_version.clone(), config)
        .expect("Failed to check for update")
    {
        update
            .download_and_install()
            .expect("Failed to download and install update");
        println!("Update installed")
    } else {
        println!("No update available")
    }

Make sure to replace YOUR_ORG_SLUG and YOUR_APP_SLUG with the slug of your organization and app on Cloud. Also replace YOUR_PUBLIC_KEY with the public key generated by the signer.

Now as soon as that code is run, the updater will check for updates and if a new update is available, it will be downloaded and installed automatically.