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

History

Brian Gough 8a2665911d allow direct path to output file /project/project_id/build/build_id/output/* this avoids use of the query string ?build=... and so we can match the url directly with the nginx location directive		2016-05-13 10:10:48 +01:00
..
app/coffee	fix logic excluding smoke test in metric	2016-05-10 10:10:01 +01:00
bin	Compile binary with install	2014-04-09 12:37:04 +01:00
config	server load endpoint uses settings for port	2016-04-11 13:47:06 +01:00
src	Add in a synctex end point	2014-04-08 15:18:56 +01:00
test	check directory exists before attempting to clear it	2016-03-31 11:59:17 +01:00
.gitignore	Add in a synctex end point	2014-04-08 15:18:56 +01:00
.travis.yml	Update .travis.yml	2014-02-24 14:42:36 +00:00
app.coffee	allow direct path to output file /project/project_id/build/build_id/output/*	2016-05-13 10:10:48 +01:00
Gruntfile.coffee	Use find -type f to get a list of output files	2014-12-09 11:08:07 +00:00
LICENSE	Create LICENSE	2014-02-18 17:09:54 +00:00
package.json	upgrade to the latest version of request	2016-03-31 14:03:48 +01:00
README.md	Fix example request URL and JSON	2014-02-26 10:13:09 -05:00

README.md

clsi-sharelatex

A web api for compiling LaTeX documents in the cloud

Installation

The CLSI can be installed and set up as part of the entire ShareLaTeX stack (complete with front end editor and document storage), or it can be run as a standalone service. To run is as a standalone service, first checkout this repository:

$ git clone git@github.com:sharelatex/clsi-sharelatex.git

Then install the require npm modules:

$ npm install

Then compile the coffee script source files:

$ grunt install

Finally, (after configuring your local database - see the Config section), run the CLSI service:

$ grunt run

The CLSI should then be running at http://localhost:3013.

Config

You will need to set up a database in mysql to use with the CLSI, and then fill in the database name, username and password in the config file at config/settings.development.coffee.

API

The CLSI is based on a JSON API.

Example Request

(Note that valid JSON should not contain any comments like the example below).

POST /project/<project-id>/compile

{
    "compile": {
        "options": {
            // Which compiler to use. Can be latex, pdflatex, xelatex or lualatex
            "compiler": "lualatex",
            // How many seconds to wait before killing the process. Default is 60.
            "timeout": 40 
        },
        // The main file to run LaTeX on
        "rootResourcePath": "main.tex", 
        // An array of files to include in the compilation. May have either the content
        // passed directly, or a URL where it can be downloaded.
        "resources": [{
            "path": "main.tex",
            "content": "\\documentclass{article}\n\\begin{document}\nHello World\n\\end{document}"
        }, {
            "path": "image.png",
            "url": "www.example.com/image.png",
            "modified": 123456789 // Unix time since epoch
        }]
    }
}

You can specify any project-id in the URL, and the files and LaTeX environment will be persisted between requests. URLs will be downloaded and cached until provided with a more recent modified date.

Example Response

{
    "compile": {
        "status": "success",
        "outputFiles": [{
            "type": "pdf",
            "url": "http://localhost:3013/project/<project-id>/output/output.pdf"
        }, {
            "type": "log",
            "url": "http://localhost:3013/project/<project-id>/output/output.log"
        }]
    }
}

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.