Support Self-Updating

[leaanthony]

Investigate https://github.com/minio/selfupdate

[misitebao]

I think this feature can exist as an official library under the wailsapp organization, and developers can choose to use it or not, and should not be built into the wails project.

This way developers can customize their auto-update strategy and we can provide guidance and examples.

[stale]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

[leaanthony]

Option: https://github.com/rhysd/go-github-selfupdate

[leaanthony]

Vital feedback on this feature: https://gophers.slack.com/archives/CJ4P9F7MZ/p1656654913191629?thread_ts=1656616142.685839&cid=CJ4P9F7MZ

[olup]

I am very interested by this but does not have access to the slack post in question. Has anyone tested rhysd/go-github-selfupdate with wails ?

[annikovk]

I'm using it with wails for some time. Work smoothly. Implemented like that:

func CheckForUpdate(currentVersion string) (bool, string, string) {
	latest, found, err := selfupdate.DetectLatest("annikovk/IntelliJ-Log-Analyzer")
	if err != nil {
		log.Println("Error occurred while detecting version:", err)
		return false, "", ""
	}
	v := semver.MustParse(currentVersion)
	if !found || latest.Version.LTE(v) {
		log.Println("Current version is the latest")
		return false, "", ""
	}
	return true, latest.Version.String(), latest.ReleaseNotes
}

[leaanthony]

Love the work you're doing on the log analyser 🔥

[leaanthony]

Would love a guide on how to do this in the docs ;-)

[olup]

@annikovk thanks for the example, I am going to use this route then. It's still a bit fuzzy for me how the actual update should happend - I can picture it for linux or windows where I get a single executable, but what about macos where it's a .app file, with moving parts ? The download and extracting and replacing is something we have to build or it's provided by the lib ? What's your experience with it ?

[brys0]

I would probably use the go selfupdate if it had the features I wanted. For now I enabled the ability to download an exe from a url (not sure on the api setup yet) and it gives download progress (which go-selfupdate does not). I'd be happy to have a sorta package or something around it for people who want it. This does mean writing some sort of syntax for the download URL in such and so it might take some time. Let me know if you people are interested in this.

[olup]

Maybe building something internal for this ? Tauri's implementation is interesting to look at

[Bluebugs]

Just wanted to point out to another selfupdate solution : https://github.com/fynelabs/selfupdate , used mostly by Fyne related project, but it is not depending on it and can be use by any other go project.

It gives progress, work on MacOS, Linux and Windows.

[beatscode]

I'm working with the minio/selfupdate package to self update. It works, sort of. After the update the app opens however, any tags used (Build version for example) are not kept through the update.

The code is pretty straight forward

	err = selfupdate.Apply(resp.Body, selfupdate.Options{
		TargetPath: exPath,
	})

I use the myapp.app/Contents/MacOS/binary.app to self update with. I couldn't get the .app to work
Am I missing something?

[FrenchGithubUser]

@annikovk I implemented a self-update mechanism as well with rhysd/go-github-selfupdate.

