GitHub-synkronisering

Denne funktion er udviklet af ayaka-notes/overleaf-pro og tilpasset af yu-i-i/overleaf-cep. Den er introduceret i v6.2.0 og senere. Den er stadig i betastatus. Vi har brug for din feedback, hvis du oplever problemer.

​

Opsætning af GitHub-synkronisering

Du skal først aktivere git-bridge, før du kan bruge GitHub-synkronisering.

config/overleaf.rc

GIT_BRIDGE_ENABLED=true

Gå til udviklerindstillinger for at oprette din GitHub OAuth-applikation, og kopiér dit CLIENT_ID og din SECRET.

Bemærk: Din OAuth-callback-URL er: ${OVERLEAF_SITE_URL}/user/github-sync/oauth2/callback.

Tilføj derefter følgende indstillinger til dine Overleaf-miljøvariabelfiler.

config/variables.env

# used to encrypt the user's GitHub access token.
# How to generate: `openssl rand -hex 32`
GITHUB_TOKEN_CIPHER_PASSWORD=0123456789ABCDEFG # changed to yours

# Github Sync Settings
GITHUB_SYNC_ENABLED=true
GITHUB_SYNC_CLIENT_ID=
GITHUB_SYNC_CLIENT_SECRET=

# OAuth callback is: ${OVERLEAF_SITE_URL}/user/github-sync/oauth2/callback
# (Optional) GITHUB_SYNC_PROXY_URL=http://10.0.0.1:10808

Før du konfigurerer GitHub OAuth-callback-URL’en, skal du sikre dig, at OVERLEAF_SITE_URL er sat korrekt.

Hvis du befinder dig i det kinesiske fastland, kan det være nødvendigt at konfigurere en proxy for at få adgang til GitHub. Sæt følgende miljøvariabel: GITHUB_SYNC_PROXY_URL=http://10.0.0.1:10808.

Brug ikke 127.0.0.1 som proxyvært. Hvis proxyen kører på værtsserveren, skal du bruge serverens LAN-IP-adresse (f.eks. 192.168.1.xx) og sikre dig, at proxyen er konfigureret til at acceptere forbindelser fra enheder på det lokale netværk.