Winston Li f5e068a46e Updated readme. 12 年之前
..
.idea 5633526845 Modifications to install script and deleted betamax jars. 12 年之前
bin 26e2b1262d Implemented mock snapshot server. 12 年之前
src 0e6f554e42 Added opposite arrows for inbound http requests. 12 年之前
test ca936d6630 Added better logging with timestamps and removed verbose http responses. 12 年之前
.gitignore 5633526845 Modifications to install script and deleted betamax jars. 12 年之前
.travis.yml 27e0952afb Converted build tool to Maven. 12 年之前
LICENSE 9f38a40cd2 Initial commit 12 年之前
README.md f5e068a46e Updated readme. 12 年之前
install 937c36d61e Changed mv jar to cp jar. 12 年之前
pom.xml 27e0952afb Converted build tool to Maven. 12 年之前
reinstall 460ba0c4d7 Added reinstall script and changed script names. 12 年之前
uninstall 460ba0c4d7 Added reinstall script and changed script names. 12 年之前
writelatex-git-bridge.iml 5633526845 Modifications to install script and deleted betamax jars. 12 年之前

README.md

writelatex-git-bridge

Required

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

Installation

Ubuntu

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

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

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

Run ./reinstall to test, package and install the current version if ./install has already been run.

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

Manually

Run mvn package to build, test, and package it into a jar at target/writelatex-git-bridge-1.0-SNAPSHOT-jar-with-dependencies.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,
    "apiBaseUrl" (string): base url for the snapshot api,
    "username" (string, optional): username for http basic auth,
    "password" (string, optional): password for http basic auth,
    "postbackBaseUrl" (string): the postback url,
    "serviceName" (string): current name of writeLaTeX in case it ever changes
}

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