mirror of https://github.com/overleaf/overleaf.git synced 2024-12-24 18:12:02 +00:00

History

mserranom 1973fbddf1 removed nvm		2019-08-06 12:00:55 +00:00
..
bin	removed nvm	2019-08-06 12:00:55 +00:00
config
migrations	Merge pull request #570 from sharelatex/sk-unlisted-projects	2018-08-02 10:11:13 +01:00
tasks
.gitignore
.nvmrc	updated node version	2019-07-23 12:56:25 +00:00
CONTRIBUTING.md	Update CLA and other links	2019-04-10 16:15:41 +01:00
docker-compose.yml	Update docker-compose.yml	2019-05-31 10:27:15 +01:00
Gruntfile.coffee
ISSUE_TEMPLATE
ISSUE_TEMPLATE.md
LICENSE
npm-shrinkwrap.json
package.json
README.md	update README	2019-05-07 19:29:46 +02:00

README.md

Overleaf

Overleaf is an open-source online real-time collaborative LaTeX editor. We run a hosted version at http://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 at your university 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.

Other repositories

This repository does not contain any code. It acts a wrapper and toolkit for managing the many different Overleaf services. These each run as their own Node.js process and have their own Github repository. These are all downloaded and set up when you run grunt install

The different services are:

web

The front facing web server that serves all the HTML pages, CSS and JavaScript to the client. Also contains a lot of logic around creating and editing projects, and account management.

document-updater

Processes updates that come in from the editor when users modify documents. Ensures that the updates are applied in the right order, and that only one operation is modifying the document at a time. Also caches the documents in redis for very fast but persistent modifications.

CLSI

The Common LaTeX Service Interface (CLSI) which provides an API for compiling LaTeX documents.

docstore

An API for performing CRUD (Create, Read, Update and Delete) operations on text files stored in Overleaf.

realtime

The websocket process clients connect to

filestore

An API for performing CRUD (Create, Read, Update and Delete) operations on binary files (like images) stored in Overleaf.

track-changes

An API for compressing and storing the updates applied to a document, and then rendering a diff of the changes between any two time points.

chat

The backend API for storing and fetching chat messages.

spelling

An API for running server-side spelling checking on Overleaf documents.

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.