NSIS Tutorial Teil 1

Einleitung

Die meisten Anwendungen kommen mit einem Installations-Programm, das die benötigten Dateien in die richtigen Ordner kopiert, Registry-Einträge erstellt und Deinstallations-Routinen bereitstellt, um die Anwendung (hoffentlich) wieder sauber vom Computer zu entfernen.

Um selber entwickelte Anwendungen mit einem Installer auszustatten gibt es verschiedene Lösungen. Neben kommerziellen Produkten wie Install Shield oder Wise gibt es auch das OpenSource-Installationstool Nullsoft Scriptable Install System (NSIS). In diesem Tutorial zeige ich einige einfache Schritte, um einen Installer mit NSIS zu erstellen.

Im ersten Teil erläutere ich einige Grundlagen und wir erstellen den ersten richtigen Installer. Der zweite Teil behandelt die Themen Uninstall und weitere Dialoge für den Installer. Im dritten Teil gebe ich den Installern ein moderneres Erscheinungsbild.

Download und installation

NSIS kann unter http://nsis.sourceforge.net/Download heruntergeladen werden. Danach startet man die heruntergeladene Datei, welche NSIS installiert. Normalerweise können die vorgegebenen Werte übernommen werden.

Grundlagen

NSIS erzeugt eine Installationsdatei, die alle zu installierenden Dateien und das Installationsscript enthält. Dazu muss man ein NSIS Script erstellen, welches die Installationsschritte beschreibt. Ein NSIS Script ist eine normale Textdatei, die mit jedem Texteditor bearbeitet werden kann. Da NSIS bei Fehlermeldungen die betroffene Zeile angibt, ist es von Vorteil, einen Texteditor zu benutzen, der die Zeilennummern anzeigen kann.

Im Wiki von NSIS hat es eine Auflistung von Editoren speziell für NSIS. Ich benutze für dieses Tutorial den HM NIS Edit.

NSIS Script-Dateien haben die Dateiendung .nsi. NSIS Scripts können zur besseren Übersicht auch in mehrere Dateien aufgeteilt werden, indem man Funktionen oder Makros in Header-Dateien auslagert. Die Headerdateien erhalten dann die Dateiendung .nsh und werden mit dem Befehl !include eingebunden.

Kommentare werden mit einem Semikolon – ‚;‘ – begonnen und enden mit dem Zeilenende. Auch alle Befehle enden mit dem Zeilenende. Wenn sich ein Befehl über mehrere Zeilen erstrecken soll muss am Zeilenende ein Backslash – ‚\‘ – hizugefügt werden.

Hello World!

Als erstes „Installer“-Script erstellen wir das berühmte „Hello World“ Beispiel. Dazu muss in einem Text-Editor folgender Text eingegeben werden:

Name "Hello World"
OutFile "helloworld.exe"
Section "Hello World"
MessageBox MB_OK "Hello World!"
SectionEnd

Dieser Text wird nun unter dem Dateinamen „helloworld.nsi“ abgespeichert. Nun  kann der Compiler gestartet werden. Entweder direkt über den Editor (z.B. mit HM NIS Edit) oder über die Kommandozeile mit:

<Pfad zu NSIS>\makensis.exe <Pfad zu Script>\helloworld.nsi

Wenn das Script fehlerfrei kompiliert werden konnte sollte eine Datei mit dem Namen „helloworld.exe“ im Spriptordner erstellt worden sein. Durch Starten dieser Anwendung sollte ein Installer-Fenster erscheinen und davor eine MessageBox mit dem Text „Hello World!“.

NSIS HelloWorld Installer

NSIS HelloWorld Installer

Erklärung der benutzten Befehle:

Name

Setzt den Namen des Installers. Normalerweise entspricht er dem Namen der Anwendung, Z.B. „MyApp“. Wenn der Name ein oder mehrere ‚&‘ enthält, muss als zweiter Parameter der Name mit verdoppelten ‚&‘ angegeben werden, z.B.

Name "Super &amp; Co.'s MegaApp" "Super &amp;&amp; Co.'s MegaApp"

OutFile

Setzt den Namen der Ausgabe-Datei. Kann auch den Pfad enthalten, z.B.

OutFile "C:\Temp\Output.exe"

Section

Startet einen neuen Bereich. Bereiche können auch versteckt werden, optional sein oder für den Uninstaller verwendet werden. Der Bereich wird mit SectionEnd abgeschlossen.

MessageBox

Zeigt ein Meldungsfenster mit den angegebenen Optinen („Zeige den OK-Button“) und dem angegebenen Text an.

Erster „richtiger“ Installer

Um auch wirklich etwas auf der Harddisk abzulegen braucht es nicht viel mehr:

Name "First Installer"
OutFile "firstinstaller.exe"
InstallDir $PROGRAMFILES\MyFirstInstaller
Page directory
Page instfiles
Section ""
SetOutPath $INSTDIR
File C:\Windows\system32\notepad.exe
SectionEnd

Name und OutFile kennen wir ja schon aus dem HelloWorld-Installer. InstallDir setzt den Default-Installationspfad. Mit der Konstanten $PROGRAMFILES wird der konfigurierte Programme-Ordner (bei einer deutschen Windows-Version „C:\Programme\“, bei einer englischen „C:\Program files“) angesprochen. In diesem Beispiel wird deshalb als Default-Ordner unter einer deutschen Windows-Version „C:\Programme\MyFirstInstaller“ verwendet. Mit dem Befehl Page geben wir an, welche Seiten im Installer angezeigt werden sollen. In diesem Fall wird zuerst der Dialog für die Installationsordner-Abfrage angezeigt. Danach folgt der eigentliche Installations-Dialog, in welchem die Dateien kopiert werden.

