Henry Oswald b0743a3c2a added realtime to list of repos		10 tahun lalu
..
cache	74650cf678 Configure CLSI to use sqllite	12 tahun lalu
chef	5a9c8e0127 Add nginx config file to .deb build	12 tahun lalu
config	1bd2404be1 remove whitespace before internal settings and add realtime config to settings.development.coffee.example	11 tahun lalu
migrations	39e10c88c1 improve performance for migrating large dochistory collections	10 tahun lalu
package	2ab9b1ca26 Add missed nginx file	11 tahun lalu
.gitignore	123ba63ed4 finished migration script	11 tahun lalu
.nvmrc	b02248bffb Add .nvmrc	12 tahun lalu
CHANGELOG.md	044ae86866 Update CHANGELOG.md	11 tahun lalu
CONTRIBUTING.md	0ede6911dd Update CONTRIBUTING.md	12 tahun lalu
Gruntfile.coffee	0218f9624e add the migrate task into grunt	11 tahun lalu
LICENSE	e84928f03a Create LICENSE	12 tahun lalu
README.md	b0743a3c2a added realtime to list of repos	10 tahun lalu
Vagrantfile	ff3c813c7c Generate Secret keys properly and start services on boot	12 tahun lalu
package.json	58e12258f6 added migrations with east package	11 tahun lalu

ShareLaTeX

ShareLaTeX is an open-source online real-time collaborative LaTeX editor. We run a hosted version at http://www.sharelatex.com, but you can also run your own local version, and contribute to the development of ShareLaTeX.

If you want help installing and maintaining ShareLaTeX at your university or workplace, we offer an officially supported version called ShareLaTeX 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:

Installing ShareLaTeX in Production using docker

Upgrading

If you are upgrading from a previous version of ShareLaTeX, 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 ShareLaTeX 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 ShareLaTeX.

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 ShareLaTeX.

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 ShareLaTeX documents.

Contributing

Please see the CONTRIBUTING file for information on contributing to the development of ShareLaTeX. See our wiki for information on setting up a development environment and how to recompile and run ShareLaTeX after modifications.

Authors

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.

README.md