https://github.com/overleaf/overleaf

A web-based collaborative LaTeX editor
https://github.com/overleaf/overleaf

Last synced: 20 days ago
JSON representation

A web-based collaborative LaTeX editor

• Host: GitHub
• URL: https://github.com/overleaf/overleaf
• Owner: overleaf
• License: agpl-3.0
• Created: 2014-02-08T20:20:34.000Z (almost 11 years ago)
• Default Branch: main
• Last Pushed: 2024-10-17T08:07:28.000Z (about 1 month ago)
• Last Synced: 2024-10-17T23:56:17.388Z (about 1 month ago)
• Language: JavaScript
• Homepage:
• Size: 186 MB
• Stars: 13,975
• Watchers: 209
• Forks: 1,432
• Open Issues: 180
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

• awesome - overleaf/overleaf - A web-based collaborative LaTeX editor (JavaScript)
• awesome-ccamel - overleaf/overleaf - A web-based collaborative LaTeX editor (JavaScript)
• awesome-starred - overleaf - A web-based collaborative LaTeX editor (CoffeeScript)
• awesome-robotic-tooling - overleaf - An open-source online real-time collaborative LaTeX editor. (Documentation and Presentation)
• stars - overleaf/overleaf - A web-based collaborative LaTeX editor (JavaScript)
• AiTreasureBox - overleaf/overleaf - 11-02_14056_0](https://img.shields.io/github/stars/overleaf/overleaf.svg)|A web-based collaborative LaTeX editor| (Repos)
• awesome-starred - overleaf/overleaf - A web-based collaborative LaTeX editor (others)
• jimsghstars - overleaf/overleaf - A web-based collaborative LaTeX editor (JavaScript)
• awesome-homelab - ShareLaTex - based collaborative LaTeX editor | (Apps / Writing)

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](https://www.overleaf.com) is an open-source online real-time collaborative LaTeX editor. We run a hosted version at [www.overleaf.com](https://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](https://www.overleaf.com/for/enterprises). It also includes more features for security (SSO with LDAP or SAML), administration and collaboration (e.g. tracked changes). [Find out more!](https://www.overleaf.com/for/enterprises)

## Keeping up to date

Sign up to the [mailing list](https://mailchi.mp/overleaf.com/community-edition-and-server-pro) to get updates on Overleaf releases and development.

## Installation

We have detailed installation instructions in the [Overleaf Toolkit](https://github.com/overleaf/toolkit/).

## Upgrading

If you are upgrading from a previous version of Overleaf, please see the [Release Notes section on the Wiki](https://github.com/overleaf/overleaf/wiki#release-notes) 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`](server-ce/Dockerfile-base), which builds the

`sharelatex/sharelatex-base` image, and [`Dockerfile`](server-ce/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](https://github.com/phusion/baseimage-docker)

(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](CONTRIBUTING.md) file for information on contributing to the development of Overleaf.

## Authors

[The Overleaf Team](https://www.overleaf.com/about)

## 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`](LICENSE) file.

Copyright (c) Overleaf, 2014-2024.