AntonyHub - FAQ

Owned by mlinkwitz
Last updated: Jan 19, 2024 by Dennis Scheidner

Wie stelle ich den AntonyHub auf Beta oder Autobuild ein?

Um den AntonyHub mitzuteilen, dass man Betakunde sein möchte, sind ein paar manuelle Anpassungen an den Konfigurationsdateien notwendig.

Bisher ist es nicht geplant, diese Einstellungen per UI vorzunehmen, kann aber leicht nachgereicht werden.

  1. Anpassen der Konfiguration des AntonyHubClients (benutzerspezifisch)

Als erstes muss die Konfiguration des AntonyHubClients angepasst werden. Dazu muss die Datei "%LOCALAPPDATA%\antony Systemhaus GmbH\antonyHub.json" und "C:\Program Files\antony Groupware GmbH\AntonyHubService\config\appsettings.antonyHub.json" geöffnet werden. Diese Datei ist im Format JSON und enthält eine Eigenschaft “ReleaseType”, welche Standardmäßig auf 2 (Release) eingestellt ist. Die folgenden Werte sind definiert:

  • Release = 2

  • Beta = 1

  • AutoBuild = 0

Der Wert muss entsprechend auf 1 angepasst werden.

Wird als ReleaseType 0 (= AutoBuild) eingestellt, ist nicht garantiert, dass die Installation weiterhin funktionsfähig ist! AutoBuild ist für die Entwicklung vorgesehen, um schnelle Updatezyklen auf die internen Systeme zu realisieren.

Für AutoBuild Installation wird kein Support übernommen!

Nach Neustart des AntonyHubClients sollte nun ein Update angezeigt werden.

2. Anpassen der Konfiguration des AntonyHubServices (systemweit)

Der Service hat eine eigenständige Konfiguration. Die Trennung ist notwendig, damit der AntonyHubClient im Fehlerfall des Services diesen weiterhin updaten kann. Die Konfiguration des Services muss ebenfalls angepasst werden. Dazu die Datei "<Installationsordner>\config\appsettings.antonyHub.json" anpassen. Standardmäßig lautet der Pfad "C:\Program Files\antony Groupware GmbH\AntonyHubService\config\appsettings.antonyHub.json".

Der Aufbau der Datei ist identisch zu der des Clients. Der ReleaseType ist entsprechend zu ändern. Anschließend muss der AntonyHubService neugestartet werden.

Wie kann ich den AntonyHub einrichten, dass er lokale Cache Ordner aufräumt

Der AntonyHub hat ab der Version 3.22.61 die Fähigkeit Ordner in regelmäßigen Abständen nach zu löschenen Dateien zu durchsuchen und diese entsprechend zu entfernen. Diese Dateien werden anhand des Erzeugungsdatums erkannt und entfernt. “Lösche alle Dateien, welche älter sind als … “.

Konfiguration:

  • Lege eine neue Datei an unter <ANTONYHUB_INSTALLFOLDER>\config\appsettings.directorycleanup.json

    • z.B. C:\Program Files\antony Groupware GmbH\AntonyHubService\config\appsettings.directorycleanup.json

  • Der Inhalt sieht wie folgt aus:

{ "DirectoryCleanup:100": { "Folder": "C:\\tmp", "LessCreated": "1.00:00:00", "Recursive": false } }

Der Index (100) muss eindeutig in dieser Datei sein. Es darf nicht vorkommen, dass dieser doppelt vergeben wird. Der Index MUSS über 100 sein! Die Werte darunter sind für den Hub reserviert.

Was tue ich, wenn ein Dienst über die Web/ oder Desktop-Api nicht erreichbar ist?

Es kann passieren, dass ein Dienst im antonyHub als nicht erreichbar angezeigt wird. (siehe Abbildung)

