Giter Club home page Giter Club logo

github-latex-builder's Introduction

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.

github-latex-builder's People

Contributors

dbrgn avatar

Stargazers

Bob Blanchett avatar

Watchers

Federico Tomassetti avatar James Cloos avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.