github/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2024-11-21 20:47:08 -05:00
Code Issues Projects Releases Packages Wiki Activity

Changed README.

Browse source
This commit is contained in:
Winston Li 2014-12-06 02:01:47 +00:00
parent bfefbf0737
commit 84ec961cfb
1 changed files with 10 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

20
services/git-bridge/README.md
View file

@ -6,15 +6,15 @@ Required
* `ant` (for building) * `ant` (for building)
* `jdk-7` (for compiling and running) * `jdk-7` (for compiling and running)
Building Installation
-------- ------------
### Ubuntu ### ### Ubuntu ###
Run `/install.sh` to get dependencies, build, test, package, and make it a service. 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. Use `service wlgb start` and `service wlgb stop` to start and stop the server.
The configuration file will be at `/etc/wlgb/config.json`. The configuration file will be at `/etc/wlgb/config.json`.
### Using ant ### ### Manually ###
Run `ant all` to build, test, and package it into a jar at `bin/writelatex-git-bridge.jar`. 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. Use `java -jar <path_to_jar> <path_to_config_file>` to run the server.
@ -25,13 +25,13 @@ Runtime Configuration
The configuration file is in `.json` format. There is an example at `bin/config.json`. The configuration file is in `.json` format. There is an example at `bin/config.json`.
{ {
"port": the port number (int), "port" (int): the port number,
"rootGitDirectory": the directory in which to store git repos and the db/atts (string), "rootGitDirectory" (string): the directory in which to store git repos and the db/atts,
"apiKey": currently does nothing (string), "apiKey" (string): currently does nothing,
"apiBaseUrl": base url for the snapshot api (string), "apiBaseUrl" (string): base url for the snapshot api,
"username": username for http basic auth (string, optional), "username" (string, optional): username for http basic auth,
"password": password for http basic auth (string, optional), "password" (string, optional): password for http basic auth,
"serviceName": current name of writeLaTeX in case it ever changes ;) (string) "serviceName" (string): current name of writeLaTeX in case it ever changes ;)
} }
You have to restart the server for configuration changes to take effect. You have to restart the server for configuration changes to take effect.