Autoupdater.NET.Official 1.4.6

Details
Advisory: https://github.com/advisories/GHSA-75p2-hgw4-g7f7 Severity: critical
There is a newer version of this package available.
See the version list below for details.
dotnet add package Autoupdater.NET.Official --version 1.4.6
NuGet\Install-Package Autoupdater.NET.Official -Version 1.4.6
This command is intended to be used within the Package Manager Console in Visual Studio, as it uses the NuGet module's version of Install-Package.
<PackageReference Include="Autoupdater.NET.Official" Version="1.4.6" />
For projects that support PackageReference, copy this XML node into the project file to reference the package.
paket add Autoupdater.NET.Official --version 1.4.6
#r "nuget: Autoupdater.NET.Official, 1.4.6"
#r directive can be used in F# Interactive and Polyglot Notebooks. Copy this into the interactive tool or source code of the script to reference the package.
// Install Autoupdater.NET.Official as a Cake Addin
#addin nuget:?package=Autoupdater.NET.Official&version=1.4.6

// Install Autoupdater.NET.Official as a Cake Tool
#tool nuget:?package=Autoupdater.NET.Official&version=1.4.6

How it works

AutoUpdater.NET downloads the XML file containing update information from your server. It uses this XML file to get the information about the latest version of the software. If latest version of the software is greater then current version of the software installed on User's PC then AutoUpdater.NET shows update dialog to the user. If user press the update button to update the software then It downloads the update file (Installer) from URL provided in XML file and executes the installer file it just downloaded. It is a job of installer after this point to carry out the update. If you provide zip file URL instead of installer then AutoUpdater.NET will extract the contents of zip file to application directory.

Using the code

XML file

AutoUpdater.NET uses XML file located on a server to get the release information about the latest version of the software. You need to create XML file like below and then you need to upload it to your server.

<?xml version="1.0" encoding="UTF-8"?>
<item>
    <version>2.0.0.0</version>
    <url>http://rbsoft.org/downloads/AutoUpdaterTest.zip</url>
    <changelog>https://github.com/ravibpatel/AutoUpdater.NET/releases</changelog>
    <mandatory>false</mandatory>
</item>

There are two things you need to provide in XML file as you can see above.

  • version (Required) : You need to provide latest version of the application between version tags. Version should be in X.X.X.X format.
  • url (Required): You need to provide URL of the latest version installer file between url tags. AutoUpdater.NET downloads the file provided here and install it when user press the Update button.
  • changelog (Optional): You need to provide URL of the change log of your application between changelog tags. If you don't provide the URL of the changelog then update dialog won't show the change log.
  • mandatory (Optional): You can set this to true if you don't want user to skip this version. This will ignore Remind Later and Skip options and hide both Skip and Remind Later button on update dialog.
  • args (Optional): You can provide command line arguments for Installer between this tag. You can include %path% with your command line arguments, it will be replaced by path of the directory where currently executing application resides.

Adding one line to make it work

After you done creating and uploading XML file, It is very easy to add a auto update functionality to your application. First you need to add following line at the top of your form.

using AutoUpdaterDotNET;

Now you just need to add following line to your main form constructor or in Form_Load event. You can add this line anywhere you like. If you don't like to check for update when application starts then you can create a Check for update button and add this line to Button_Click event.

AutoUpdater.Start("http://rbsoft.org/updates/AutoUpdaterTest.xml");

Start method of AutoUpdater class takes URL of the XML file you uploaded to server as a parameter.

AutoUpdater.Start should be called from UI thread.

Configuration Options

Disable Skip Button

If you don't want to show Skip button on Update form then just add following line with above code.

AutoUpdater.ShowSkipButton = false;

Disable Remind Later Button

If you don't want to show Remind Later button on Update form then just add following line with above code.

AutoUpdater.ShowRemindLaterButton = false;

Ignore previous Remind Later or Skip settings

If you want to ignore previosuly set Remind Later and Skip settings then you can set Mandatory property to true. It will also hide Skip and Remind Later button. If you set Mandatory to true in code then value of Mandatory in your XML file will be ignored.

AutoUpdater.Mandatory = true;

Enable Error Reporting

You can turn on error reporting by adding below code. If you do this AutoUpdater.NET will show error message, if there is no update available or if it can't get to the XML file from web server.

AutoUpdater.ReportErrors = true;

Open Download Page

If you don't want to download the latest version of the application and just want to open the URL between url tags of your XML file then you need to add following line with above code.

AutoUpdater.OpenDownloadPage = true;

This kind of scenario is useful if you want to show some information to users before they download the latest version of an application.

Remind Later

If you don't want users to select Remind Later time when they press the Remind Later button of update dialog then you need to add following lines with above code.

AutoUpdater.LetUserSelectRemindLater = false;
AutoUpdater.RemindLaterTimeSpan = RemindLaterFormat.Days;
AutoUpdater.RemindLaterAt = 2;

