Henry Oswald fc594f7d8e add logging of docker options		vor 8 Jahren
..
app	fc594f7d8e add logging of docker options	vor 8 Jahren
bin	6d21ab734a try copying synctex betwen directories	vor 8 Jahren
config	8dce1e2958 wip for ci	vor 8 Jahren
src	892e6bf6d1 Add in a synctex end point	vor 12 Jahren
test	e4e30cf2e2 fixed commended tests	vor 8 Jahren
.dockerignore	c080938480 add docker ignore rather than make clean	vor 8 Jahren
.gitignore	4179d19200 move synctex into a directory for simple mounting	vor 8 Jahren
.nvmrc	ece0540318 updated build sripts with 1.0.3	vor 8 Jahren
.travis.yml	6b450a45a7 Update .travis.yml	vor 12 Jahren
Dockerfile	c080938480 add docker ignore rather than make clean	vor 8 Jahren
Gruntfile.coffee	1e34f6371e use grunt to make compiles and cache dirs	vor 9 Jahren
Jenkinsfile	43b1fe4b68 test new scripts on ci	vor 8 Jahren
LICENSE	70c6b0b8da Create LICENSE	vor 12 Jahren
Makefile	3c2172434b have entrypoint kickoff download off texlive images	vor 8 Jahren
README.md	2b5e369b98 Fix example request URL and JSON	vor 12 Jahren
app.coffee	2d03cb3eb1 added debugging and new moving commands	vor 8 Jahren
docker-compose-config.yml	8dce1e2958 wip for ci	vor 8 Jahren
docker-compose.ci.yml	c80c38b7a9 update build scripts	vor 8 Jahren
docker-compose.yml	c80c38b7a9 update build scripts	vor 8 Jahren
entrypoint.sh	2d03cb3eb1 added debugging and new moving commands	vor 8 Jahren
install_deps.sh	2d03cb3eb1 added debugging and new moving commands	vor 8 Jahren
kube.yaml	b1c0abbd4d updateded build scripts	vor 8 Jahren
nodemon.json	ece0540318 updated build sripts with 1.0.3	vor 8 Jahren
package-lock.json	fdac655cd4 acceptence tests pass inside docker container (apart from sync)	vor 8 Jahren
package.json	b714ea193a remove texlive docker images	vor 8 Jahren

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