Skip to content

快速开始

Jump to bottom
HolgerHuo edited this page Oct 16, 2024 · 5 revisions

The English version of this page is at Quick Start Guide

本文由 ChatGPT 翻译自Quick Start Guide。

介绍

Overleaf 通过 Docker 部署。在开始之前，请根据此文档安装 Docker。Podman 不支持且未经过测试。

由于内部复杂性，不使用 Docker 启动所有服务可能会非常繁琐和复杂，但 Overleaf 确实提供了一个简单的初始化系统。如果你对此感兴趣，可以查看这些代码获取一些灵感。

Overleaf 提供了两个镜像，ghcr.io/lcpu-club/sharelatex-base 和 ghcr.io/lcpu-club/sharelatex。sharelatex-base 包含了所有 texlive 的二进制文件和软件包 (tlmgr install scheme-full)，并用于沙箱编译。我们提供了最新版（2024）、2022 版和 2020 版的 texlive，镜像标签格式为 {year}.{rev}（rev 是表示修订号的数字），例如 ghcr.io/lcpu-club/sharelatex-base:2024.1。sharelatex 包含应用代码，标签遵循标准的语义化版本管理。

拉取所有必要的镜像

docker pull ghcr.io/lcpu-club/sharelatex:latest
docker pull ghcr.io/lcpu-club/sharelatex-base:2024.1
docker pull ghcr.io/lcpu-club/sharelatex-base:2022.1
docker pull ghcr.io/lcpu-club/sharelatex-base:2020.1

下载 docker-compose.yml

# 首先创建一个新目录
mkdir overleaf && cd overleaf

# 下载 docker-compose.yml 和必要的文件
wget https://github.com/lcpu-club/overleaf/raw/refs/heads/main/docker-compose.yml
curl https://github.com/lcpu-club/overleaf/raw/refs/heads/main/server-ce/mongodb-init-replica-set.js -L --create-dirs --output server-ce/mongodb-init-replica-set.js

# 修改 docker-compose.yml
$EDITOR docker-compose.yml

请注意以下选项：

  • 卷挂载：默认情况下，{sharelatex_data,redis_data,mongo_data} 将存储在 ~/ 目录下，根据需要进行修改。
  • SANDBOXED_COMPILES_HOST_DIR：特别注意此目录应为 主机上的 sharelatex_data 目录 + /data/compiles，因为该目录将被挂载到编译容器中。
  • 其他值：根据需要进行更新。如果你将使用反向代理，则应设置 OVERLEAF_BEHIND_PROXY: 'true' 和 OVERLEAF_SECURE_COOKIE: 'true'。

最后，使用以下指令启动Overleaf：

docker compose up -d

现在可以查看你的Overleaf实例了！

创建和管理用户

当 Overleaf 实例运行后，访问 /launchpad 页面来设置你的第一个管理员用户。

另外，使用以下命令创建第一个用户并将其设为管理员：

docker exec sharelatex /bin/bash -c "cd /var/www/sharelatex; grunt user:create-admin [email protected]"

此命令将在用户不存在的情况下创建一个拥有指定邮箱的用户，并将其设为管理员用户。你将获得一个 URL 访问地址，在该地址可以为此用户设置密码并首次登录。

注意：上述命令将始终返回指向 http://localhost/ 的 URL。如果你已将端口转发更新为 ports: - 8080:80，你应使用正确的端口访问密码确认页面：http://localhost:8080/user/password/set?passwordResetToken=<token>。另一个选项是将 SHARELATEX_SITE_URL 环境变量设置为 http://localhost:8080 或 http://sharelatex.mydomain.com。

创建普通用户

一旦你作为管理员用户登录，可以访问 Overleaf 实例上的 /admin/register 页面来创建新用户。如果你已配置了电子邮件后端，新用户将收到一封电子邮件，内含一个设置密码的 URL。如果没有，你需要手动分发密码重置的 URL。这些 URL 会在你创建用户时显示。

Clone this wiki locally