In above example when user press Remind Later button of update dialog, It will remind user for update after 2 days.

Proxy Server

If your XML and Update file can only be used from certain Proxy Server then you can use following settings to tell AutoUpdater.NET to use that proxy. Currently, if your Changelog URL is also restricted to Proxy server then you should omit changelog tag from XML file cause it is not supported using Proxy Server.

var proxy = new WebProxy("ProxyIP:ProxyPort", true) 
{
    Credentials = new NetworkCredential("ProxyUserName", "ProxyPassword")
};
AutoUpdater.Proxy = proxy;

Check updates frequently

You can call Start method inside Timer to check for updates frequently.

WinForms

System.Timers.Timer timer = new System.Timers.Timer
{
    Interval = 2 * 60 * 1000,
    SynchronizingObject = this
};
timer.Elapsed += delegate
{
    AutoUpdater.Start("http://rbsoft.org/updates/AutoUpdaterTest.xml");
};
timer.Start();

WPF

DispatcherTimer timer = new DispatcherTimer {Interval = TimeSpan.FromMinutes(2)};
timer.Tick += delegate
{
    AutoUpdater.Start("http://rbsoft.org/updates/AutoUpdaterTestWPF.xml");
};
timer.Start();
Product Compatible and additional computed target framework versions.
.NET Framework net20 is compatible.  net35 is compatible.  net40 is compatible.  net403 was computed.  net45 was computed.  net451 was computed.  net452 is compatible.  net46 was computed.  net461 was computed.  net462 is compatible.  net463 was computed.  net47 was computed.  net471 was computed.  net472 was computed.  net48 was computed.  net481 was computed. 
Compatible target framework(s)
Included target framework(s) (in package)
Learn more about Target Frameworks and .NET Standard.

This package has no dependencies.

NuGet packages (5)

Showing the top 5 NuGet packages that depend on Autoupdater.NET.Official:

Package Downloads
AutoUpdate2

AutoUpdate2

Updater.Detmach

Oluşturduğunuz Programlar İçin Otomatik Güncelleme Özelliğini Kullanabileceksiniz.

AutoUpdaterWpf

Package Description

Lanpuda.Client.Common

Package Description

BlazorWpf.SharedWpf

BlazorWpf

GitHub repositories (39)

Showing the top 5 popular GitHub repositories that depend on Autoupdater.NET.Official:

Repository Stars
ferventdesert/Hawk
visualized crawler & ETL IDE written with C#/WPF
lay295/TwitchDownloader
Twitch VOD/Clip Downloader - Chat Download/Render/Replay
workspacer/workspacer
a tiling window manager for Windows
4sval/FModel
Unreal Engine Archives Explorer
Ruben2776/PicView
Fast, free and customizable image viewer for Windows 10 and 11.
Version Downloads Last updated
1.8.5 5,772 2/19/2024
1.8.4 32,053 8/20/2023
1.8.3 17,273 6/12/2023
1.8.2 4,914 5/17/2023
1.8.1 4,684 5/1/2023
1.8.0 4,158 4/19/2023
1.7.7 8,578 3/3/2023
1.7.6 32,123 11/1/2022
1.7.5 14,791 8/25/2022
1.7.4 9,783 7/14/2022
1.7.3 7,394 6/13/2022
1.7.2 4,157 6/6/2022
1.7.1 3,368 6/1/2022
1.7.0 117,365 7/17/2021
1.6.4 51,935 11/5/2020
1.6.3 24,861 9/15/2020
1.6.2 3,563 8/28/2020
1.6.1 1,836 8/28/2020
1.6.0 21,792 4/7/2020
1.5.8 27,020 11/1/2019
1.5.7 11,747 9/10/2019
1.5.6 9,559 8/21/2019
1.5.5 5,451 8/10/2019
1.5.4 7,001 7/19/2019
1.5.3 8,232 6/7/2019
1.5.2 2,795 5/29/2019
1.5.1 37,001 3/6/2019
1.5.0 5,708 1/26/2019
1.4.11 20,741 8/2/2018
1.4.10 7,030 6/11/2018
1.4.9 6,459 4/12/2018
1.4.7 6,211 2/10/2018
1.4.6 3,890 12/24/2017
1.4.5 2,899 12/6/2017
1.4.4 3,396 11/16/2017
1.4.3 7,589 8/5/2017
1.4.2 4,493 6/20/2017
1.4.1 2,332 6/19/2017
1.4.0 3,223 4/25/2017
1.3.2 21,497 9/3/2016

* Fixed Polish translation.
* Fixed an issue where Update, Remind Later and Skip button wasn't visible on lower resolution displays.
* Exposed Mandatory property to developers. Now they can set it to true from code.
* Fixed an issue that causes the application to close even if user press No on UAC prompt after the download completes.