Henry Oswald 551e8d36b4 update build script and add load balancer agent		8 år sedan
..
app	f496de6d13 don't put synctex in as a volume	8 år sedan
bin	f496de6d13 don't put synctex in as a volume	8 år sedan
config	41e39458d1 add smoke test env var	8 år sedan
src	892e6bf6d1 Add in a synctex end point	12 år sedan
test	e4e30cf2e2 fixed commended tests	8 år sedan
.dockerignore	c080938480 add docker ignore rather than make clean	8 år sedan
.gitignore	4179d19200 move synctex into a directory for simple mounting	8 år sedan
.nvmrc	ece0540318 updated build sripts with 1.0.3	8 år sedan
.travis.yml	6b450a45a7 Update .travis.yml	12 år sedan
.viminfo	551e8d36b4 update build script and add load balancer agent	8 år sedan
Dockerfile	551e8d36b4 update build script and add load balancer agent	8 år sedan
Gruntfile.coffee	1e34f6371e use grunt to make compiles and cache dirs	9 år sedan
Jenkinsfile	43b1fe4b68 test new scripts on ci	8 år sedan
LICENSE	70c6b0b8da Create LICENSE	12 år sedan
Makefile	551e8d36b4 update build script and add load balancer agent	8 år sedan
README.md	2b5e369b98 Fix example request URL and JSON	12 år sedan
app.coffee	551e8d36b4 update build script and add load balancer agent	8 år sedan
debug	551e8d36b4 update build script and add load balancer agent	8 år sedan
docker-compose-config.yml	8dce1e2958 wip for ci	8 år sedan
docker-compose.ci.yml	551e8d36b4 update build script and add load balancer agent	8 år sedan
docker-compose.yml	551e8d36b4 update build script and add load balancer agent	8 år sedan
entrypoint.sh	551e8d36b4 update build script and add load balancer agent	8 år sedan
install_deps.sh	9731267ae5 try a build with node user	8 år sedan
kube.yaml	b1c0abbd4d updateded build scripts	8 år sedan
nodemon.json	551e8d36b4 update build script and add load balancer agent	8 år sedan
package-lock.json	551e8d36b4 update build script and add load balancer agent	8 år sedan
package.json	551e8d36b4 update build script and add load balancer agent	8 år sedan
patch-texlive-dockerfile	551e8d36b4 update build script and add load balancer agent	8 år sedan
synctex.profile	551e8d36b4 update build script and add load balancer agent	8 år sedan

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.

README.md