Local Sync Client

Überblick

Sync Client ist eine Desktopanwendung, mit der SDA Console-Projekte auf einem lokalen Computer oder einer Netzwerkfreigabe verfügbar gehalten werden. Sie wird mit einem Hintergrunddienst ausgeführt und stellt ein Fenster bereit, in dem Projekte ausgewählt, Versionen synchronisiert, Projekte zur Bearbeitung ausgecheckt und Änderungen wieder eingecheckt werden können.

Der Arbeitsablauf der Anwendung ist unter Windows und Linux identisch. Plattformspezifische Anweisungen werden für Installation und Deinstallation bereitgestellt; die übrigen Screenshots zeigen die gemeinsame Oberfläche.

Download

Laden Sie das aktuelle Paket für Ihr Betriebssystem herunter:

• Windows-Installer
• Linux-AMD64-Paket

Sync Client installieren

Windows

1. Suchen Sie sync-client-windows-setup.exe unter Downloads, klicken Sie mit der rechten Maustaste darauf und wählen Sie Als Administrator ausführen. Administratorrechte sind erforderlich.

   

   

2. Fahren Sie vom Willkommensbildschirm aus fort.

   

3. Wählen Sie den Installationsordner. Der Standardspeicherort wird empfohlen.

   

4. Wählen Sie die verfügbaren Komponenten aus, einschließlich Desktopverknüpfung und automatischem Start.

   

5. Lassen Sie Run Sync Client ausgewählt und wählen Sie Finish.

   

Linux

1. Laden Sie sync-client-linux.tar.bz2 herunter und entpacken Sie die Datei:

   tar -xjvf sync-client-linux.tar.bz2

2. Öffnen Sie ein Terminal im entpackten Verzeichnis:

   cd sync-client-linux

3. Führen Sie den Installer mit Administratorrechten aus:

   sudo ./install.sh

   

4. Vergewissern Sie sich, dass das Terminal Installed Sync Client meldet und das installierte Bundle, die CLI, den Desktop-Eintrag, den Dienst und den Dienstbenutzer auflistet. Sync Client wird nach Abschluss der Installation automatisch geöffnet.

5. Melden Sie sich vom Linux-Desktop ab und wieder an, bevor Sie Sync Client verwenden. Der Installer fügt Ihren Desktopbenutzer der Gruppe sync-client hinzu; die neue Gruppenmitgliedschaft wird in der neuen Anmeldesitzung wirksam.

6. Nach der erneuten Anmeldung kann Sync Client über den Anwendungsstarter oder über das Symbol im Infobereich geöffnet werden, sofern er nicht bereits läuft.

   

Ersteinrichtung

Die Ersteinrichtung durchläuft automatisch folgende Schritte:

Login → Storage → Filters / Policy

Die folgenden Screenshots zeigen den Windows-Build, dieselben Einstellungen und Bedienelemente stehen jedoch auch unter Linux zur Verfügung.

Anmelden

Geben Sie Ihre SDA Console-E-Mail-Adresse und Ihr Passwort ein, bestätigen Sie die API-URL und wählen Sie Connect.

Die Symbole neben den Feldern zeigen an, ob die einzelnen Werte überprüft wurden. Nach einer erfolgreichen Verbindung öffnet Sync Client automatisch den Schritt Storage.

Mehrstufige Authentifizierung

Wenn für das Konto die mehrstufige Authentifizierung aktiviert ist, geben Sie den sechsstelligen Token aus der Authenticator-Anwendung ein und wählen Sie Confirm.

Speicherort auswählen

Sync Client kann synchronisierte Projekte in einem lokalen Ordner oder auf einer SMB-Netzwerkfreigabe speichern.

Lokales Dateisystem

Wählen Sie Local Filesystem, wählen Sie Browse, wählen Sie den Projektordner aus, legen Sie das Synchronisierungsintervall fest und wählen Sie Save.

SMB-Netzwerkspeicher

Wählen Sie Network Location und geben Sie Folgendes an:

• UNC Path: die Netzwerkfreigabe und ein optionaler Unterordner, z. B. \\fileserver\engineering
• Domain: die Windows-Domäne oder Arbeitsgruppe, sofern erforderlich
• SMB Username und SMB Password: ein Konto mit Lese- und Schreibzugriff
• Sync Interval: wie häufig Sync Client nach Projektaktualisierungen sucht

Wählen Sie Save, um die Einstellungen zu überprüfen und zu übernehmen. Nach dem Speichern der Speicherkonfiguration öffnet Sync Client automatisch Filters / Policy.

Projekte und Versionen auswählen

Verwenden Sie Filters / Policy, um festzulegen, welche Projekte synchronisiert werden sollen und wie viele Versionen lokal verfügbar bleiben.

• Verwenden Sie IDE, Vendor, Groups und Time Range, um die Projektliste einzugrenzen.
• Durchsuchen Sie den Projektbaum nach Namen.
• Erweitern Sie Gruppen und wählen Sie vollständige Gruppen oder einzelne Projekte aus.
• Entfernen Sie einen aktiven Filter, indem Sie dessen Pill auswählen.

