Systemvoraussetzungen

Bevor Sie Nuclos erfolgreich installieren, muss Ihr System diese Voraussetzungen erfüllen:

Java JDK

Aktuell empfehlen wir Java 11, sowohl für das Oracle Java als auch für OpenJDK.

Nuclos Download

Laden Sie die aktuelle Version des Installationsprogramm auf http://www.nuclos.de herunter.

Grafisch-interaktive Installation


Windows

nuclos-<version>-installer-windows32.exe
nuclos-<version>-installer-windows64.exe


Linux & Mac OS X

java -jar nuclos-<version>-installer-linux32.jar
java -jar nuclos-<version>-installer-linux64.jar

Der Assistent führt Sie anschließend durch die Installation.

Textuell-interaktive Installation (für Kenner)

Bitte wählen Sie die textuell-interaktive Installation, wenn Ihr Betriebssystem nicht über eine grafische Benutzeroberfläche verfügt oder wenn Sie beispielsweise über SSH die Installation durchführen. Für die textuell-interaktive Installation verwenden Sie bitte den Download nuclos-<version>-installer-generic.jar, und rufen Sie diesen wie folgt aus:

java -jar nuclos-<version>-installer-generic.jar -c

Der Parameter -c stellt dabei sicher, dass die Abfrage der Einstellungen text-basiert erfolgt. Der Assistent führt Sie anschließend durch die Installation.

Sollte die obige Variante nicht funktionieren, kann der Installer mit folgender Alternative gestartet werden:

java -D java.awt.headless=true -jar nuclos-<version>-installer-generic.jar


Grafisch-interaktive Installation

Starten Sie den Installer per Doppelklick.


Startdialog des Nuclos-Installers


Bitte lesen Sie die Lizenzvereinbarungen und akzeptieren Sie diese. Danach geht es weiter.


Bei Neuinstallation:

Wählen Sie ein Verzeichnis, in das der Nulcos-Server installiert werden soll.

Das Verzeichnis muss leer sein !


  • PostgreSQL installieren und eine neue Datenbank einrichten: Wählen Sie diese Option, wenn Sie eine PostgreSQL Datenbank verwenden möchten und diese noch nicht auf Ihrem System installiert haben. Der Nuclos-Installer übernimmt die Neuinstallation des Datenbank-Servers für Sie. (empfohlen)

  • eingebettete H2 Datenbank ohne Installation verwenden: Wählen Sie die Option der H2 Datenbank, wenn Sie keinen Datenbank-Server installieren möchten sondern Nuclos nur temporär verwenden oder testen möchten. In diesem Fall werden die Daten im Verzeichnnis <nuclos-server>/data abgelegt.


  • eine neue Datenbank auf einem existierenden PostgreSQL Server einrichten: Ein PostgreSQL-Server ist auf Ihrem System bereits installiert. Der Nuclos-Installer legt auf dieser Instanz ein neues Schema an.


Nun folgen die Angaben zur Datenbank (Beispiel Postgres)

  • Host: Hostname des Systems, auf dem der Datenbankserver läuft / localhost
  • Port: Datenbankport / 5432
  • Superuser Name/Passwort: Login-Informationen des Datenbank-Administrator Zugangs. Wird z.B. benötigt, um ein neues Schema zu erzeugen. ( Bei Neuinstallation geben Sie bitte postgres für Superuser Name und Passwort an).
  • Datenbankname: Name der Datenbank auf dem Zielsystem (hier: nuclosdb)
  • Benutzername/-passwort: Benutzerlogin für die Nuclos-Datenbankinstanz (hier: nuclos)
  • Schemaname: Schemaname (hier: nuclos)
  • Tablespacename/-pfad: manche Datenbanken verlangen einen Tablespace. Wird hier nichts angegeben, wird der Default verwendet (leer)

Klicken Sie auf "Verbindung testen" um herauszufinden, ob alle Angaben korrekt eingegeben wurden und eine Verbindung zum Datenbankserver hergestellt werden kann. Wenn nicht, überprüfen Sie ihre Angaben bzw. ob evtl. Rechteeinschränkungen bestehen.


