Tobias Hallmen
d796ccb39d
* document-updater: HTTP route to add a comment range to a doc POST /project/:project_id/doc/:doc_id/comment applies a comment op to the doc in document-updater (as the real-time path does), so web modules can create anchored review comments without a websocket connection. * token-api: review comments API authenticated by git-bridge tokens New module token-api under /api/v1/project/:project_id for scripts and agents: list comment threads and tracked changes (JSON or Markdown, with file, line and quote), create anchored comments, reply, resolve and reopen. Authenticates with the git-bridge personal access tokens (Bearer). Permissions follow the editor's review routes (as tightened in #271): non-members and restricted link-sharing users get 404, read-only members may read and comment, resolve/reopen is allowed for owners and editors on any thread and for reviewers on threads they started. Site admins get no special access. Requests are audit-logged. The module README is served at GET /api/v1. The git integration widget notes that tokens also authenticate this API.
An open-source online real-time collaborative LaTeX editor.
Wiki • Server Pro • Authors • License
Figure 1: A screenshot of a project being edited in Overleaf CE+
Community Edition
Overleaf is an open-source online real-time collaborative LaTeX editor. Overleaf runs a hosted version at www.overleaf.com, but you can also run your own local version, and contribute to the development of Overleaf.
Extended Community Edition (CE+)
The present "extended" version of Overleaf CE includes:
- Sandboxed compiles with TeX Live image selection
- Sign Up page
- LDAP authentication
- SAML authentication
- OpenID Connect authentication
- Real-time track changes and comments
- Symbol palette
- Template gallery
- Import file from external URL
- Git integration
- GitHub synchronization
- Zotero integration
- Reference Search and Pick Tool
- Document Import (
.docx,.md) and Export (.docx,.md,.html) - Advanced administrator tools for managing user accounts and projects
- Python script runner
- Logo tools
Caution
Overleaf Community Edition is intended for use in environments where all users are trusted. Community Edition is not appropriate for scenarios where isolation of users is required due to Sandbox Compiles not being available. When not using Sandboxed Compiles, users have full read and write access to the
sharelatexcontainer resources (filesystem, network, environment variables) when running LaTeX compiles. Therefore, in any environment where not all users can be fully trusted, it is strongly recommended to enable the Sandboxed Compiles feature available in the Extended Community Edition.
For more information on Sandbox Compiles check out Overleaf documentation.
Enterprise
If you want help installing and maintaining Overleaf in your lab or workplace, Overleaf offers an officially supported version called Overleaf Server Pro.
Installation
Detailed installation instructions can be found in the Overleaf Toolkit. Configuration details and release history for the Extended Community Edition can be found on the Extended CE Wiki Page.
Overleaf Docker Image
This repo contains two dockerfiles, Dockerfile-base, which builds the
sharelatex/sharelatex-base:ext-ce image, and Dockerfile which builds the
sharelatex/sharelatex:ext-ce image.
The Base image generally contains the basic dependencies like wget, plus texlive.
This is split out because it's a pretty heavy set of
dependencies, and it's nice to not have to rebuild all of that every time.
The sharelatex/sharelatex image extends the base image and adds the actual Overleaf code
and services.
Use make build-base and make build-community from server-ce/ to build these images.
The Phusion base-image
(which is extended by the base image) provides a VM-like container
in which to run the Overleaf services. Baseimage uses the runit service
manager to manage services, and init scripts from the server-ce/runit
folder are added.
Authors
The Overleaf Team
yu-i-i, davrot — CE extensions; references to adapted code are listed in CREDITS. See also the authors of individual commits.
License
The code in this repository is released under the GNU AFFERO GENERAL PUBLIC LICENSE, version 3. A copy can be found in the LICENSE file.
Copyright (c) Overleaf, 2014-2026.
Copyright (c) @yu-i-i, @davrot, 2024-2026, for CE extensions.
Portions of the code are derived from other open-source projects; see CREDITS.