overleaf/services/clsi
2018-03-14 15:44:58 +00:00
..
app/coffee add logging in db.coffee 2018-03-14 15:44:58 +00:00
bin mvp 2018-03-02 17:14:20 +00:00
config wip for ci 2018-03-14 15:44:58 +00:00
docker-runner@65ad62116f unit tests pass, acceptence fail 2018-03-02 17:34:41 +00:00
src Add in a synctex end point 2014-04-08 15:18:56 +01:00
test added docker runner into core codebase 2018-03-14 15:44:49 +00:00
.gitignore mvp 2018-03-02 17:14:20 +00:00
.nvmrc updated build sripts with 1.0.3 2018-03-02 17:14:23 +00:00
.travis.yml Update .travis.yml 2014-02-24 14:42:36 +00:00
app.coffee acceptence tests pass inside docker container (apart from sync) 2018-03-02 17:14:23 +00:00
docker-compose-config.yml wip for ci 2018-03-14 15:44:58 +00:00
docker-compose.ci.yml removed user temporarly, created make ci task 2018-03-14 15:44:58 +00:00
docker-compose.yml set entry point for dockerfile 2018-03-14 15:44:58 +00:00
Dockerfile set entry point for dockerfile 2018-03-14 15:44:58 +00:00
entrypoint.sh set entry point for dockerfile 2018-03-14 15:44:58 +00:00
Gruntfile.coffee use grunt to make compiles and cache dirs 2017-08-07 16:21:37 +01:00
install_deps.sh add cache dir 2018-03-14 15:44:58 +00:00
Jenkinsfile removed user temporarly, created make ci task 2018-03-14 15:44:58 +00:00
kube.yaml updateded build scripts 2018-03-02 17:14:23 +00:00
LICENSE Create LICENSE 2014-02-18 17:09:54 +00:00
Makefile removed user temporarly, created make ci task 2018-03-14 15:44:58 +00:00
nodemon.json updated build sripts with 1.0.3 2018-03-02 17:14:23 +00:00
package-lock.json acceptence tests pass inside docker container (apart from sync) 2018-03-02 17:14:23 +00:00
package.json removed unused scripts 2018-03-14 15:44:58 +00:00
README.md Fix example request URL and JSON 2014-02-26 10:13:09 -05:00

clsi-sharelatex

A web api for compiling LaTeX documents in the cloud

Build Status

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.

Copyright (c) ShareLaTeX, 2014.