Winston Li 128e24d2fb Added checking for the master branch. %!s(int64=12) %!d(string=hai) anos
..
.idea 2a02ed466a Added sqlite-jbdc-3.7.2.jar and javadocs to ant build. %!s(int64=12) %!d(string=hai) anos
bin f8c311688d Changed hostname to apiBaseUrl. %!s(int64=12) %!d(string=hai) anos
libs 2a02ed466a Added sqlite-jbdc-3.7.2.jar and javadocs to ant build. %!s(int64=12) %!d(string=hai) anos
src 128e24d2fb Added checking for the master branch. %!s(int64=12) %!d(string=hai) anos
test c39e93c152 Changed program arguments to only take config file. %!s(int64=12) %!d(string=hai) anos
.gitignore 86a1887d1d No longer ignoring bin, but ignoring .jars. %!s(int64=12) %!d(string=hai) anos
.travis.yml abe140c9e7 Changed deps to all in build.xml. %!s(int64=12) %!d(string=hai) anos
LICENSE 9f38a40cd2 Initial commit %!s(int64=12) %!d(string=hai) anos
README.md d022acc5c8 Small fixes to README. %!s(int64=12) %!d(string=hai) anos
build.xml ac47f09eb4 Generate valid jar file with manifest %!s(int64=12) %!d(string=hai) anos
install-deps.sh 332d776ad1 Fixed install-deps.sh. %!s(int64=12) %!d(string=hai) anos
install.sh e6274b110b Added -p to mkdir and made uninstall.sh delete /etc/wlgb %!s(int64=12) %!d(string=hai) anos
uninstall.sh e6274b110b Added -p to mkdir and made uninstall.sh delete /etc/wlgb %!s(int64=12) %!d(string=hai) anos
writelatex-git-bridge.iml dff1222052 Moved unit tests directory. %!s(int64=12) %!d(string=hai) anos

README.md

writelatex-git-bridge

Required

  • ant (for building)
  • jdk-7 (for compiling and running)

Installation

Ubuntu

Run install.sh to get dependencies, build, test, package, and make it a service.

Use service wlgb start and service wlgb stop to start and stop the server.

The configuration file will be at /etc/wlgb/config.json.

Run uninstall.sh to undo what install.sh did.

Manually

Run ant all to build, test, and package it into a jar at bin/writelatex-git-bridge.jar.

Use java -jar <path_to_jar> <path_to_config_file> to run the server.

Runtime Configuration

The configuration file is in .json format. There is an example at bin/config.json.

{
    "port" (int): the port number,
    "rootGitDirectory" (string): the directory in which to store git repos and the db/atts,
    "apiKey" (string): currently does nothing,
    "apiBaseUrl" (string): base url for the snapshot api,
    "username" (string, optional): username for http basic auth,
    "password" (string, optional): password for http basic auth,
    "serviceName" (string): current name of writeLaTeX in case it ever changes ;)
}

You have to restart the server for configuration changes to take effect.