Nun folgen die Angaben zur Nuclos-Server-Instanz.

  • Java Installationspfad: Pfad in das Home-Verzeichnis der Java-Installation (JDK wird benötigt Java 8 oder Java 11).

Die aktuellen Nuclos-Versionen laufen nur mit Java 11 oder Java 8 (siehe Systemvoraussetzungen). Wir empfehlen, Java 11 zu nutzen.

  • Instanzname: in Windows-Systemen wird mit diesem Name ein Dienst eingerichtet.
  • Pfad der Dokumentenablage: gibt das Home-Verzeichnis an, in dem in Nuclos hochgeladene Dokumente gespeichert werden. Dieser Pfad kann über Einstellungen im Businessobjekt noch weiter verfeinert werden.

  • Pfad der Indexablage: gibt das Home-Verzeichnis für den Lucene-Indexer. Sie können diesen Mechanismus auch deaktivieren, in dem hier "off" eingetragen wird.

Wichtig ist, dass das Installationsprogramm, wie auch die später laufende Nuclos-Instanz für die gesetzten Verzeichnisse Schreibrechte besitzen. Andererseit können keine Daten hinterlegt werden und es kommt zu Fehlern.


Das Dokumentenverzeichnis kann im Gegensatz zum Index-Pfad nur bei der Erstinstallation gesetzt werden.
Bei jedem folgenden Update ist das Feld ausgegraut und kann nicht mehr verändert werden.
Ist dies dennoch gewünscht, kann das manuell wie folgt vorgenommen werden

  1. Pfad direkt in nuclos.xml ändern

    <nuclos>
    <server>
        <home>C:\nuclos</home>
        <name>nuclos</name>
        <documentPath>C:\nuclos\data\documents</documentPath>
        <indexPath>C:\nuclos\data\index</indexPath>

		...
    </server>
    ...
</nuclos>


  2. Installer ausführen

    Mit den Änderungen aus Schritt 1) übernimmt der Installer beim Update die Werte aus der nuclos.xml und verwendet diese bei den weiteren Installationsschritten.

  3. Dokumente manuell in das neue Verzeichnis umkopieren.
  • HTTP/HTTPS-Port: Port über den sich die Clients mit dem Server verbinden.
  • Shutdown-Port: Port, der für das Beenden des Nuclos-Serverdienstes verwendet wird.
  • Connection Thread Pool-Größe (ab Nuclos 4.50 / nicht im Screenshot enthalten):  Thread Pool für die Bearbeitung von Client Anfragen (Default 200). Hier empfiehlt sich ein Wert entsprechend dieser Formel: (Connection Pool-Größe) / 1.1 + (Anzahl der maximal zu erwarteten laufenden Javaclients)
  • Server-Heap-Größe: Maximale Speichervergabe für den Nuclos-Server

  • Produktivumgebung / Entwicklungsumgebung: In einer Entwicklungsumgebung wird zusätzlich ein Debug Port geöffnet, über den man mittels einer IDE (z.B. Eclipse) Regeln zur Laufzeit debuggen kann.

    Bis Java 8 bindet der JDWP-Agent standardmäßig gegen "*" (also alle Adressen) wenn beim Parameter "address" nur der Port angegeben wird. Ab Java 9 wird standardmäßig gegen "localhost" gebindet.
    Statt des Ports kann bei "Debug Port" auch zusätzlich die IP-Adresse (oder der Bereich) angegeben werden, von der die Debug-Schnittstelle erreichbar sein soll. Der Wert "0.0.0.0:8000" sorgt bspw dafür, dass die Debug Schnittstelle von allen Netzwerkadressen aus auf Port 8000 zu erreichen ist. "localhost:8000" würde den Zugriff auf Port 8000 so einschränken, dass dieser nur noch von dem Server erreichbar ist, auf dem der Nuclos-Server läuft.


  • Beim Systemstart ausführen: unter Windows wird der Nuclos-Dienst automatisch gestartet
  • Cluster Betrieb: TODO
  • AJP Port: Port für den Betrieb von Nuclos hinter einem ReverseProxy 




  • Start als Single-Instance: ein Anwender darf auf einem Rechner nur eine Nuclos-Instanz geöffnet haben.
  • Desktopclient installieren: installiert den Rich-Client und stellt den Startbutton auf der Startseite zur Verfügung.
  • Launcher aktivieren: aktiviert den Nuclos Launcher als Startmöglichkeit
  • Webclient installieren: installiert den Webclient und stell den Startbutton auf der Startseite zur Verfügung. Die URL stellt den direkten Aufrufpfad für den Webclient dar.
  • Server host: Standalone Client
  • Java Runtime: Standalone Client

