Integración con Git

Actualmente, la integración con Git solo está disponible en ayaka-notes/overleaf.

Esta funcionalidad fue desarrollada inicialmente por ayaka-notes/overleaf-pro.

1. Habilitar git-bridge (solo para usuarios del Toolkit)

   Si usas el Toolkit, habilita git-bridge configurando lo siguiente en tu config/overleaf.rc:

   config/overleaf.rc

   GIT_BRIDGE_ENABLED=true
   
2. Añadir el contenedor git-bridge (solo para usuarios de Docker-compose)

   Si ejecutas un docker-compose.yml personalizado, añade la siguiente configuración de contenedor a tu archivo 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. Actualizar la configuración del contenedor sharelatex

   También tendrás que enlazar el contenedor git-bridge en el contenedor sharelatex y definir las siguientes variables de entorno; presta atención a 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. Autenticación

   Para autenticar un cliente git, los usuarios necesitan un token de acceso personal (Personal Access Token). Los usuarios pueden gestionar sus tokens de acceso personal desde la interfaz de la aplicación (consulta la documentación):

   

   Token de acceso personal de la integración con Git

5. Supervisión y consideraciones de recursos

   Te recomendamos supervisar los recursos del host después de habilitar git-bridge. El aumento de carga dependerá de:

   • el número de usuarios que acceden a la funcionalidad
   • los tipos de proyectos alojados en tu instancia (los proyectos más grandes suelen consumir más recursos)

​

Mover proyectos a S3

La integración con Git almacena en disco un repositorio git completo por cada proyecto que clona un usuario. Si tienes un espacio en disco limitado, puedes activar un trabajo de intercambio (swap) que moverá a AWS S3 los repositorios menos utilizados. Si se vuelve a necesitar un repositorio movido, se devuelve al disco. Las siguientes variables de entorno controlan el trabajo de intercambio:

Nombre	Descripción
GIT_BRIDGE_SWAPSTORE_TYPE	Establécela en “s3” para activar el trabajo de intercambio.
GIT_BRIDGE_SWAPSTORE_AWS_ACCESS_KEY	Tu clave de acceso de AWS
GIT_BRIDGE_SWAPSTORE_AWS_SECRET	Tu secreto de AWS
GIT_BRIDGE_SWAPSTORE_S3_BUCKET_NAME	Este bucket contendrá los repositorios git comprimidos
GIT_BRIDGE_SWAPSTORE_AWS_REGION	La región del bucket
GIT_BRIDGE_SWAPJOB_MIN_PROJECTS	Cuántos proyectos mantener en disco, como mínimo. - Por defecto: 50
GIT_BRIDGE_SWAPJOB_LOW_GIB	Umbral inferior de intercambio. El trabajo de intercambio moverá proyectos hasta que el uso del disco esté por debajo de este valor. - Por defecto: 128 GB
GIT_BRIDGE_SWAPJOB_HIGH_GIB	Umbral superior de intercambio. El trabajo de intercambio empezará a mover proyectos cuando el uso del disco alcance este valor. - Por defecto: 256 GB
GIT_BRIDGE_SWAPJOB_INTERVAL_MILLIS	El tiempo entre cada comprobación del uso del disco y la ejecución del trabajo de intercambio. - Por defecto: 3600000 ms = 1 hora

​

Preguntas y respuestas

Si comparto mi proyecto con otra persona, ¿cómo funciona el modelo de permisos de Git Bridge?

Los usuarios con acceso de solo lectura solo pueden clonar el proyecto; los usuarios con acceso de lectura y escritura pueden clonar y hacer push. Nota: los usuarios deben haber iniciado sesión para unirse al proyecto.