https://github.com/dbrgn/github-latex-builder
Github LaTeX builder. Provides a Github webhook to automatically pull and build all LaTeX documents in a repository.
https://github.com/dbrgn/github-latex-builder
Last synced: 11 months ago
JSON representation
Github LaTeX builder. Provides a Github webhook to automatically pull and build all LaTeX documents in a repository.
- Host: GitHub
- URL: https://github.com/dbrgn/github-latex-builder
- Owner: dbrgn
- License: mit
- Created: 2012-10-26T23:40:27.000Z (over 13 years ago)
- Default Branch: master
- Last Pushed: 2015-04-28T13:07:49.000Z (about 11 years ago)
- Last Synced: 2025-07-26T20:36:57.530Z (12 months ago)
- Language: Python
- Size: 134 KB
- Stars: 6
- Watchers: 3
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
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///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.