Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/luzifer/tex-api
tex-api is a docker container being able to generate a PDF document from a LaTeX file and additional assets using a simple curl call.
https://github.com/luzifer/tex-api
api docker golang latex
Last synced: 3 months ago
JSON representation
tex-api is a docker container being able to generate a PDF document from a LaTeX file and additional assets using a simple curl call.
- Host: GitHub
- URL: https://github.com/luzifer/tex-api
- Owner: Luzifer
- License: apache-2.0
- Created: 2017-03-05T22:41:25.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2024-06-15T11:47:46.000Z (7 months ago)
- Last Synced: 2024-06-20T03:34:07.719Z (7 months ago)
- Topics: api, docker, golang, latex
- Language: Go
- Homepage:
- Size: 1.62 MB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: History.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[](https://goreportcard.com/report/github.com/Luzifer/tex-api)
# Luzifer / tex-api
`tex-api` is a docker container being able to generate a PDF document from a LaTeX file and additional assets using a simple `curl` call.
## Usage
- Start the container at a trusted location:
`docker run -d -p 3000:3000 -v /data/tex-api:/storage luzifer/tex-api`
- Optionally provide a default env:
`docker run -d -p 3000:3000 -v /etc/tex-api/defaultenv:/default -e DEFAULT_ENV=/default luzifer/tex-api`
- Compile a ZIP file, send it to the API and get the result:
```bash
# zip -r letter.zip fonts main.tex sig.jpeg
adding: fonts/ (stored 0%)
adding: fonts/Roboto-Black.ttf (deflated 46%)
adding: fonts/Roboto-BlackItalic.ttf (deflated 46%)
adding: fonts/Roboto-Bold.ttf (deflated 47%)
adding: fonts/Roboto-BoldItalic.ttf (deflated 45%)
adding: fonts/Roboto-Italic.ttf (deflated 47%)
adding: fonts/Roboto-Light.ttf (deflated 47%)
adding: fonts/Roboto-LightItalic.ttf (deflated 47%)
adding: fonts/Roboto-Medium.ttf (deflated 46%)
adding: fonts/Roboto-MediumItalic.ttf (deflated 46%)
adding: fonts/Roboto-Regular.ttf (deflated 46%)
adding: fonts/Roboto-Thin.ttf (deflated 44%)
adding: fonts/Roboto-ThinItalic.ttf (deflated 42%)
adding: fonts/RobotoMono-Bold.ttf (deflated 41%)
adding: fonts/RobotoMono-BoldItalic.ttf (deflated 40%)
adding: fonts/RobotoMono-Italic.ttf (deflated 39%)
adding: fonts/RobotoMono-Light.ttf (deflated 42%)
adding: fonts/RobotoMono-LightItalic.ttf (deflated 41%)
adding: fonts/RobotoMono-Medium.ttf (deflated 41%)
adding: fonts/RobotoMono-MediumItalic.ttf (deflated 40%)
adding: fonts/RobotoMono-Regular.ttf (deflated 41%)
adding: fonts/RobotoMono-Thin.ttf (deflated 41%)
adding: fonts/RobotoMono-ThinItalic.ttf (deflated 40%)
adding: main.tex (deflated 58%)
adding: sig.jpeg (deflated 3%)
# curl -sSL -H 'Accept: application/tar' --data-binary @letter.zip localhost:3000/job | tar -xvf -
main.log
main.pdf
# Using the default-env and exchanging a TeX file for a PDF
# curl -L -H 'Accept: application/pdf' --data-binary @main.tex -OJ localhost:3000/job
```
What happened here is we packed all assets required for generating the letter into the ZIP archive, pushed it to the API, waited for it to build a TAR and extracted the resulting files from it.
## API
```
POST /job Create a new processing job (request body is expected
to be a ZIP file having at least one .tex file at the
root of the archive) and redirect to the /wait endpoint
Alternatively you can post a raw TeX file and let it
render through the default environment provided when
starting your container
GET /job/{uuid} Retrieve the status of the processing job
GET /job/{uuid}/wait Wait and redirect until the processing job is finished
or errored
GET /job/{uuid}/download Download the resulting archive (You may specify an
Accept header to select whether to receive a ZIP, a
TAR archive or just the raw PDF.)
```
Supported query parameters:
- `format` overrides the `Accept` header detection and choses the output format (`pdf`, `tar`, `zip`) and is accepted on all endpoints
- `log-on-error` - If set a PDF download (`Accept` header set to `application/pdf` or `format` is chosen) will return the log instead of the PDF if no PDF is found.
- `report-urls` on the `POST /jobs` endpoint will not redirect to the wait endpoint but report a JSON object containing the URL paths:
```json
{
"download": "/job/fb5ee7b8-679a-4bf2-951b-acabaf43b43e/download",
"status": "/job/fb5ee7b8-679a-4bf2-951b-acabaf43b43e",
"wait": "/job/fb5ee7b8-679a-4bf2-951b-acabaf43b43e/wait"
}
```