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

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