(In Entwicklung)

In diesem Schritt können die Sprachen ausgewählt werden, bei der Anmeldung unter Region/Sprache zur Verfügung stehen sollen. Das ist die Sprache, in der Nuclos selbst und die Nuclets angezeigt werden (Oberflächensprache).

Das ist nicht zu verwechseln mit der Datensprache, die bestimmt in welcher Sprache die Datensätze der BusinessObjekte angezeigt werden. Die Datensprache wird unter Administration > Datensprache separat definiert.

Fett geschriebene Sprachen sind in Nuclos übersetzt. Ist keine Übersetzung für einen Nuclos-Begriff vorhanden, so wird Englisch verwendet.

Die aktivierten Sprachen stehen für die Übersetzungen in den Nuclets zur Verfügung. Steht keine Übersetzung zur für eine Sprache (z.B. Deutsch (Schweiz)) zur Verfügung, so wird  (sofern vorhanden) die Hauptsprache verwendet (hier: Deutsch (Deutschland)). Ist auch diese nicht vorhanden, so wird die Primärsprache verwendet.

Weitere Informationen zur Internationalisierung finden Sie hier.


In diesem Schritt wird die Installation durchgeführt. Das kann, je nachdem ob PostgreSQL ebenfalls intalliert wird, einige Minuten dauern.

Im Anschluss werden Sie gefragt, ob der Server gestartet werden soll. Wenn ja, wird der Dienst gestartet.


Wenn das Datenbankschema leer ist bzw. bei einer Neuinstallation werden beim Hochfahren des Servers alle nuclosinternen Tabellenstrukturen angelegt.


War die Installation erfolgreich, folg der Abschlussdialog des Installers. Ist die Checkbox aktiviert, wird der Standardbrowser geöffnet und die Nuclos-Startseite angezeigt:

Textuell-interaktive Installation 

ERROR StatusLogger No log4j2 configuration file found. Using default configuration: logging only errors to the console.
Installer for Nuclos version 4.12.0-SNAPSHOT (2016-09-20 15:14:10)
Installation will be logged to /tmp/nuclos-installer_2016-09-21_11-28.log.
Target installation path [/opt/nuclos]:
Installing Nuclos to target directory /opt/nuclos.
Please enter database settings:
Database setup option (setup, use) [setup]:setup
Database server [localhost]:dbhost
Database port [null]:5432
PostgreSQL superuser [null]:nuclos
PostgreSQL superuser password [null]:**********
Database name/instance [nuclosdb]:finedb
Database username [nuclos]:
Database password [nuclos]:**********
Schema name [nuclos]:
Tablespace (optional) [null]:
PostgreSQL tablespace path [null]:
Please enter Nuclos server settings:
JRE installation path (JRE Version >= 1.7.0_09) [/opt/java/jdk1.7.0_79]:
Nuclos instance name [nuclos]:
Path of document files [/opt/nuclos/data/documents]:
Path of index files [/opt/nuclos/data/index]:
Communication protocol (http or https) [http]:
Http port [80]:
Shutdown port [8005]:
Heap size in MB [1024]:
Launch on startup [null]:true
Please enter Nuclos client settings:
Single instance mode (webstart only, true/false) [false]:false
Install desktop client (true/false) [true]:true
Install web client (true/false) [true]:true
Server host (optional for stand-alone client) [localhost]:serverhost
Java Runtime (optional for stand-alone client) []:
Setting up database...
Extracting files...
/opt/nuclos/bin
/opt/nuclos/conf
. . . . .
. . . . .
Do you want to start the Nuclos server now?(Y/N)Y
Installation finished