Was ist zu tun?

  • Prüfen, ob der Zieldienst (Hier AntonyLegacyService) gestartet ist. Die Dienste lauten entsprechend der Anzeige im AntonyHub. Bei den AntonyLegacyServices lauten sie

    • AntonyMainService für die DesktopApi

    • AntonyWebService für die WebApi

  • Ist der Dienst gestartet, kann geprüft werden, ob er auf den richtigen Port hört. Den Port dazu findet man im Installationsverzeichnis des Dienstes unter “config/appsettings.autoconfig.json”. Im AntonyLegacyService muss in die configurationTabelle Name=”WebApiBasicConfiguration” geschaut werden. Alternativ in den Startup-Logs im “API” Log-Tag

    • Das Prüfen des Ports kann mit netstat -ano | find "<PID>" aufgerufen werden.

    • Es ist beispielsweise möglich, dass ein anderer Prozess diesen Port bereits belegt.

  • Ist der Dienst erreichbar, kann er probeweise angesurft werden. Dazu geht man auf “http://localhost:<port>/swagger/index.html”. Ist der Dienst verfügbar, öffnet sich eine Seite, in den die verfügbaren Calls aufgelistet werden (openapi)

    • Bei den AntonyLegacyServices ist dies leider nicht möglich. Hier kann nur ein selfcheck über curl durchgeführt werden. Dazu wird ein Call auf dem Port abgesetzt mit einem “?selfcheck” als Query.

  • Ist der Dienst erreichbar, aber der Gateway kann ihn trotzdem nicht ansprechen, muss die Konfiguration des Gateways geprüft werden. Die dazugehörigen Configurationen finden sich im “config” Unterordner des Gateway Installationsordners.

Es wird in AntonyHub ein Modul angezeigt, welches aber nicht im Client installiert werden kann.

Es gibt mehrere Möglichkeiten wieso ein Modul im Client nicht angezeigt wird. Um es schnell zu prüfen kann man in Antony-Hub Unterpunkt “Automatische Verteilung” den Status einsehen. Dort werden alle verfügbaren Module mit einer Meldung zum automatischen Verteilen eingeblendet.

Übliche Fälle lauten:

  • das Modul hat kein eigenes Paket, welches im Client installiert werden müsste.

  • ein Modul wird im Client nicht angezeigt, wenn das Modul eine Server Komponente hat, welche nicht installiert ist. In diesem Fall sollte der Antony-Hub die Installation des Servers auf dem Dashboard anbieten

Die Module werden unter Hilfe > Module nicht angezeigt

