github/overleaf: A web-based collaborative LaTeX editor

mirror of https://github.com/overleaf/overleaf.git synced 2024-12-28 21:22:16 +00:00

A web-based collaborative LaTeX editor

Find a file

Jakob Ackermann 6d4d643fd9 Merge pull request #13325 from overleaf/jpa-real-time-check [real-time] add check for project admin GitOrigin-RevId: 1677b78cf7f263fc98ca539e26e21553d0ea55bd		2023-07-17 10:23:24 +00:00
.github
develop	Merge pull request #13115 from overleaf/msm-remove-track-changes-sp	2023-05-26 08:03:54 +00:00
doc
libraries	Merge pull request #13256 from overleaf/csh-issue-13004-max-retries	2023-06-02 08:07:17 +00:00
patches	Merge pull request #13056 from overleaf/jpa-pipeline-express	2023-05-25 08:03:47 +00:00
server-ce	Merge pull request #13298 from overleaf/msm-hotfix-3_5_7	2023-06-02 08:05:41 +00:00
services	Merge pull request #13325 from overleaf/jpa-real-time-check	2023-07-17 10:23:24 +00:00
.gitignore
CONTRIBUTING.md
docker-compose.debug.yml
docker-compose.yml	Merge pull request #13141 from overleaf/msm-update-redis-ce-sp	2023-05-19 08:04:26 +00:00
LICENSE
package-lock.json	Merge pull request #13261 from overleaf/msm-replace-referer-parser	2023-06-02 08:06:51 +00:00
package.json	Merge pull request #12949 from overleaf/jpa-upgrade-eslint-plugin-mocha	2023-05-05 08:04:28 +00:00
README.md

README.md

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.

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

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 and aspell, 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.