Wählen Sie unter Version policy die Option Last N versions, um eine feste Anzahl aktueller Versionen beizubehalten.

Alternativ wählen Sie Since date, um Versionen beizubehalten, die nach einem ausgewählten Datum erstellt wurden.

Wählen Sie Apply und prüfen Sie die Bestätigung, in der die aktiven Filter, die ausgewählten Projekte, die Aufbewahrungsregel und die Information zusammengefasst werden, ob ältere lokale Versionen gelöscht werden.

Arbeiten mit Projekten

Ein Projekt finden und synchronisieren

Öffnen Sie Projects und verwenden Sie die Suche, All oder Groups, um ein Projekt zu finden. Bei Auswahl eines Projekts werden dessen verfügbare Versionen, Zeitstempel, IDE-Informationen, lokale Pfade, Commit-Nachrichten und der Synchronisierungsstatus angezeigt.

Verwenden Sie Sync now, um eine sofortige Synchronisierung anzufordern, anstatt auf das konfigurierte Intervall zu warten.

Ein Projekt auschecken und öffnen

Wählen Sie eine Projektversion aus und wählen Sie Checkout. Sie können vor der Bestätigung eine optionale Sperrnachricht hinzufügen.

Nach Abschluss des Auscheckens ist das Projekt für Ihre Arbeit gesperrt. Die Projektansicht kennzeichnet die ausgecheckte Version und aktiviert Open project, Checkin und Discard checkout.

Wählen Sie Open project, um das lokale Checkout mit der für diesen Projekttyp registrierten Engineering-Anwendung zu öffnen. Die entsprechende IDE muss auf dem Computer installiert sein.

Sync Client startet zunächst die registrierte Engineering-Anwendung und öffnet anschließend das ausgecheckte Projekt.

Änderungen einchecken oder verwerfen

Kehren Sie nach der Bearbeitung zu Sync Client zurück und wählen Sie Checkin. Geben Sie eine Nachricht ein, die die Änderungen beschreibt, und bestätigen Sie.

Schließen Sie die externe Engineering-IDE, bevor Sie einchecken. Eine geöffnete IDE kann Projektsperrdateien im Checkout hinterlassen und verhindern, dass Sync Client das Einchecken vorbereitet.

Sync Client lädt das geänderte Projekt hoch, fügt die neue Version zur Versionshistorie hinzu und gibt die Projektsperre frei.

Um die lokalen Änderungen stattdessen zu verwerfen, wählen Sie Discard checkout und bestätigen Sie.

Favoritenprojekte

Verwenden Sie den Stern neben einem Projekt, um es zu den Favorites hinzuzufügen oder daraus zu entfernen. Ausgefüllte Sterne kennzeichnen Favoritenprojekte und ermöglichen einen schnelleren Zugriff über die Projektliste.

Favoritenmarkierungen bleiben auch im gruppierten Projektbaum sichtbar.

Hilfe und Diagnose

Verwenden Sie Export logs, um ein Diagnosepaket für den Support zu erstellen. Der Export enthält Anwendungs- und Dienstprotokolle, gibt jedoch keine gespeicherten Passwörter preis.

Öffnen Sie About, um die installierte Anwendungsversion, Lizenzinformationen und Hinweise zu Drittanbietern anzuzeigen.

Sync Client kann im Infobereich weiterlaufen. Über das Menü im Infobereich können Sie die Anwendung öffnen, ihren Status anzeigen oder sie beenden.

Befehlszeilenschnittstelle

Die Installation stellt außerdem sync-cli bereit, das mit demselben Hintergrunddienst kommuniziert wie die Desktopanwendung.

Dienst- und Synchronisierungsstatus prüfen:

sync-cli --status

Aktuelle nicht geheime Einstellungen anzeigen:

sync-cli --show-settings

Sofortige Synchronisierung anfordern:

sync-cli --sync-now

Aktive Projekt-Checkouts auflisten:

sync-cli --show-checkouts

Führen Sie sync-cli --help aus, um alle unterstützten Projekt- und Ausgabeoptionen anzuzeigen. Fügen Sie --json hinzu, wenn Sie die Befehlsausgabe in einem Skript verarbeiten.

Sync Client deinstallieren

Windows

Schließen Sie zunächst Sync Client über den Infobereich. Öffnen Sie anschließend die Windows-Apps bzw. Programme, wählen Sie Sync Client aus und führen Sie die Deinstallationsschritte aus.

Linux

1. Schließen Sie Sync Client über das Menü im Infobereich, bevor Sie den Uninstaller ausführen.

2. Öffnen Sie ein Terminal im entpackten Verzeichnis sync-client-linux.

3. Führen Sie den Uninstaller mit Administratorrechten aus:

   sudo ./uninstall.sh

   

Der Uninstaller entfernt das Anwendungs-Bundle aus /opt/sync-client. Konfiguration, synchronisierte Daten und Protokolle verbleiben in /etc/sync-client, /var/lib/sync-client und /var/log/sync-client, sodass sie später weiterverwendet oder geprüft werden können.