GitHub Synchronisation

This feature is developed by ayaka-notes/ayakaleaf-pro, modified by yu-i-i/overleaf-cep. It is introduced from v6.2.0 and later. It’s still in beta status. We need your feedback if you have any problem.

Setup GitHub Synchronisation

You need to enable git-bridge first before using GitHub Synchronisation.

config/overleaf.rc

GIT_BRIDGE_ENABLED=true

Visit developers settings to create your GitHub OAuth application, and copy your CLIENT_ID and SECRET. Notes: your OAuth callback URL is: ${OVERLEAF_SITE_URL}/user/github-sync/oauth2/callback. Then, add the following settings to your overleaf env var files.

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

Before configuring the GitHub OAuth callback URL, make sure OVERLEAF_SITE_URL is set correctly.

If you are located in mainland China, you may need to configure a proxy to access GitHub. Set the following environment variable: GITHUB_SYNC_PROXY_URL=http://10.0.0.1:10808.

Do not use 127.0.0.1 for proxy host. If the proxy is running on host server, use the server’s LAN IP (like 192.168.1.xx) address and make sure the proxy is configured to accept connections from devices on the local network.

Last modified on October 6, 2026

Overview

Installation

Configuration

Maintenance

User and project management

Support

Setup GitHub Synchronisation

​Setup GitHub Synchronisation

Setup GitHub Synchronisation