ContractManager baut auf der Jameica-Plattform auf. Sofern Sie Jameica schon installiert haben (z. B. weil Sie Hibiscus nutzen), fahren Sie mit Schritt 2 fort. Andernfalls laden Sie zunächst Jameica herunter: https://www.willuhn.de/products/jameica/download.php (mindestens Jameica 2.6.4). Achtung: ContractManager benötigt mindestens Java 8 (anders als Jameica, was auch noch mit Java 7 lauffähig ist).

1. Starten Sie Jameica/Hibiscus (durch Ausführen der entsprechenden .exe- oder .sh-Datei). Setzen Sie (sofern noch nicht geschehen) ein Master-Passwort.
2. Gehen Sie im Menü auf „Datei“, „Plugins online suchen…“.
3. Klicken Sie auf „Repositories bearbeiten“, dann auf „Neues Repository hinzufügen“.
4. Geben Sie im Eingabefeld http://janrieke.de/products/jameica/updates/ ein und klicken Sie auf „Übernehmen“, anschließend (im Plugin-Repositories-Dialog) auf „Schließen“, dann unten rechts auf „Speichern“.
5. Wechseln Sie auf den Reiter „Verfügbare Plugins“.
6. Wählen Sie den neuen Repository-Eintrag mit der eben eingegebenen URI aus. Sofern der ContractManager noch nicht installiert ist, sehen Sie mindestens einen Eintrag für ein ContractManager-Plugin.
7. Wählen Sie die ContractManager-Version aus, die Sie installieren wollen, und klicken Sie auf „Installieren…“.¹⁾
8. Wählen Sie „Ja“, „Ja“, and „Übernehmen“.
9. Starten Sie Jameica neu. ContractManager ist jetzt installiert.

Sofern die automatische Suche nach Updates in Jameica aktiviert ist, werden Sie über neue ContractManager-Versionen benachrichtigt. Falls nicht, können Sie manuell über „Datei“, „Einstellungen“, Reiter „Plugins“, Reiter „Updates“ nach Updates suchen.

ContractManager befindet sich noch im Beta-Stadium; es könnten daher noch Fehler vorhanden sein. Fertigen Sie deshalb regelmäßige Datensicherungen an.

Normalerweise speichert ContractManager seine Daten in einer verschlüsselten H2-Datenbank im Benutzerverzeichnis. Alternativ ist seit Version 0.5.3 auch eine Nutzung einer eigenen Datenbank möglich, so dass z.B. von mehreren Rechnern aus auf die Daten zugegriffen werden kann.

Wichtiger Hinweis: Es handelt sich hierbei um ein experimentelles Feature. Es kann sein, dass einige Dinge nicht wie erwartet funktionieren. Zudem werden die Daten nicht (wie bei Verwendung der H2-Datenbank) automatisch beim Schließen von Jameica gesichert. Legen Sie daher regelmäßige Backups der Datenbank an!

Zunächst muss ein Datenbank-Benutzer für ContractManager erstellt werden. Außerdem benötigt ContractManager eine eigene Datenbank. (Im Folgenden gehen wir davon aus, dass der Datenbankname contractmanager lautet; der Name kann aber auch anders lauten.) Der Datenbank-Benutzer benötigt vollen Zugriff auf die Datenbank.

Als nächstes müssen die notwendigen Tabellen in der Datenbank angelegt werden.²⁾ Dazu muss das Skript in plugins/contractmanager/sql/mysql-create.sql auf der gerade erstellten Datenbank ausgeführt werden.

Zuletzt muss ContractManager so konfiguriert werden, dass auch die externe Datenbank benutzt wird. Dazu trägt man in cfg/de.janrieke.contractmanager.rmi.ContractDBService.properties folgende Zeilen ein:

database.driver=de.janrieke.contractmanager.server.DBSupportMySqlImpl
database.driver.mysql.jdbcurl=jdbc\:mysql\://<Server-IP>\:3306/contractmanager?useUnicode\=Yes&characterEncoding\=ISO8859_1&serverTimezone=Europe/Paris
database.driver.mysql.username=<Username des MySQL-Users>
database.driver.mysql.password=<Passwort des MySQL-Users>

Die Werte <Server-IP>, <Username des MySQL-Users> und <Passwort des MySQL-Users> mit dem Hostnamen oder der IP-Adresse des MySQL/MariaDB-Servers sowie Username und Passwort des MySQL-Benutzers ersetzen.

Die folgende Zeile muss gelöscht (oder mit # auskommentiert) werden:

database.driver=de.janrieke.contractmanager.server.DBSupportH2Impl

Die Zeilen, die mit database.driver.h2 beginnen, beziehen sich nur auf die H2-Datenbank. Sie können entfernt werden, sofern die H2-Datenbank nicht mehr benötigt wird (also alle Daten migriert sind).

Eine automatische Migration der Daten ist nicht möglich. Man kann aber die lokale H2-Datenbank öffnen und die Daten von dort manuell übertragen. Die Zugangsdaten zur H2-Datenbank finden sich nach dem Start des ContractManagers im Menü unter ContractManager → Über… → Datenbankinformationen.