mirror of https://github.com/overleaf/overleaf.git synced 2024-10-17 21:05:04 -04:00

A web-based collaborative LaTeX editor

Find a file

James Allen 87376120c9 Update README.md		2014-02-20 16:37:34 +00:00
cache	Configure CLSI to use sqllite	2014-02-18 17:40:23 +00:00
config	Configure CLSI to use sqllite	2014-02-18 17:40:23 +00:00
.gitignore	Configure CLSI to use sqllite	2014-02-18 17:40:23 +00:00
CONTRIBUTING.md	Update CONTRIBUTING.md	2014-02-15 18:31:12 +00:00
Gruntfile.coffee	Remove old method of installing local settings	2014-02-19 13:23:49 +00:00
LICENSE	Create LICENSE	2014-02-20 16:36:39 +00:00
package.json	Update dependencies	2014-02-19 15:37:47 +00:00
README.md	Update README.md	2014-02-20 16:37:34 +00:00

README.md

ShareLaTeX

ShareLaTeX is a web-based collaborative LaTeX editor. We run a hosted service at https://www.sharelatex.com and this repository contains the open source code that powers it and allows you to run a local installation.

ShareLaTeX uses a service orientied architecture (SOA) where we have lots of small APIs that talk to each other over HTTP and Redis pub-sub channels. This repository pulls together all of the different services and allows you to set up and run them quickly.

Installation

First, check out a local copy of this repository:

$ git clone git@github.com:sharelatex/sharelatex.git
$ cd sharelatex

Next install all the node modules and ShareLaTeX services:

$ npm install
$ grunt install

When that has finished, run ShareLaTeX with

$ grunt run

ShareLaTeX should now be running at http://localhost:3000.

Dependencies

ShareLaTeX should run on OS X and Linux. You need:

Node.js 0.10 or greater
The grunt command line tools (Run npm install -g grunt-cli to install them)
A local instance of Redis and MongoDB running on their standard ports.

Config

ShareLaTeX should mostly run out of the box, although it uses Amazon S3 for storing binary files like images. You will need to configure ShareLaTeX to use your own S3 access key which can be done by editing the file at config/settings.development.coffee

A local settings file can be specified by setting the SHARELATEX_CONFIG environment variable to point to your own settings file. E.g.

$ export SHARELATEX_CONFIG=/home/james/config/settings.development.coffee

Other repositories

ShareLaTeX consists of many separate services, each with their own Node.js process and source code repository. These are all downloaded and set upwhen 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.

filestore

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

Contributing

Please see the CONTRIBUTING file for information on contributing to the development of ShareLaTeX.

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.