Skip to content
Lightweight installer/updater for portable desktop applications
Go
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src
.gitignore
LICENSE
README.md
appveyor.yml
ministaller.png

README.md

ministaller

Lightweight installer/updater for desktop application written in Go

alt tag

Build status Codacy Badge

Description

This updater is meant for simple safe update of distribution of some main application from update in zip archive. It is capable of partial and full updates (controlled by cmd line parameters) as well as downloading an update with SHA1 hashsum check afterwards. The GUI with simple progress bar is implemented only for Windows OS using direct Win API calls.

It compiles to a fully standalone executable which can be distributed along with the main application. It can be treated as a lightweight and simplified version of a MaintananceTool from Qt world.

Build

General instructions

go get github.com/Ribtoks/gform
git clone https://github.com/Ribtoks/ministaller.git
cd ministaller/src
go build -o ministaller.exe -ldflags="-H windowsgui"

Check out the appveyor.yml file for detailed build instructions.

x86 instructions only

For native look and feel in Windows it's needed to build an application manifest and embed it as a resource. This is already done for x64 platforms and you don't need to do anything except of go build. For x86 you will need to install rsrc tool via go get and build enclosed manifest for it:

go get github.com/akavel/rsrc
rsrc -manifest ministaller.manifest -arch 386 -o rsrc.syso

and only then build ministaller.

Usage

Command line switches:

-install-path string
    Path to the existing installation directory
-package-path string
    Path to package with updates
-keep-missing
    Keep local files not found in the update package
-force-update
    Overwrite same files if found locally and in the update
-gui
    Show simple progress GUI (works only for Windows at this time)
-l string
    Absolute path to the log file (default "ministaller.log")
-launch-exe string
    Relative path to the exe to launch after install
-stdout
    Log to stdout and to logfile
-url string
    Url to the package to download (instead of -package-path switch)
-hash string
    SHA1 Hash of the downloaded file to check

Sample usage from Qt application is:

const QString appDirPath = QCoreApplication::applicationDirPath();
QDir appDir(appDirPath);

QDir documentsDir(QStandardPaths::writableLocation(QStandardPaths::DocumentsLocation));
const QString logFilePath = documentsDir.filePath("ministaller.log");

QStringList arguments;
arguments << "-force-update" << "-gui" <<
             "-install-path" << installPath <<
             "-l" << logFilePath <<
             "-launch-exe" << "your-main-app.exe" <<
             "-package-path" << packagePath <<
             "-stdout";

QProcess::startDetached(appDir.filePath("ministaller.exe"), arguments);

This code worked for me with paths with non-latin and Unicode symbols in Windows 10.

Disclaimer

Theoretically such an application is useless for full update on other platforms but Windows, because OS X has dmg packages which can simply override previous contents (and Sparkle framework otherwise) and updates in Linux and many other *nix systems are propagated through repositories (or ports).

You can’t perform that action at this time.