Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[v2][doc]Add Updater Plugin Config Help #1133

Open
wants to merge 1 commit into
base: v2
Choose a base branch
from
Open

[v2][doc]Add Updater Plugin Config Help #1133

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions plugins/updater/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,24 @@ if (update?.available) {
}
```

### Config
First, you need to prepare a distribution key pair, you can follow the [V1 guide](https://tauri.app/zh-cn/v1/guides/distribution/updater/) at this time.
Then, set `TAURI_SIGNING_PRIVATE_KEY` to your private key file , if the private key file have a password,set `TAURI_SIGNING_PRIVATE_KEY_PASSWORD` to your private key file password.(The environment variables are different than v1).
Next, change your tauri.conf.json file like below.
```json
{
//"productName": "WindKnight",
"plugins": {
"updater": {
"active": true,
"endpoints": "<your update server or json file url>",
"dialog": true,
"pubkey": "<your pub key>"
}
},
}
```

## Contributing

PRs accepted. Please make sure to read the Contributing Guide before making a pull request.
Expand Down