Zotero 集成

在 Kubernetes 部署中，让用户从其 Zotero 文献库导入 .bib 文件。

Zotero 导入运行在每个 Ayakaleaf Pro pod 的 web 服务（tpr-webmodule 模块）中。请按照 Zotero 集成 中的说明注册 Zotero OAuth 客户端，回调 URL 为 ${OVERLEAF_SITE_URL}/user/zotero/oauth/callback，然后按如下方式配置 Kubernetes。

服务	web，位于每个 Ayakaleaf Pro pod 中；在 web 启动时读取
Pod → Zotero	https://www.zotero.org/oauth/* 和 https://api.zotero.org，在用户关联 Zotero、导入或刷新文件时访问
浏览器 → Zotero	https://www.zotero.org/oauth/authorize，然后返回回调 URL
Zotero → Overleaf	无：实例无需能从互联网访问
存储的数据	用户的 Zotero 密钥，加密后存储在 MongoDB 中
定期任务	无：仅在用户请求时刷新文件

​

配置

1. ConfigMap

   30-config.yaml (changes)

     ENABLED_LINKED_FILE_TYPES: project_file,project_output_file,url,zotero
     ZOTERO_CLIENT_ID: <client key>
     # optional: send the module's requests to Zotero through an HTTP proxy
     # ZOTERO_PROXY_URL: http://proxy.example.com:3128
   

   ENABLED_LINKED_FILE_TYPES 会替换安装时设置的值；请保留你已有的类型并添加 zotero（如果两者都使用，还需添加 mendeley）。

2. Secret

   kubectl -n overleaf patch secret overleaf-secrets --type merge -p '{"stringData":{
     "ZOTERO_CLIENT_SECRET":"<client secret>",
     "ZOTERO_CIPHER_PASSWORD":"'"$(openssl rand -hex 32)"'"}}'
   

   ZOTERO_CIPHER_PASSWORD 用于加密存储在 MongoDB 中的用户 Zotero 密钥。如果未设置，每个 pod 会在自己的 /var/lib/overleaf/data 中生成一个密钥文件。在多个副本的情况下，每个节点的密钥都不同，由其他副本提供服务的用户将无法使用其已关联的 Zotero 账户。请在第一个用户关联 Zotero 之前设置它：之后更改会导致所有用户都需要重新关联 Zotero。

3. 应用并重启

   kubectl apply -f 30-config.yaml
   kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf
   

​

多个副本

请在 Secret 中设置 ZOTERO_CIPHER_PASSWORD，见上文。如果没有该密码，在一个副本上导入的文件无法在另一个副本上刷新：刷新会失败并显示 “The remote service produced an error”，因为该副本的密钥文件无法解密用户的 Zotero 密钥。在 Secret 中设置密码后，所有副本都能正常工作；我们通过在 overleaf-0 上导入、在 overleaf-1 上刷新，测试了这两种情况。OAuth 握手将其状态保存在 Redis 中的会话里，因此回调可以到达任意副本。

​

在 Kubernetes 上的测试

我们针对 www.zotero.org 和 api.zotero.org 的模拟服务（通过来自 overleaf-certs 的 NODE_EXTRA_CA_CERTS 信任），在 Kubernetes 1.37 上以三个副本部署在 HAProxy 之后，运行了 Zotero 的端到端测试，全部通过（18 个用例）：通过 OAuth 1.0a 关联和取消关联、将文献库和群组导入到 .bib 文件、刷新该文件、在 Zotero 上撤销密钥、要求重新关联、协作者可搜索参考文献、仅导入者可以刷新、API 错误，以及与 Zotero 的慢速连接。