overleaf/services/git-bridge/README.md

47 lines
1.7 KiB
Markdown
Raw Normal View History

2014-11-01 12:02:46 -04:00
writelatex-git-bridge
=====================
2014-11-03 08:19:49 -05:00
2014-12-05 20:50:35 -05:00
Required
--------
2015-01-09 02:21:13 -05:00
* `maven` (for building)
2014-12-05 20:56:07 -05:00
* `jdk-7` (for compiling and running)
2014-11-03 11:26:51 -05:00
2014-12-05 21:01:47 -05:00
Installation
------------
2014-12-05 20:50:35 -05:00
### Ubuntu ###
2015-01-10 07:55:57 -05:00
Run `./install` to get dependencies, build, test, package, and make it a service.
2014-11-03 11:26:51 -05:00
2015-01-09 02:21:13 -05:00
Use `sudo service wlgb start` and `sudo service wlgb stop` to start and stop the server.
2014-11-03 11:26:51 -05:00
2014-12-05 20:50:35 -05:00
The configuration file will be at `/etc/wlgb/config.json`.
2014-12-05 21:03:43 -05:00
2015-01-10 07:55:57 -05:00
Run `./reinstall` to test, package and install the current version if `./install` has already been run.
Run `./uninstall` to undo what `./install` did.
2014-12-05 21:01:47 -05:00
### Manually ###
2015-01-09 02:21:13 -05:00
Run `mvn package` to build, test, and package it into a jar at `target/writelatex-git-bridge-1.0-SNAPSHOT-jar-with-dependencies.jar`.
2014-11-03 11:26:51 -05:00
2014-12-05 20:56:07 -05:00
Use `java -jar <path_to_jar> <path_to_config_file>` to run the server.
2014-12-05 20:50:35 -05:00
Runtime Configuration
---------------------
The configuration file is in `.json` format. There is an example at `bin/config.json`.
{
2014-12-05 21:01:47 -05:00
"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
2015-10-25 09:58:40 -04:00
"oauth2" (object): { /* null or missing if oauth2 shouldn't be used */
"oauth2ClientID" (string): oauth2 client ID
"oauth2ClientSecret" (string): oauth2 client secret
"oauth2Server" (string): oauth2 server, with protocol and without trailing slash
}
2014-12-05 20:50:35 -05:00
}
You have to restart the server for configuration changes to take effect.