Es kann passieren, dass die Module aus den antony Client nicht abrufbar sind. Es wird dann die Meldung im unteren Bild angezeigt. Dies kann mehrere Ursachen haben.

  1. Die Modulverteilung ist im antonyHub nicht aktiviert. Wenn dies der Fall ist, dann wird im antonyHub eine entsprechende Meldung auf dem Dashboard angezeigt

  2. Die Desktop-API weißt kein Zertifikat auf. Dieses muss vorhanden sein, damit der antony Client mit den antonyHub kommuniziere kann. Man kann eines im antonyHub unter Umgebungsverwaltung > Desktop-API einrichten

  3. Der antony Client hat die Desktop-API beim Starten nicht gefunden. Bei einen laufenden antony kann dies unter Hilfe > Versionsinfo geprüft werden. In diesen Fall kann der Client nicht mit den antonyHub reden und bekommt somit auch keine Updates angezeigt. (#DNS SRV Record)
    In diesem Fall sollte im PDC im DNS ein SRV Eintrag gemacht werden:

    Im Ordner _tcp ist einer neuer SRV Eintrag zu erzeugen.
    Wichtig: Die Portnummer = der https Port der Desktop API (im Hub zu sehen)
    Wichtig: Die Host ist der FQDN des antony Servers

  4. Ist ein Entrypoint aufgelöst worden sein und kann ein Benutzer dennoch nicht auf die Modulverwaltung zugreifen, dann muss der Entrypoint kontrolliert werden. Dazu ist der Port der URI zu vergleichen. Im AntonyHub unter Umgebungsverwaltung > Desktop-API ist der korrekte Port aufgeführt (https). Wenn dieser auf den Port des MainServices (meist 5090) zeigt, dann kann der Entrypoint aufgelöst werden, allerdings kann der Client dann nur mit den MainService sprechen und nicht mit den restlichen Diensten. Die Modulverwaltung fälllt darunter.

Wie prüfe ich den DNS SRV Record, wenn ich keinen Zugang zum DNS habe?

Wenn die Konfiguration nicht direkt im DNS Server eingesehen werden kann, dann müssen wir den vorhandenen Server abfragen. Dafür kann das Tool nslookup verwendet werden. Wichtig bei der Abfrage ist es den Typ zuvor auf srv zu setzen.

Der Name, der abzufragen ist lautet wie folgt

{containerType}._tcp.{domain}

Der containerType kann in den Diensten nachgeschaut werden und lautet standardmäßig antony. Die Domain ist die lokale Domain, in welcher antony läuft. Diese kann über folgenden Powershell Befehl abgefragt werden:

[System.Net.NetworkInformation.IPGlobalProperties]::GetIPGlobalProperties().DomainName

Hier ein Beispiel für den Aufruf von nslookup für antony. Der Type wird in Zeile 5 gesetzt. Die Abfrage selbst geschieht in Zeile 6. Das Ergebnis ist in Zeile 13/14 zu sehen. Die Desktop-API ist zu finden unter https://w2k19-antony.antony.local:8083

C:\Users\linkwitz>nslookup Standardserver: w2k19-pdc.antony.local Address: 172.20.0.4 > set type=srv > _antony._tcp.antony.local Server: w2k19-pdc.antony.local Address: 172.20.0.4 _antony._tcp.antony.local SRV service location: priority = 0 weight = 0 port = 8083 svr hostname = w2k19-antony.antony.local w2k19-antony.antony.local internet address = 172.20.0.7

Die Groupware kann nicht gestartet werden, weil Modulupdates in einer Endlosschleife gestartet werden. Wie kann ich das beenden?

Ab der Version 2.22.122 von antony kann der antonyHub automatisch Modulupdates ausrollen lassen. Beim Start von antony werden die verfügbaren Module abgerufen, lokal abgeglichen und ggf. installiert. Der Installer startet antony anschließend neu. Wenn nun weiterhin Modulupdates vorhanden sind, passiert das gleiche von vorne.

Workaround 1

Um den Kunden schnell zu helfen, kann antony mit dem Parameter/skipModuleUpdate gestartet werden. Die automatische Modulverteilung wird dann übersprungen. Der Nachteil ist hier, dass nach einen antony Update die Verknüpfung neu erzeugt wird und das Verhalten erneut auftritt

Workaround 2

Alternativ kann das Verteilen des problematischen Moduls im antonyHub gestoppt werden. Siehe dafür die Anleitung hier https://diegroupware.atlassian.net/wiki/spaces/ant2/pages/1810071574.

Permanente Lösung

Die beschriebenen Workarounds sind natürlich nur kurzfristig sinnvoll. Wichtig ist es das Modul zu identifizieren, welches das Problem verursacht. Anschließend muss geprüft werden, welche Version lokal installiert ist. Durch antony wird aus Performancezwecken die Version des lokalen Assemblies verwendet. Dies ist im Bild zu erkennen.

Der Pfad ist in der Registrierung zu finden (1) und (2). Der Pfad in der Registrierung sollte anhand des Modulnamens erkennbar sein. Wenn nun in den Ordner im Datei-Explorer navigiert wird (3) und (4) kann nun die Datei ausfindig gemacht werden. Die Version kann mit Rechtsklick > Eigenschaften > Details anschließend eingesehen werden.

Wenn diese Version von der Version abweicht, welche durch den Hub installiert wird, dann handelt es sich um einen Fehler im Modul. Sind diese identisch, dann liegt ein Fehler im ModulInstaller vor. Mit diesen Informationen kann der Fehler anschließend lokalisiert werden.

Ein angebotenes Update des AntonyHubs verhindert, dass ich ihn öffnen kann. Kann ich das Update unterdrücken?

Ja. Der Update Mechanismus kann im AntonyHubClient ausgeschaltet werden. Dazu muss folgende Datei geöffnet und bearbeitet werden.

%LOCALAPPDATA%\antony Systemhaus GmbH\antonyHub.json

Mit der Einstellung UdateEnabled kann das Update unterdrückt werden.

Der antony HubClient findet den HubService nicht, obwohl der Dienst gestartet ist

Möglicherweise haben sich aus unbekannten Gründen die Ports geändert. Das kann wie folgt geprüft werden:

  • Öffnen von c:\programme\antony Groupware Gmbh\antony Hub Service\config\appsettings.autoconfig.json. Dort ist zu entnehmen auf welchen Port/IP der Hubservice hört

  • Öffnen von %localappdata%\antony Systemhaus GmbH\antonyHub.json. Dort muss bei “SatelliteBaseuri” der Port des HubService stehen.