GitHub 同步

此功能由 ayaka-notes/overleaf-pro 開發，並由 yu-i-i/overleaf-cep 修改。此功能自 v6.2.0 起推出，目前仍處於 Beta 階段。如果您遇到任何問題，歡迎提供回饋。

​

設定 GitHub 同步

使用 GitHub 同步之前，您需要先啟用 git-bridge。

config/overleaf.rc

GIT_BRIDGE_ENABLED=true

前往開發者設定建立您的 GitHub OAuth 應用程式，並複製您的 CLIENT_ID 與 SECRET。

注意：您的 OAuth 回呼 URL 為：${OVERLEAF_SITE_URL}/user/github-sync/oauth2/callback。

接著，將以下設定加入您的 Overleaf 環境變數檔案。

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

在設定 GitHub OAuth 回呼 URL 之前，請確認 OVERLEAF_SITE_URL 已正確設定。

如果您位於中國大陸，可能需要設定代理伺服器才能存取 GitHub。請設定以下環境變數：GITHUB_SYNC_PROXY_URL=http://10.0.0.1:10808。

請勿將 127.0.0.1 用作代理主機。如果代理伺服器執行於主機伺服器上，請使用伺服器的區域網路 IP 位址（例如 192.168.1.xx），並確認代理伺服器已設定為接受來自區域網路裝置的連線。