Skip to content

Github LaTeX builder. Provides a Github webhook to automatically pull and build all LaTeX documents in a repository.

License

Notifications You must be signed in to change notification settings

dbrgn/github-latex-builder

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

16 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Github LaTeX Builder

Github LaTeX builder is a script that provides a Github Webhook URL and builds the LaTeX repository on each new commit.

!DANGER!

This script is not yet finished. There are still some serious security issues that need to be fixed. In case you still want to run it, make sure that the permissions are locked down and you're running the script in a chroot.

Setup Server

Prerequisites:

  • A LaTeX compiler (e.g. texlive, installing texlive-full is recommended)
  • GNU Make
  • latexmk (usually comes with texlive)
  • Python 2
  • pip
pip install -r requirements.txt
python server.py

The webhook URL is now running at http://localhost:9393/webhook

Other commandline options:

Usage:
    server.py [-i HOST] [-p PORT]
    server.py --help
    server.py --version

Options:
    -h --help  Show this message.
    --version  Show the version.
    -i HOST    Hostname or IP to bind to [default: localhost].
    -p PORT    Port number [default: 9393].

Setup Repository

Add the publicly accessible Webhook URL to https://github.com/<user>/<repo>/admin/hooks.

Access Codes

If you want to use access codes (highly recommended) to authorize webhook POSTs, create a file called access_codes and add valid codes to it (one per line). The use of UUIDs as access codes is recommended (see http://www.guidgenerator.com/).

In case you want to comment access codes, you can do that following a hash (#) character.

In order for a callback URL to be accepted by the server, you need to add a valid access code to the access_code GET parameter:

http://path-to-server.tld/webhook?access_code=8e4261d4-e3f8-441d-a86d-09748b8345d5

License

MIT License, see LICENSE file.

About

Github LaTeX builder. Provides a Github webhook to automatically pull and build all LaTeX documents in a repository.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages