texlite

v0.14.0

Published

20 hours ago

A lightweight local-first collaborative LaTeX workspace

0High
0Medium
0Low

zhongpu

latex overleaf collaboration tex

TexLite

面向小型、可信研究团队的轻量自托管 Overleaf 替代方案。直接使用现有的 LaTeX 发行版，无需沉重的服务栈。

文档： English · 运维指南（英文） · 设计文档（英文） · 简体中文（当前文件）

网站： TexLite GitHub Pages

[!TIP] 反馈： 如果你正在使用 TexLite，欢迎填写简短的使用问卷：Google Form 或飞书问卷，帮助我们改进后续版本。

TexLite 工作区 TexLite 项目视图

为什么选择 TexLite

掌控写作环境。 直接使用宿主机 TeX 环境，并将源码、历史版本和编译产物保存在一个本地数据目录中。
无需庞大服务栈即可协作。 默认部署只有一个 Node.js 进程、SQLite 和本地文件，同时提供实时编辑和源码级批注，适合少量可信协作者。

快速开始

安装 Node.js 24 或更高版本、latexmk，以及至少一个 TeX 引擎，例如 pdflatex、 xelatex 或 lualatex。只有使用可选 Git/GitHub 集成时才需要 Git。

安装后可先执行 texlite requirements，检查相关宿主机软件及版本。

npm install --global texlite
texlite requirements
texlite init
texlite start
texlite status

访问 http://127.0.0.1:3000。texlite init 会创建配置并建立第一个管理员；TexLite 不开放公众注册。如需把 TexLite 挂载到现有域名的 /texlite 等子路径，请设置 server.basePath，并参考反向代理说明（英文）。

升级与日常管理：

npm update --global texlite
texlite restart
texlite logs

texlite serve 会以前台方式运行，适合调试、Docker 或 systemd。start、stop、 restart、status、logs 使用 npm 包内置的 PM2 运行时；完整命令请执行 texlite help。

建议让 TexLite 继续监听 127.0.0.1。如果需要方便、安全地公开访问，请使用 TexLite Share。TexLite Share 目前部署在香港，来自中国大陆或东南亚以外地区的访问可能较慢。确保 TexLite 已在默认端口启动，然后安装并运行隧道客户端：

curl -fsSL https://raw.githubusercontent.com/ChenZhongPu/TexLite-Share/main/install-client.sh | bash
~/.local/bin/texlite-tunnel-client --server-url https://share.zhongpu.info

如果 TexLite 使用非默认端口，请明确指定本地地址：

~/.local/bin/texlite-tunnel-client \
  --server-url https://share.zhongpu.info \
  --local-addr 127.0.0.1:8080

与 Overleaf 的实际区别

Overleaf 在团队需要其托管产品或更完整生态时仍然是很好的选择。TexLite 面向的是更窄的自托管场景：

共享托管服务在使用高峰期可能排队、变慢或出现编译超时。
Overleaf 开源 Community Edition 的 Docker 部署路径更复杂，且源码批注等高级功能仅限 Server Pro。 如果不介意一个更庞大的 Docker 镜像，我们也准备好了 :)

自托管并不保证每份文档都编译得更快，速度仍取决于宿主机和文档本身；它带来的是对容量、 TeX 更新、数据位置与协作工作流的掌控。

若是以个人、本地桌面工作流为主，建议优先考虑 VS Code + LaTeX Workshop 或 TeXstudio。TexLite 的目标是浏览器中的共同写作，而不是取代个人 IDE。

核心写作工作流

项目支持文件夹、ZIP 导入/导出、标签、分享、所有权转让、归档和私有的个人引用库。
基于 CodeMirror 的编辑器提供 LaTeX/BibTeX 高亮、折叠、补全、可选 Vim 模式、格式化、拼写/语法/ChkTeX 辅助、搜索替换及源码/PDF SyncTeX 跳转。
基于 Yjs 的协同源码编辑支持活动会话、源码锚定批注、回复、解决状态，以及让审阅者可批注但不能修改源码的权限模型。
使用 latexmk 和可选择引擎进行编译，提供项目设置、结构化诊断、缓存的成功 PDF、可下载产物以及可选的项目级 latexmkrc。
每个项目拥有历史版本和仅所有者可用的 Git/GitHub 备份；Git 是可选依赖，仅在使用集成时才检查。

Docker 部署

如果宿主机没有，或不希望自行维护 Node.js、TeX Live、Git 和 Harper 等软件，可使用更重的 TexLite-Docker 部署。其已发布镜像会一并提供这些运行时依赖。

git clone https://github.com/SWUFE-DB-Group/TexLite-Docker.git
cd texlite-docker
cp deployment.example.json deployment.json
# 首次启动前请编辑 deployment.json。
./scripts/compose.sh pull
./scripts/compose.sh up -d
# 访问 <http://127.0.0.1:3040>

Docker 版的用户配置和日常运维请参见 TexLite-Docker README。

文档导航

| 需要了解 | 阅读 | | -------------------------------------------------------------- | ---------------------------------------------------------- | | 安装、配置路径、生效默认值、环境变量、服务管理、备份与安全边界 | 运维指南（英文） | | 协作、源码持久化、编译隔离、历史版本和设计权衡 | 设计文档（英文） | | 发布前测试 npm 包 | NPM 测试指南（英文） | | 完整配置起点 | texlite.config.example.json |

范围与安全

TexLite 是一个面向可信用户的单宿主机应用，并非 LaTeX 编译沙箱：LaTeX 本身以及启用的项目 latexmkrc 都可能执行强大的本机行为。不要直接暴露其服务端口。

TexLite Share 是最简单、专门面向 TexLite 的分享方式。根据部署环境，也可以使用 Tailscale Serve 构建私有 Tailnet，通过 Cloudflare Tunnel 提供托管的公网入口，或使用 frp 自行维护反向隧道。无论采用哪一种访问层，都应保留 TexLite 登录认证、启用 HTTPS、限制访问范围，并注意 LaTeX 编译环境并不是面向不可信代码的沙箱。

Published

Vulnerabilities

Links

Maintainers

Keywords

Readme