Automatisierte Installation

Sie können das Nuclos-Installationsprogramm (sofern es als *.jar-datei vorliegt, also z.B. nuclos-<version>-installer-generic.jar) auch parametrisiert starten, wenn Sie eine Interaktion mit dem Benutzer nicht wünschen, z.B. um die Installation automatisiert auszuführen. Um die Installationseinstellungen als Parameter an den Installer übergeben zu können, erstellen Sie bitte eine XML-Datei mit beliebigem Namen und folgender Struktur:

<?xml version="1.0"?>
<nuclos>
  <server>
    <home><!-- installation path --></home>
    <name><!-- instance name --></name>
    <http>
      <enabled>true</enabled>
      <port>80</port>
    </http>
    <https>
      <enabled>false</enabled>
      <port>$443</port>
      <keystore>
        <file>/home/.keystore</file>
        <password>keystore-passord</password>
      </keystore>
    </https>
    <shutdown-port>8005</shutdown-port>
    <heap-size>1024</heap-size>
    <java-home>/opt/java</java-home>
    <launch-on-startup>true</launch-on-startup>
  </server>
  <client>
    <singleinstance>false</singleinstance>
  </client>
  <database>
    <adapter>postgresql</adapter>
    <driver>org.postgresql.Driver</driver>
    <driverjar></driverjar>
    <connection-url>jdbc:postgresql://localhost:5432/postgres</connection-url>
    <username>nuclos</username>
    <password>nuclos</password>
    <schema>nuclos</schema>
    <tablespace>dat_nuclos</tablespace>
    <tablespace-index></tablespace-index>
  </database>
</nuclos>

Die Erläuterung der einzelnen Konfigurationselemente finden Sie unter Beschreibung der Konfigurations Datei nuclos.xml.

Wechseln Sie nun in der Kommandozeile in das Verzeichnis, in dem die *.jar-Datei liegt und führen Sie den Installer mittels

 java -jar nuclos-<version>-installer-generic.jar -s <Pfad zur Konfigurationsdatei>

aus. Der Parameter -s legt dabei fest, dass die Installation ohne Interaktion ausgeführt wird. Sollten Fehler oder Wanrungen auftreten, bricht das Installationsprogramm mit der entsprechenden Fehlermeldung ab.

Wenn Sie eine vorhandene Installation (> 3.0.0) mit diesem Modus aktualisieren möchten, verwenden Sie bitte als Konfigurationsdatei die Datei <nuclos-home>/nuclos.xml.

Nuclos aktualisieren

Wenn Nuclos auf Ihrem Server bereits installiert ist, folgen Sie den Anweisungen dieses Kapitels, um Ihre bestehende Installation von Nuclos auf die neueste Version von Nuclos zu aktualisieren. Wenden Sie sich bei Fragen oder auftretenden Schwierigkeiten an das Nuclos Forum unter http://forum.nuclos.de. Bitte stoppen Sie vor jeder Aktualisierung den Nuclos Server (schließen Sie vorher sicherheitshalber alle offenen Nuclos Clients, damit keine Daten verlorengehen, die durch Ihre Anwender gerade bearbeitet werden) und erstellen Sie ein Backup der Datenbank und des Installationsverzeichnisses.

Aktualisierung von Nuclos-Installation mit einer Version größer oder gleich 3.0.0

Wenn Sie eine Nuclos-Installation mit einer Version größer oder gleich 3.0.0 starten Sie das Installationsprogramm analog zur Erstinstallation. Wenn Sie als Installationspfad das Verzeichnis einer bereits vorhandenen Installation auswählen, werden die Einstellungen der letzten Installation automatisch geladen. Bevor die Aktualisierung durchgeführt wird, können Sie nochmal alle Einstellungen überprüfen.