Innerhalb der Section wird dann mit SetOutFolder der Ordner für die Installation bestimmt und auch erzeugt. Mit File werden die Dateien angegeben, die in den Installationsordner extrahiert werden sollen.

Ausblick

Im zweiten Teil werden wir unserem Installer auch die Möglichkeit geben, das Programm wieder zu deinstallieren. Zudem werden wir ein Paar weitere Pages anschauen und dem Benutzer die Möglichkeit geben, bestimmte Teile der Installation auszuwählen. Im dritten Teil werden wir dann ein dem Installer mit dem ModernUI ein moderneres Erscheinungsbild geben.

5 Gedanken zu „NSIS Tutorial Teil 1

  1. Pingback: Neues Design der Webseite | of bits and bytes

  2. Pingback: NSIS Tutorial in c’t 16/2014 | of bits and bytes

  3. Jürgen Wörner

    Kann man nsis auch einsetzen für projekte, die in Visual Studio Express 2012 erstellt wurden?

    Wenn ja, wie findet man heraus, welche Dateien notwendig sind?

    Gruß Jürgen

    Antworten
    1. Roland Bär Beitragsautor

      Hallo Jürgen

      NSIS ist nicht von der Entwicklungsumgebung oder der Programmiersprache abhängig. Wichtig ist nur, dass Du alle nötigen Dateien im Installer mitlieferst.
      Um herauszufinden, welche Dateien nötig sind ist es dann relevant, mit welcher Programmiersprache die Anwendung geschrieben wurde. Wenn Du Visual Studio erwähnst, nehme ich an, dass es entweder C++, VB.NET oder C# sein dürfte.
      Bei C++ kann Dir das Tool Dependency Walker weiterhelfen. Bei einer .NET-Anwendung ist es wichtig, dass das .NET-Framework in der passenden Version installiert ist und die zusätzlichen Referenzen (z.B. log4net etc.) durch NSIS installiert werden.
      Hilfe zum Einbinden des .NET-Framework-Installers in NSIS findest Du im NSIS-Wiki.
      Ich hoffe, Dir damit weiter geholfen zu haben.

      Antworten
    2. brocel1

      selbstverständlich. Du musst in deinem visualstudiprojekt in den Release-Mode wechseln. Anschließend debbugst du das Projekt. Danach finden sich die benötigten Dateien in dem Releaseordner. Hier mal kleiner Aufbau eines Programmes.

      Name „test v1.1 Setup“
      OutFile „testSetup.exe“

      !define INSTALLATIONNAME „Testprogramm“
      InstallDir $PROGRAMFILES\${INSTALLATIONNAME} ;Speichert Inhalt in C:\Programme 86\Testprogramm

      Page directory
      Page instfiles

      Section „“
      SetOutPath $INSTDIR ;kopiert alle nachfolgenden Dateien in den Ornder $INSTDIR. (also C:\Programme 86\Testprogramm)

      File ..\HelloWorld\bin\Release\HelloWorld.exe
      File ..\HelloWorld\bin\Release\HelloWorld.exe.config
      File ..\HelloWorld\bin\Release\HelloWorld.vshost.exe.config
      ;File ..\HelloWorld\bin\Release\app.config
      ;File ..\HelloWorld\bin\Release\log4net.dll ;verwendete .dll auch mit einbinden

      ;Verknüpfungen Desktop/Startmenü
      CreateShortCut „$DESKTOP\${Installationname}.lnk“ „$INSTDIR\HelloWorld.exe“ „“
      CreateDirectory „$SMPROGRAMS\${INSTALLATIONNAME}“
      CreateShortCut „$SMPROGRAMS\${INSTALLATIONNAME}\${Installationname}.lnk“ „$INSTDIR\HelloWorld.exe“ „“ „$INSTDIR\HelloWorld.exe“ 0
      SectionEnd

      Das wars. Kopier den Inhalt in eine .txt-Datei und benenne sie „meinSkript.nsi“. Damit der Installer die Dateien auch finden kann muss dein Projektordner so aufgebaut sein:

      Erstelle einen Ordner mit dem Namen „Installer“. In diesem fügst du die meinSkript.nsi-Datei ein. Der Ordner „Installer“ muss im selben Ordner liegen, wie der Ordner „HelloWorld“. Dann funktioniert es. Die Funktion File .. bezieht sich irgendwie auf den Ordnerpfad, in dem der Installer ausgeführt wird. Falls du es nicht hinbekommst, kannst du auch feste Pfade verwenden z.b. File C:\USER\Desktop\MeinProgramm\HelloWorld\bin\Release\..

      Klicke mit Rechtsklick auf das Skript und wähle die Funktion „Compile NSIS Scirpt“. Anschließend öffnet sich ein Fenster, der dir anzeigt, was passiert. Ist beim Übersetzten ein Fehler aufgetreten, so wird er dort angezeigt. Anschließend starte die testSetup.exe. (als Admin, wenn du Schreibrechte benötigtst). Anschließend kopiert er die alle Dateien , die du mit File .. angegeben hast, in das Installationsverzeichnis und erstellt auf dem Desktop sowie im Startmenü eine Verknüpfung.

      Nun müsste dein Visualstudioprojekt ausführbar sein. Wenn nicht, fehlen dir noch Dateien, wie .dll’s.

      Antworten

Schreibe einen Kommentar

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert.