+4
Daily
18,343
stars
2,110
forks
208
watchers
284
prs
1,219
issues
4
releases
README
An open-source online real-time collaborative LaTeX editor. Wiki • Server Pro • Contributing • Mailing List • Authors • License Figure 1: A screenshot of a project being edited in Overleaf Community Edition. Community Edition Overleaf is an open-source online real-time collaborative LaTeX editor. We run a hosted version at www.overleaf.com, but you can also run your own local version, and contribute to the development of Overleaf. [!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 sharelatex container resources (filesystem, network, environment variables) when running LaTeX compiles. For more information on Sandbox Compiles check out our documentation. Enterprise If you want help installing and maintaining Overleaf in your lab or workplace, we offer an officially supported version called Overleaf Server Pro. It also includes more features for security (SSO with LDAP or SAML), administration and collaboration (e.g. tracked changes). Find out more! Keeping up to date Sign up to the mailing list to get updates on Overleaf releases and development. Installation We have detailed installation instructions in the Overleaf Toolkit. Upgrading If you are upgrading from a previous version of Overleaf, please see the Release Notes section on the Wiki for all of the versions between your current version and the version you are upgrading to. Overleaf Docker Image This repo contains two dockerfiles, Dockerfile-base, which builds the sharelatex/sharelatex-base image, and Dockerfile which builds the sharelatex/sharelatex (or "community") image. The Base image generally contains the basic dependencies like wget, plus texlive. We split this 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. We use the Phusion base-image (which is extended by our base image) to provide us with a VM-like container in which to run the Overleaf services. Baseimage uses the runit service manager to manage services, and we add our init-scripts from the server-ce/runit folder. Contributing Please see the CONTRIBUTING file for information on contributing to the development of Overleaf. Authors The Overleaf Team 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-2025.
Top issues
#299ShareLaTeX API49 comments · 2015-04-16#964Copy Files and Folders43 comments · 2021-10-07#782Support git integration in the community edition39 comments · 2020-09-08#482Feature Request: Latex Editor with Tabs35 comments · 2016-10-24#1193Is it possible to include the commenting feature in the Community Edition?34 comments · 2024-02-27#1126Feature request: Export PDF with comments34 comments · 2023-06-22#323Hard line break in the editor to make code more readable21 comments · 2015-05-29#198configurable tab behaviour17 comments · 2014-10-10