This plugin provides over-the-air (OTA) updates for the Web assets of a Tauri app.
It leverages the CrabNebula Cloud to ship the assets.
This plugin requires a Rust version of at least 1.75
There are three general methods of installation that we can recommend.
- Use crates.io and npm (easiest, and requires you to trust that our publishing pipeline worked)
- Pull sources directly from Github using git tags / revision hashes (most secure)
- Git submodule install this repo in your tauri project and then use file protocol to ingest the source (most secure, but inconvenient to use)
Install the Core plugin by adding the following to your Cargo.toml
file:
src-tauri/Cargo.toml
[dependencies]
tauri-plugin-ota-updater = "2.0.0-rc"
You can install the JavaScript Guest bindings using your preferred JavaScript package manager:
pnpm add @crabnebula/plugin-ota-updater
# or
npm add @crabnebula/plugin-ota-updater
# or
yarn add @crabnebula/plugin-ota-updater
First you need to register the core plugin with Tauri:
src-tauri/src/main.rs
fn main() {
tauri::Builder::default()
.plugin(tauri_plugin_ota_updater::init())
.run(tauri::generate_context!())
.expect("error while running tauri application");
}
Afterwards all the plugin's APIs are available through the JavaScript guest bindings:
import { check } from "@crabnebula/plugin-ota-updater";
const update = await check()
if (update) {
await update.apply()
location.reload()
}
Code: (c) 2023 - Present - CrabNebula Ltd.
PolyForm-Noncommercial-1.0.0