Интеграция с Git

В настоящее время интеграция с Git доступна только в ayaka-notes/overleaf.

Эта функция изначально разработана ayaka-notes/overleaf-pro.

1. Включение git-bridge (только для пользователей Toolkit)

   Если вы используете Toolkit, включите git-bridge, задав следующий параметр в файле config/overleaf.rc:

   config/overleaf.rc

   GIT_BRIDGE_ENABLED=true
   
2. Добавление контейнера git-bridge (только для пользователей Docker-compose)

   Если вы используете собственный docker-compose.yml, добавьте в compose-файл следующую конфигурацию контейнера:

   docker-compose.yml (git-bridge service)

   git-bridge:
       restart: always
       image: ghcr.io/ayaka-notes/overleaf-pro/git-bridge:6.3.0 # tag should match the `sharelatex` container tag
       volumes:
           - ~/git_bridge_data:/data/git-bridge
       container_name: git-bridge
       expose:
           - "8000"
       environment:
           GIT_BRIDGE_API_BASE_URL: "http://sharelatex:3000/api/v0/" 
           # "http://sharelatex/api/v0/" for version 4.1.6 and earlier
           GIT_BRIDGE_OAUTH2_SERVER: "http://sharelatex"
           GIT_BRIDGE_POSTBACK_BASE_URL: "http://git-bridge:8000"
           GIT_BRIDGE_ROOT_DIR: "/data/git-bridge"
       user: root
       command: ["/server-pro-start.sh"]
   
3. Обновление конфигурации контейнера sharelatex

   Также необходимо связать контейнер git-bridge с контейнером sharelatex и задать следующие переменные окружения. Обратите особое внимание на V1_HISTORY_URL:

   docker-compose.yml (sharelatex service)

   sharelatex:
       links:
           - git-bridge
       environment:
            GIT_BRIDGE_ENABLED: true
            GIT_BRIDGE_HOST: "git-bridge"
            GIT_BRIDGE_PORT: "8000"
            # We use v1 now, if you used to set V1_HISTORY_URL, please update now
            V1_HISTORY_URL: "http://sharelatex:3100/api"
   
4. Аутентификация

   Для аутентификации git-клиента пользователям нужен персональный токен доступа (Personal Access Token). Пользователи могут управлять персональными токенами доступа через интерфейс приложения (см. документацию):

   

   Персональный токен доступа для интеграции с Git

5. Мониторинг и потребление ресурсов

   После включения git-bridge рекомендуем отслеживать ресурсы хоста. Рост нагрузки будет зависеть от:

   • количества пользователей, использующих эту функцию
   • типов проектов, размещённых в вашем экземпляре (более крупные проекты, как правило, требуют больше ресурсов)

​

Перенос проектов в S3

Интеграция с Git хранит на диске полный git-репозиторий для каждого проекта, который клонирует пользователь. Если место на диске ограничено, можно включить задание подкачки (swap job), которое будет переносить редко используемые репозитории в AWS S3. Если перенесённый репозиторий снова понадобится, он будет возвращён на диск. Задание подкачки управляется следующими переменными окружения:

Имя	Описание
GIT_BRIDGE_SWAPSTORE_TYPE	Задайте значение “s3”, чтобы включить задание подкачки.
GIT_BRIDGE_SWAPSTORE_AWS_ACCESS_KEY	Ваш ключ доступа AWS
GIT_BRIDGE_SWAPSTORE_AWS_SECRET	Ваш секретный ключ AWS
GIT_BRIDGE_SWAPSTORE_S3_BUCKET_NAME	В этом бакете будут храниться заархивированные git-репозитории
GIT_BRIDGE_SWAPSTORE_AWS_REGION	Регион бакета
GIT_BRIDGE_SWAPJOB_MIN_PROJECTS	Минимальное количество проектов, хранящихся на диске. - По умолчанию: 50
GIT_BRIDGE_SWAPJOB_LOW_GIB	Нижний порог подкачки. Задание подкачки переносит проекты, пока использование диска не опустится ниже этого значения. - По умолчанию: 128 GB
GIT_BRIDGE_SWAPJOB_HIGH_GIB	Верхний порог подкачки. Задание подкачки начинает перенос, когда использование диска достигает этого значения. - По умолчанию: 256 GB
GIT_BRIDGE_SWAPJOB_INTERVAL_MILLIS	Интервал между проверками использования диска и запусками задания подкачки. - По умолчанию: 3600000 ms = 1 час

​

Вопросы и ответы

Если я поделюсь проектом с другим пользователем, как работает модель прав доступа Git Bridge?

Пользователи с доступом только для чтения могут лишь клонировать проект; пользователи с доступом на чтение и запись могут клонировать проект и отправлять в него изменения (push). Примечание: чтобы присоединиться к проекту, пользователям необходимо войти в систему.