Aktualisierung von Nuclos-Installation mit einer Version kleiner 3.0.0

Wenn Sie eine Nuclos-Installation mit einer Version kleiner 3.0.0 aktualisieren möchten, sollten Sie den Download nuclos-<version>-installer-generic.jar verwenden. Starten Sie das Installationprogramm bitte wie folgt (<Pfad zur alten nuclos.xml> := Nuclos 2.6: „<jboss-home-dir>/server/<server-name>/nuclos.xml“; Nuclos 2.7.*: „<tomcat-home-dir>/webapps/<server-name>/WEB-INF/nuclos.xml“):

java -jar nuclos-<version>-installer-generic.jar <Pfad zur alten nuclos.xml>

Nuclos 3.0.0 kann nicht in dasselbe Verzeichnis installiert werden, in das Sie bereits eine ältere Version von Nuclos installiert haben, daher müssen Sie einen neuen leeren oder noch nicht vorhandenen Zielpfad wählen. Das Verzeichnis der alten Installation können Sie nach erfolgreich durchgeführtem Update automatisch vom Installationsprogramm löschen lassen (bitte erstellen Sie sicherheitshalber eine Sicherheitskopie). Um eine ältere Version von Nuclos zu aktualisieren, muss der Installer gewisse Dateien (z.B. gespeicherte Dokumentanhänge) aus dem Verzeichnis der alten Installation in das Verzeichnis der neuen Installation kopieren. Wenn Sie Ihre bereits existierende Konfigurationsdatei aus dem JBoss- (Nuclos 2.6.*) oder Tomcat-Verzeichnis (Nuclos 2.7.*) beim Update verwenden, wird der Generic Installer nach Rückfrage automatisch eine Migration der Dateien vornehmen.

Nuclos Server starten und stoppen

Um Nuclos verwenden zu können, müssen Sie zuerst den Nuclos Server starten. Sollten Sie bei der Installation die Option "Beim Systemstart starten" nicht aktiviert haben, müssen Sie dies manuell durchführen. Die folgende Tabelle zeigt, wie Sie den Nuclos Server als Dienst (falls Nuclos mit Administrationsberechtigungen installiert wurde) bzw. per Script (falls Nuclos nicht mit Administrationsberechtigungen installiert wurde) starten können. Um Nuclos als Dienst starten zu können, müssen Sie den jeweiligen Befehl i.d.R. mit Administrationsberechtigungen ausführen.


WindowsLinuxMac OS XAndere Unix-ähnliche Systeme
Dienst startennet start nuclos.<instance>

Debian: /etc/init.d/nuclos.<instance> start

Ubuntu: service nuclos.<instance> start

launchctl start org.nuclos.<instance>n/a
Dienst stoppennet stop nuclos.<instance>

Debian: /etc/init.d/nuclos.<instance> stop

Ubuntu: service nuclos.<instance> stop

launchctl stop org.nuclos.<instance>n/a
Mit Script starten<nuclos-home>\bin\startup.bat<nuclos-home>/bin/startup.sh
Mit Script stoppen<nuclos-home>\bin\shutdown.bat<nuclos-home>/bin/shutdown.sh

Den Nuclos Client starten Sie anschließend über Ihren Webbrowser mit dem Aufruf http://localhost:<http-port>/<instance> bzw. https://localhost:<https-port>/<instance> - je nachdem, welches Kommunikationsprotokoll Sie bei der Installation aktiviert haben. Wenn Sie den Nuclos Client nicht direkt auf dem Nuclos Server starten, sondern auf einem anderen Rechner, ersetzen Sie „localhost“ durch die IP-Adresse oder den Servernamen Ihres Nuclos Servers.

Um sich an Nuclos erstmalig anzumelden, verwenden Sie bitte den Benutzernamen „nuclos“ und ein leeres Passwort. Weitere Benutzer können Sie dann innerhalb Nuclos hinzufügen, ebenso können Sie innerhalb von Nuclos das Passwort ändern.