> ## 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.

# Gitea 同步

> 在 Kubernetes 部署中，让用户将其项目与 Gitea.com 或你自己的 Gitea 上的仓库同步。

Gitea 同步运行在每个 Ayakaleaf Pro Pod 的 **web** 服务（`gitea-sync` 模块）中。它需要 [Git 集成](https://ayakaleaf-pro.mintlify.site/zh-CN/on-premises/configuration/kubernetes/integrations/git-integration.md)。请在 [Gitea 同步](https://ayakaleaf-pro.mintlify.site/zh-CN/on-premises/configuration/overleaf-toolkit/integrations/gitea-synchronisation.md)中创建 OAuth 应用并了解每项设置的作用；本页介绍如何将其放入 Kubernetes。

| | |
| - | - |
| 服务 | web（`gitea-sync` 模块），位于每个 Ayakaleaf Pro Pod 中；在 web 启动时读取 |
| Pod → Gitea | `GITEA_SYNC_URL`（默认为 `https://gitea.com/api/v1`）的 REST API，在用户关联、导入、导出或同步时访问 |
| 浏览器 → Gitea | 访问 `${GITEA_SYNC_URL}/login/oauth/authorize` 以关联账户，然后返回 `${OVERLEAF_SITE_URL}/user/gitea-sync/oauth2/callback` |
| Gitea → Overleaf | 无：没有 Webhook，实例无需能被 Gitea 访问 |
| 存储的数据 | MongoDB 中经过加密的用户 Gitea 访问令牌和刷新令牌 |
| 定期任务 | 无：同步在用户点击时进行 |

### 配置

**1. ConfigMap**

```yaml title="30-config.yaml (additions)" theme={null}
  GITEA_SYNC_ENABLED: "true"
  GITEA_SYNC_CLIENT_ID: <client ID>
  # your own Gitea: its ROOT_URL
  # GITEA_SYNC_URL: https://gitea.example.com
  # optional: send the module's requests to Gitea through an HTTP proxy
  # GITEA_SYNC_PROXY_URL: http://proxy.example.com:3128
```

必须已配置好 `GIT_BRIDGE_ENABLED: "true"` 以及 [Git 集成](https://ayakaleaf-pro.mintlify.site/zh-CN/on-premises/configuration/kubernetes/integrations/git-integration.md)中的 git-bridge StatefulSet：否则账户设置和编辑器会隐藏 Gitea 同步。

**2. Secret**

```bash theme={null}
kubectl -n overleaf patch secret overleaf-secrets --type merge -p '{"stringData":{
  "GITEA_SYNC_CLIENT_SECRET":"<client secret>",
  "GITEA_TOKEN_CIPHER_PASSWORD":"'"$(openssl rand -hex 32)"'"}}'
```

`GITEA_TOKEN_CIPHER_PASSWORD` 用于加密 MongoDB 中用户的 Gitea 访问令牌和刷新令牌。每个副本都必须使用相同的值，之后若更改该值，所有用户都需要重新关联 Gitea。

**3. 私有 CA（可选）**

如果你的 Gitea 使用的证书来自你自己的 CA，请将该 CA 添加到挂载在 `/var/lib/overleaf/certs` 的 Secret `overleaf-certs` 中（参见[证书和其他文件](https://ayakaleaf-pro.mintlify.site/zh-CN/on-premises/configuration/kubernetes#证书和其他文件)），并在 ConfigMap 中设置 `NODE_EXTRA_CA_CERTS: /var/lib/overleaf/certs/ca.pem`。

**4. 应用、重启并检查**

```bash theme={null}
kubectl apply -f 30-config.yaml
kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf
for p in $(kubectl -n overleaf get pod -l app=overleaf -o name); do   # app=overleaf-ha for several replicas
  kubectl -n overleaf exec "$p" -- curl -sS -o /dev/null -w "$p %{http_code}\n" https://gitea.com/api/v1/version
done
```

任何 HTTP 状态码都表示该 Pod 可以访问 Gitea；`000` 表示无法访问。

### 多个副本

除共享的 `GITEA_TOKEN_CIPHER_PASSWORD` 外无需其他操作。同步时会在 Redis 中获取一个锁（与其他 Git 同步共享），因此两个副本永远不会同时同步同一个项目。

### 在 Kubernetes 上的测试

针对位于 `GITEA_SYNC_URL` 的真实 Gitea 1.23，在 Kubernetes 1.37 上使用一个副本并开启 Git 集成，我们针对 Gitea 同步的端到端测试全部通过（39 个用例）：通过 Gitea 的 OAuth2 关联和取消关联账户、刷新即将过期的访问令牌以及被撤销的授权、导出到新的私有仓库或组织仓库、导入仓库、拉取和推送、合并、冲突、已删除和被强制推送的分支、二进制文件、重命名和删除，以及所有者、编辑者和查看者可以执行的操作。


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