It works well but only if the binary is in a folder that doesn't require admin/root rights to write in. So this is problematic if the binary is in /usr/bin/ or in windows' programs folder. I was wondering if you also encountered this issue, and if so, how did you fix it ? (ask the user for admin rights ? if so, how ? something else ?

[SgtPooki]

Yeah, there are currently ways to do this already (see riftshare) so it's not a priority to bake into the project. There's also been very mixed feedback about how it should work (GitHub vs S3 vs etc etc)

I'm not a gopher so this may be a dumb question, but since this is a golang project, and golang goes hard on github, why isn't github the obvious first choice?

Btw, the riftshare code for selfupdate is at https://github.com/achhabra2/riftshare/blob/main/internal/update/selfupdate.go for those curious.

[leaanthony]

I'm not a gopher so this may be a dumb question, but since this is a golang project, and golang goes hard on github, why isn't github the obvious first choice?

Btw, the riftshare code for selfupdate is at https://github.com/achhabra2/riftshare/blob/main/internal/update/selfupdate.go for those curious.

Indeed. Also, different people want different things. There's a plugin system for wails3 that's working pretty well in the pre-alpha. I think that's an ideal candidate for this.

[pavelbinar]

Is it safe/good idea to use rhysd/go-github-selfupdate?
The latest activity is from Jan 13, 2021 🤔

[mJehanno]

I wanted to add this feature to my wails app recently. I choosed to create my own library to handle this. Why ? because other libraries are either relying on storage object (s3) or are behaving like the binary is located in $GOBIN (which is not always the case with a builded wails app). My lib relies on github releases. It's a bit experimental, it seems to work on linux, didn't really try on windows.
It let the user of the library choose if it will just check if there is a new version or if it will check and update.
You can find it here.

don't hesitate to use it, fork it, improve it, takes some part of it if that can help.

[wudimenghuan]

https://github.com/inconshreveable/go-update
star 2.1k

[RichardLindhout]

It looks like in production it has not the permission to run 'ditto' at least I got some errors there

[RichardLindhout]

Looks like it needs another process to replace itself. So really self-update is not possible a.t.m. I think i will just add a button if update is available to download (then permission will be required on mac to download) and then after dowloading redirecting the user to the install .pkg

[wudimenghuan]

@annikovk谢谢你的例子，那我就用这个方法吧。我还是不太清楚实际更新应该如何进行——我可以想象在 Linux 或 Windows 上更新时，我会得到一个可执行文件，但对于 MacOS 来说，它是一个.app文件，有移动部件？下载、提取和替换是我们必须构建的，还是由库提供的？你对此有什么经验？

Me too, .app not work

[MickeyUK]

I am new to golang, so I'm not sure if this is the best way, but this is how I've implemented self updating on Windows for my wails app, using GitHub.

I learnt how to check for updates using the example mentioned above (https://github.com/achhabra2/riftshare/blob/main/internal/update/selfupdate.go)

...however, I couldn't get the actual updating to work with that example. So what I did was I used this to download the update to the working directory (https://github.com/cavaliergopher/grab), then I created a batch file that will rename the file and update. This is a rough example:

func startUpdate(version string) {
	file := "https://github.com/USER/REPOSITORY/releases/download/" + version + "/YourApp_windows_amd64.exe"

	// create client
	client := grab.NewClient()
	req, _ := grab.NewRequest(".", file)

	// start download
	fmt.Printf("Downloading %v...\n", req.URL())
	resp := client.Do(req)
	fmt.Printf("  %v\n", resp.HTTPResponse.Status)

	// start UI loop
	t := time.NewTicker(500 * time.Millisecond)
	defer t.Stop()

Loop:
	for {
		select {
		case <-t.C:
			// Can get progress with: int(resp.Progress() * 100)
		case <-resp.Done:
			break Loop
		}
	}

	// check for errors
	if err := resp.Err(); err != nil {
		fmt.Fprintf(os.Stderr, "Download failed: %v\n", err)
		os.Exit(1)
	}

	fmt.Printf("Download saved to ./%v \n", resp.Filename)

	// New and old file names
	oldFile := "YourApp.exe"
	newFile := "YourApp_windows_amd64.exe"

	// Create the batch script content
	script := fmt.Sprintf(`@echo off
	echo The application is updating. Please wait...
	timeout /t 5
	del %s
	rename %s %s
	start %s
	del %s
	exit`, oldFile, newFile, oldFile, oldFile, "update.bat")

	// Write the script to a file
	updateFile, err := os.Create("update.bat")
	if err != nil {
		panic(err)
	}
	defer updateFile.Close()
	_, err = updateFile.WriteString(script)
	if err != nil {
		panic(err)
	}

	// Run the script
	cmd := exec.Command("cmd", "/C", "start update.bat")
	cmd.Start()

	// Close the application
	os.Exit(0)
}

Hope this helps someone

[JaneX8]

I would like to see this auto-update feature too.

[brys0]

This is also probably better off becoming a plugin for wails v3.

[StephanMa]

Just for your Info: i am currently using the Self updating service API by keygen.sh. If someone needs to use something like this now

[leaanthony]

Just for your Info: i am currently using the Self updating service API by keygen.sh. If someone needs to use something like this now

A little guide on how to do this would be incredible! Looks like a great option.

[brys0]

This is a little late but what I did previously for my apps is have a centralized location to check if there's a new version available. If there is I rename the current process, download the new application with the rename to the previous, then on next restart it should be running the new instance of the app. This is probably if not the simplest way to have "automatic" in-app updates.

[StephanMa]

Just for your Info: i am currently using the Self updating service API by keygen.sh. If someone needs to use something like this now

A little guide on how to do this would be incredible! Looks like a great option.

On KeyGen.Sh you have to create a free account (or self host it if preferred).
Create a product for each app you want to host.
Create platforms and architectures for your product (multiple entries for a product are possible!).

After this you can create releases via WebUI or API. Every release needs to have some artifacts for the specific OS/Architecture ,e.g. [Your_APP.exe]_windows_amd64.exe. Upload the artifact and "release" the release.

On the Go-Side:

func (a *App) CheckForUpdates(mode int) {
	env, err := assetenv.ReadFile(".env")
	if err != nil {
		log.Fatal("Error loading .env file")
	}

	viper.SetConfigName("env") // name of config file (without extension)
	viper.SetConfigType("env")
	err = viper.ReadConfig(bytes.NewBuffer(env))
	if err != nil {
		log.Fatal("Error reading .env file")
	}
	keygen.Account = viper.Get("keygen.Account").(string)
	keygen.Product = viper.Get("keygen.Product").(string)

	opts := keygen.UpgradeOptions{CurrentVersion: Version, Channel: Channel, PublicKey: PublicKey}
	// Check for an upgrade
	release, err := keygen.Upgrade(opts)

	switch {
	case err == keygen.ErrUpgradeNotAvailable:
		fmt.Println("No upgrade available, already at the latest version!")
		functions.EmitError(
			a.ctx,
			errors.New("Kein Update verfügbar. Bereits auf dem neuesten Stand!"),
		)
		return
	case err != nil:
		fmt.Println("Upgrade check failed!")

		return
	}
	// Upgrade is available!
	if mode == BrowserMode {
		functions.EmitError(a.ctx, errors.New("Update verfügbar! Bitte Update durchführen!"))
	} else if mode == GoMode {
		fmt.Println("Upgrade available:", release.Version)
	}
	a.update = release
	fmt.Println("Release hinterlegt")
}

func (a *App) UpgradeInfos() VersionType {
	fmt.Println("UpgradeInfos")
	if a.update == nil {
		return VersionType{}
	}

	fmt.Println("Upgrade available from SysInfo:", a.update.Version)
	var rtnValue VersionType
	rtnValue.Version = a.update.Version
	rtnValue.Channel = a.update.Channel
	rtnValue.Created = a.update.Created.String()
	return rtnValue
}

func (a *App) UpgradeApp() {
	// Install the upgrade
	functions.EmitProgress(a.ctx, FtpClient.Progresstype{Message: "Starte Upgrade"})
	if err := a.update.Install(); err != nil {
		fmt.Println(err)
		functions.EmitError(a.ctx, errors.New("Upgrade Installation fehlgeschlagen!"))
	} else {
		functions.EmitError(a.ctx, errors.New("Upgrade vollständig! Bitte Anwendung neu starten"))
	}
	functions.EmitProgress(a.ctx, FtpClient.Progresstype{})
}

Not the cleanest, but it works very well.
Check for Updates gets triggered in the Init Function and the other ones on demand.
I am using a dedicated Project.go-File for keeping track with the version

package main

var (
	Version   = "0.x.y"
	Date      = "2024-12-13 13:50:00 +0200 CEST"
	Channel   = "stable"
	PublicKey = `[your key from keygen]`
)

On Init, the API compares the local Version with the versions online. If a newer Release is available, you get a response which is, in this case, stored locally for immediate use.

[leaanthony]

Thank you so much @StephanMa 🙏

[kruegernet]

A walkthrough on using go-sparkle to self-update wails for the next wayward soul who stumbles through to this thread

https://github.com/marcus-crane/wails3-sparkle-poc

[leaanthony]

This would make a great v3 Service.

[Z3NTL3]

I think this feature can exist as an official library under the wailsapp organization, and developers can choose to use it or not, and should not be built into the wails project.

This way developers can customize their auto-update strategy and we can provide guidance and examples.

i agree on this, and im enthusiastly waiting until v3

[abemedia]

Hey, developer of go-sparkle and go-winsparkle here (the packages @kruegernet is using in the example above). I'm happy to help with the integration. I'm thinking a higher level package which selects either go-sparkle or go-winsparkle, based on which OS is running which has a unified API would probably simplify things.

[abemedia]

I've also created an app which automatically creates and deploys the appcast feeds needed for sparkle and winsparkle: https://github.com/kubri/kubri

This can also be used as a library so we could have a single command in wails which builds the app, then generates the appcast feed and publishes it.

FYI kubri also creates YUM and APT repos so we could integrate it so that auto-updating is completely cross platform including creating and updating Linux repos.

The Linux repos and the appcast feed can all be deployed to a GitHub repo so users do not need a server to host their updates.

[leaanthony]

Hey @abemedia 👋 Great to see you here! That sounds amazing 😍 Are you on discord at all? I've been working on this in the background and tying it in with native app signing. It would be good to co-ordinate efforts.

[abemedia]

@leaanthony I do. Just added you as a friend.