Git entegrasyonu

Git entegrasyonu şu anda yalnızca ayaka-notes/overleaf üzerinde mevcuttur.

Bu özellik başlangıçta ayaka-notes/overleaf-pro tarafından geliştirilmiştir.

1. git-bridge'i etkinleştirin (Yalnızca Toolkit kullanıcıları için)

   Toolkit kullanıyorsanız config/overleaf.rc dosyanızda aşağıdakini ayarlayarak git-bridge’i etkinleştirin:

   config/overleaf.rc

   GIT_BRIDGE_ENABLED=true
   
2. git-bridge konteynerini ekleyin (Yalnızca Docker-compose kullanıcıları için)

   Özel bir docker-compose.yml çalıştıran kullanıcılar, aşağıdaki konteyner yapılandırmasını compose dosyalarına eklemelidir:

   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 konteyner yapılandırmasını güncelleyin

   Ayrıca git-bridge konteynerini sharelatex konteynerine bağlamanız ve aşağıdaki ortam değişkenlerini tanımlamanız gerekir; lütfen V1_HISTORY_URL değişkenine dikkat edin:

   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. Kimlik doğrulama

   Bir git istemcisinin kimliğini doğrularken kullanıcıların bir Kişisel Erişim Belirtecine (Personal Access Token) ihtiyacı vardır. Kullanıcılar Kişisel Erişim Belirteçlerini uygulama arayüzü üzerinden yönetebilir (belgelere bakın):

   

   Git Entegrasyonu Kişisel Erişim Belirteci

5. İzleme ve kaynak hususları

   git-bridge’i etkinleştirdikten sonra ana makine kaynaklarınızı izlemenizi öneririz. Yük artışı şunlara bağlı olacaktır:

   • özelliğe erişen kullanıcı sayısı
   • kurulumunuzda barındırılan projelerin türleri (daha büyük projeler genellikle daha fazla kaynak tüketir)

​

Projeleri S3’e taşıma (swap)

Git entegrasyonu, bir kullanıcı tarafından klonlanan her proje için diskte eksiksiz bir git deposu depolar. Disk alanınız sınırlıysa, daha az kullanılan depoları AWS S3’e taşıyacak bir swap işini etkinleştirebilirsiniz. Taşınmış bir depoya yeniden ihtiyaç duyulursa diske geri taşınır. Aşağıdaki ortam değişkenleri swap işini kontrol eder:

Ad	Açıklama
GIT_BRIDGE_SWAPSTORE_TYPE	Swap işini etkinleştirmek için bunu “s3” olarak ayarlayın.
GIT_BRIDGE_SWAPSTORE_AWS_ACCESS_KEY	AWS erişim anahtarınız
GIT_BRIDGE_SWAPSTORE_AWS_SECRET	AWS gizli anahtarınız
GIT_BRIDGE_SWAPSTORE_S3_BUCKET_NAME	Bu bucket, sıkıştırılmış (zip) git depolarını içerecektir
GIT_BRIDGE_SWAPSTORE_AWS_REGION	Bucket’ın bölgesi
GIT_BRIDGE_SWAPJOB_MIN_PROJECTS	Diskte en az kaç proje tutulacağı. - Varsayılan: 50
GIT_BRIDGE_SWAPJOB_LOW_GIB	Swap için alt eşik değeri. Swap işi, disk kullanımı bu değerin altına inene kadar projeleri taşır. - Varsayılan: 128 GB
GIT_BRIDGE_SWAPJOB_HIGH_GIB	Swap için üst eşik değeri. Swap işi, disk kullanımı bu değere ulaştığında taşımaya başlar. - Varsayılan: 256 GB
GIT_BRIDGE_SWAPJOB_INTERVAL_MILLIS	Disk kullanımının kontrol edilmesi ve swap işinin çalıştırılması arasındaki süre. - Varsayılan: 3600000 ms = 1 saat

​

S&C

Projemi başka biriyle paylaşırsam Git Bridge izin modeli nasıl çalışır?

Salt okunur erişime sahip kullanıcılar bu projeyi yalnızca klonlayabilir; okuma-yazma erişimine sahip kullanıcılar projeleri klonlayabilir ve push edebilir. Not: Kullanıcıların bu projeye katılmak için oturum açmış olması gerekir.