> ## Documentation Index
> Fetch the complete documentation index at: https://ayakaleaf-pro.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# GitHub 同期

<Info>
  この機能は [ayaka-notes/overleaf-pro](https://github.com/ayaka-notes/overleaf-pro) によって開発され、[yu-i-i/overleaf-cep](https://github.com/yu-i-i/overleaf-cep) によって改修されたものです。v6.2.0 以降で導入されています。まだベータ版のため、問題があればぜひフィードバックをお寄せください。
</Info>

<Columns cols={2}>
  <Column>
    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-35.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=e901d54b071a78ae8de0efbb66fb000a" alt="" width="2738" height="1568" data-path="images/on-premises/image-35.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-38.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=90e4cb5dcaa49bd81983dcb8c770056c" alt="" width="2988" height="1980" data-path="images/on-premises/image-38.png" />
    </Frame>
  </Column>

  <Column>
    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-34.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=aa73e00b277a4d01a5339c8a6f91a189" alt="" width="2738" height="1568" data-path="images/on-premises/image-34.png" />
    </Frame>

    <Frame>
      <img src="https://mintcdn.com/ayakaleaf-pro/x9kfDjtWlyyhG_mR/images/on-premises/image-39.png?fit=max&auto=format&n=x9kfDjtWlyyhG_mR&q=85&s=26d47eb61da2e7acfab8f5951e3cd67e" alt="" width="2988" height="1980" data-path="images/on-premises/image-39.png" />
    </Frame>
  </Column>
</Columns>

### GitHub 同期のセットアップ

<Warning>
  GitHub 同期を使用する前に、まず [git-bridge](/ja/on-premises/configuration/overleaf-toolkit/git-integration) を有効にする必要があります。

  ```dotenv title="config/overleaf.rc" theme={null}
  GIT_BRIDGE_ENABLED=true
  ```
</Warning>

[開発者設定](https://github.com/settings/developers) にアクセスして GitHub OAuth アプリケーションを作成し、`CLIENT_ID` と `SECRET` をコピーします。

**注意**: OAuth コールバック URL は `${OVERLEAF_SITE_URL}/user/github-sync/oauth2/callback` です。

次に、Overleaf の環境変数ファイルに以下の設定を追加します。

```dotenv title="config/variables.env" wrap theme={null}
# 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
```

<Warning>
  GitHub OAuth のコールバック URL を設定する前に、`OVERLEAF_SITE_URL` が正しく設定されていることを確認してください。
</Warning>

中国本土にいる場合は、GitHub にアクセスするためにプロキシの設定が必要になることがあります。次の環境変数を設定してください: `GITHUB_SYNC_PROXY_URL=http://10.0.0.1:10808`。

<Warning>
  プロキシのホストに `127.0.0.1` を使用しないでください。プロキシがホストサーバー上で動作している場合は、サーバーの LAN IP アドレス（`192.168.1.xx` など）を使用し、プロキシがローカルネットワーク上のデバイスからの接続を受け付けるよう設定されていることを確認してください。
</Warning>


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.