Dokumentation

Installation

GitSy ist für Android-Geräte mit Android 7.0 oder neuer verfügbar. Du kannst es aus dem Google Play Store installieren. Falls die App im geschlossenen Test ist, folge zuerst der Testanleitung.

Systemanforderungen

• Android 7.0+ (API-Level 24)
• 64MB freier Speicherplatz
• Internetverbindung für Synchronisation
• Zugang zu einem Git-Repository (GitHub, GitLab, etc.)

Ersteinrichtung

Nach der Installation von GitSy musst du es mit deinem Git-Repository verbinden. Dies verbindet einen Android-Ordner mit einem Git-Repository.

Schritt 1: Repository erstellen

Erstelle zunächst ein neues Repository bei deinem bevorzugten Git-Hosting-Service:

• GitHub: Gehe zu github.com und erstelle ein neues Repository
• GitLab: Besuche gitlab.com und erstelle ein neues Projekt
• Selbst gehostet: Verwende deinen eigenen Git-Server

Schritt 2: GitSy konfigurieren

Öffne GitSy und folge diesen Schritten:

1. Tippe auf "Repository hinzufügen" im Willkommensbildschirm
2. Gib deine Repository-URL ein
3. Stelle deine Authentifizierungsdaten bereit
4. Wähle einen leeren lokalen Ordner über Androids Ordnerauswahl
5. Speichere das Projekt, damit GitSy das Repository in diesen Ordner klont

Ordner-Workflow

GitSy ersetzt deinen Notiz-Editor nicht. Erstelle und bearbeite Dateien mit deiner bevorzugten Android-App und nutze GitSy, um den Ordner mit Git zu synchronisieren.

Basisablauf

1. Füge ein Repository in GitSy hinzu
2. Wähle einen leeren lokalen Ordner für dieses Projekt
3. Bearbeite Dateien in diesem Ordner mit einer anderen App
4. Kehre zu GitSy zurück und starte die Synchronisation
5. GitSy committet lokale Änderungen, führt Pull aus und pusht Updates

Repository-Einrichtung

GitSy dokumentiert derzeit HTTPS-Repository-Zugriff. GitHub, GitLab und selbst gehostete HTTPS-Git-Server sind die primär unterstützten Ziele.

GitHub

GitLab

Selbst gehostetes Git

Authentifizierung

GitSy verwendet Zugangsdaten im Benutzername/Passwort-Stil für HTTPS-Git-Zugriff. Für GitHub und GitLab solltest du ein Personal Access Token statt deines Kontopassworts verwenden.

Personal Access Token (Empfohlen)

Die sicherste Methode ist die Verwendung eines Personal Access Tokens:

1. Gehe zu den Einstellungen deines Git-Anbieters
2. Generiere einen neuen Personal Access Token
3. Gewähre Repository-Lese-/Schreibberechtigungen
4. Kopiere den Token und füge ihn in GitSy ein

Synchronisation

GitSy synchronisiert über einen Android-Foreground-Service, solange Arbeit läuft. Du kannst die Synchronisation manuell für ein Projekt oder für alle Projekte starten.

Verfügbare Aktionen

• Repository synchronisieren: Sync für ein konfiguriertes Projekt starten
• Alle synchronisieren: Alle konfigurierten Projekte einreihen
• Periodische Prüfung: Beim Öffnen der App können bereite Projekte älter als eine Stunde eingereiht werden

Was Sync macht

• Kopiert Änderungen aus dem ausgewählten Android-Ordner in die Git-Arbeitskopie der App
• Erstellt einen Commit, wenn lokale Änderungen vorhanden sind
• Pullt Remote-Änderungen aus dem Repository
• Kopiert das synchronisierte Ergebnis zurück in den ausgewählten Android-Ordner

Projektverwaltung

Jedes Projekt speichert Repository-URL, Zugangsdaten und den Android-Ordner, der synchronisiert wird.

Verfügbare Aktionen

• Repository-Projekt hinzufügen
• Repository-URL und Zugangsdaten bearbeiten
• Projekt aus GitSy löschen
• Ein Projekt über das Kontextmenü synchronisieren

Ordnerzugriff

GitSy verwendet Androids Storage Access Framework. Du erteilst explizit Zugriff auf den Ordner jedes Projekts, und GitSy speichert diese Berechtigung für zukünftige Sync-Läufe.

Geplante Funktionen

Einige früher auf der Website beschriebene Funktionen gehören nicht zur aktuellen App. Sie werden stattdessen als zukünftige Arbeit verfolgt.

• Markdown-Vorschau und Bearbeitungshilfen
• Suche, Tags, Favoriten und Filter
• Konfigurierbare zeitgesteuerte Synchronisation
• OAuth- und SSH-Authentifizierung
• Export- und Teilen-Funktionen in der App

Konflikte

Git-Konflikte können entstehen, wenn dieselben Dateien lokal und remote geändert werden. Die aktuelle Konfliktbehandlung basiert auf Git/JGit-Verhalten während der Synchronisation; eine interaktive Konfliktprüfung ist geplant, aber noch nicht implementiert.

Wie Konflikte entstehen

Konflikte treten auf, wenn:

• Dieselbe Datei auf mehreren Geräten bearbeitet wird
• Änderungen offline vorgenommen werden
• Netzwerkprobleme eine ordnungsgemäße Synchronisation verhindern

Backup & Wiederherstellung

Jede erfolgreiche Synchronisation pusht den ausgewählten Ordner in dein Git-Repository. Das Repository ist der Backup- und Versionsverlaufsmechanismus.

Automatisches Git-Backup

Jedes Mal, wenn du erfolgreich synchronisierst, werden deine Dateien in dein Git-Repository gepusht. Das bedeutet, du hast:

• Vollständige Versionsgeschichte aller Änderungen
• Mehrere Kopien auf allen verbundenen Geräten
• Wiederherstellung von jedem Zeitpunkt

Du kannst das Repository mit Standard-Git-Werkzeugen außerhalb von GitSy klonen oder exportieren.

Fehlerbehebung

Häufige Probleme und ihre Lösungen, um das Beste aus GitSy herauszuholen.

Synchronisationsprobleme