Документация

Установка

GitSy доступен для Android-устройств с Android 7.0 или новее. Вы можете установить его из Google Play Store. Если приложение находится в закрытом тестировании, сначала выполните инструкцию подключения к тесту.

Системные требования

• Android 7.0+ (API уровень 24)
• 64МБ свободного места
• Интернет-соединение для синхронизации
• Доступ к Git-репозиторию (GitHub, GitLab и т.д.)

Первоначальная настройка

После установки GitSy вам нужно подключить его к вашему Git-репозиторию. Это подключает одну Android-папку к одному Git-репозиторию.

Шаг 1: Создайте репозиторий

Сначала создайте новый репозиторий на вашем предпочитаемом Git-хостинге:

• GitHub: Перейдите на github.com и создайте новый репозиторий
• GitLab: Посетите gitlab.com и создайте новый проект
• Собственный хостинг: Используйте ваш собственный Git-сервер

Шаг 2: Настройте GitSy

Откройте GitSy и выполните следующие шаги:

1. Нажмите "Добавить репозиторий" на экране приветствия
2. Введите URL вашего репозитория
3. Предоставьте учетные данные для аутентификации
4. Выберите пустую локальную папку через системный выбор Android
5. Сохраните проект, чтобы GitSy клонировал репозиторий в эту папку

Работа с папкой

GitSy не заменяет редактор заметок. Создавайте и редактируйте файлы в выбранной папке любым подходящим Android-приложением, а GitSy используйте для синхронизации с Git.

Базовый сценарий

1. Добавьте репозиторий в GitSy
2. Выберите пустую локальную папку для проекта
3. Редактируйте файлы в этой папке другим приложением
4. Вернитесь в GitSy и запустите синхронизацию
5. GitSy закоммитит локальные изменения, выполнит pull и отправит обновления

Настройка репозитория

GitSy сейчас документирует доступ к HTTPS-репозиториям. GitHub, GitLab и собственные HTTPS Git-серверы являются основными поддерживаемыми вариантами.

GitHub

GitLab

Собственный Git-хостинг

Аутентификация

GitSy использует учетные данные в формате username/password для HTTPS Git-доступа. Для GitHub и GitLab используйте персональный токен доступа вместо пароля аккаунта.

Персональный токен доступа (Рекомендуется)

Самый безопасный метод — использование персонального токена доступа:

1. Перейдите в настройки вашего Git-провайдера
2. Сгенерируйте новый персональный токен доступа
3. Предоставьте разрешения на чтение/запись репозитория
4. Скопируйте токен и вставьте его в GitSy

Синхронизация

GitSy выполняет синхронизацию через foreground-сервис Android, пока идёт работа. Синхронизацию можно запустить вручную для одного проекта или для всех проектов.

Доступные действия

• Синхронизировать репозиторий: Запустить синхронизацию одного проекта
• Синхронизировать все: Поставить все проекты в очередь синхронизации
• Периодическая проверка: При открытии приложения готовые проекты старше одного часа могут быть поставлены в очередь

Что делает синхронизация

• Копирует изменения из выбранной Android-папки в рабочую копию Git приложения
• Создаёт commit при наличии локальных изменений
• Выполняет pull удалённых изменений из репозитория
• Копирует синхронизированный результат обратно в выбранную Android-папку

Управление проектами

Каждый проект хранит URL репозитория, учетные данные и Android-папку, выбранную для синхронизации.

Доступные действия

• Добавить проект репозитория
• Изменить URL репозитория и учетные данные
• Удалить проект из GitSy
• Синхронизировать один проект из контекстного меню

Доступ к папке

GitSy использует Android Storage Access Framework. Вы явно предоставляете доступ к папке для каждого проекта, а приложение сохраняет это разрешение для будущих запусков синхронизации.

Планируемые функции

Некоторые функции, которые раньше были описаны на сайте, пока не входят в текущее приложение. Они перенесены в план развития.

• Предпросмотр Markdown и помощники редактирования
• Поиск, теги, избранное и фильтры
• Настраиваемая синхронизация по расписанию
• OAuth и SSH-аутентификация
• Экспорт и sharing из интерфейса приложения

Конфликты

Git-конфликты возможны, если одни и те же файлы меняются локально и удалённо. Сейчас обработка конфликтов основана на поведении Git/JGit во время синхронизации; интерактивный экран просмотра конфликтов запланирован, но ещё не реализован.

Как возникают конфликты

Конфликты происходят когда:

• Один и тот же файл редактируется на нескольких устройствах
• Изменения вносятся в автономном режиме
• Проблемы с сетью препятствуют правильной синхронизации

Резервное копирование и восстановление

При успешной синхронизации содержимое выбранной папки отправляется в ваш Git-репозиторий. Репозиторий является механизмом резервного копирования и истории версий.

Автоматическое резервное копирование Git

Каждый раз при успешной синхронизации ваши файлы отправляются в Git-репозиторий. Это означает, что у вас есть:

• Полная история версий всех изменений
• Множественные копии на всех подключенных устройствах
• Восстановление с любого момента времени

Экспортировать или клонировать репозиторий можно стандартными Git-инструментами вне GitSy.

Устранение неполадок

Распространенные проблемы и их решения, чтобы помочь вам получить максимум от GitSy.

Проблемы синхронизации