mirror of
https://github.com/overleaf/overleaf.git
synced 2025-03-17 20:41:07 +00:00
Made detailed readme.
This commit is contained in:
parent
f8c311688d
commit
dad5d5a334
1 changed files with 30 additions and 5 deletions
|
@ -1,12 +1,37 @@
|
||||||
writelatex-git-bridge
|
writelatex-git-bridge
|
||||||
=====================
|
=====================
|
||||||
|
|
||||||
ant test: run unit and system tests.
|
Required
|
||||||
|
--------
|
||||||
|
* ant (for building)
|
||||||
|
* jdk-7 (for compiling and running)
|
||||||
|
|
||||||
ant all: build the server into ./bin/writelatex-git-bridge.jar
|
Building
|
||||||
|
--------
|
||||||
|
### Ubuntu ###
|
||||||
|
Run `/install.sh` to get dependencies, build, test, package, and make it a service.
|
||||||
|
|
||||||
ant clean: clean built files
|
Use `service wlgb start` and `service wlgb stop` to start and stop the server.
|
||||||
|
|
||||||
to run:
|
The configuration file will be at `/etc/wlgb/config.json`.
|
||||||
|
### Using ant ###
|
||||||
|
Run `ant all` to build, test, and package it into a jar at `bin/writelatex-git-bridge.jar`.
|
||||||
|
|
||||||
java -jar ./bin/writelatex-git-bridge.jar port root_git_directory
|
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": the port number (int),
|
||||||
|
"rootGitDirectory": the directory in which to store git repos and the db/atts (string),
|
||||||
|
"apiKey": currently does nothing (string),
|
||||||
|
"apiBaseUrl": base url for the snapshot api (string),
|
||||||
|
"username": username for http basic auth (string, optional),
|
||||||
|
"password": password for http basic auth (string, optional),
|
||||||
|
"serviceName": current name of writeLaTeX in case it ever changes (string)
|
||||||
|
}
|
||||||
|
|
||||||
|
You have to restart the server for configuration changes to take effect.
|
||||||
|
|
Loading…
Reference in a new issue