github/overleaf: A web-based collaborative LaTeX editor

mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00

A web-based collaborative LaTeX editor

Find a file

Brian Gough 1da0edbcaf Merge pull request #4801 from overleaf/ae-resync-editable-file Use a file hash to decide if a file is editable when resyncing GitOrigin-RevId: 57d78b3d73bf2595070a7c7eb7ec97eeece3a163		2021-08-24 08:03:28 +00:00
.github	Merge pull request #4855 from overleaf/jpa-public-github-templates	2021-08-23 11:31:06 +00:00
doc	Merge remote-tracking branch 'dev-env/jpa-monorepo' into main	2021-08-05 08:03:43 +00:00
libraries	Merge pull request #4800 from overleaf/jpa-object-persistor-fix-404-handling	2021-08-19 08:02:43 +00:00
server-ce	Merge pull request #4831 from overleaf/bg-move-history-id-cache-to-redis	2021-08-23 11:30:57 +00:00
services	Merge pull request #4801 from overleaf/ae-resync-editable-file	2021-08-24 08:03:28 +00:00
.gitignore	Merge pull request #4734 from overleaf/jpa-server-ce-build	2021-08-17 08:03:11 +00:00
CONTRIBUTING.md	Merge remote-tracking branch 'dev-env/jpa-monorepo' into main	2021-08-05 08:03:43 +00:00
docker-compose.debug.yml	Merge remote-tracking branch 'dev-env/jpa-monorepo' into main	2021-08-05 08:03:43 +00:00
docker-compose.yml	Merge pull request #4677 from overleaf/msm-remove-linked-url	2021-08-13 12:57:01 +00:00
LICENSE	Merge remote-tracking branch 'dev-env/jpa-monorepo' into main	2021-08-05 08:03:43 +00:00
README.md	Merge pull request #943 from overleaf:jpa-copybara-take-2	2021-08-16 08:03:02 +00:00

README.md

An open-source online real-time collaborative LaTeX editor.

Key Features • Wiki • Server Pro • Contributing • Mailing List • Authors • License

Figure 1: A screenshot of Overleaf Server Pro's comments and tracked changes features.

Key Features

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.

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 comes with extra security and admin features. Click here to find out more!

Keeping up to date

Installation

We have detailed installation instructions in our wiki:

Overleaf Quick Start Guide

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. See our wiki for information on setting up a development environment and how to recompile and run Overleaf after modifications.

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.