overleaf/services/git-bridge
Michael Walker ced34d91d4 Delete temporary files created by Tar on close
The SwapJob creates temporary files indirectly through Tar.bz2.zip.
These files are deleted with File.deleteOnExit, but there is no other
deletion mechanism.  This means that temporary files will build up as
the git bridge runs, only being deleted when the JVM finally
terminates.

Instead, we can delete these temporary files as soon as they are no
longer needed.  The files are wrapped in a FileInputStream and not
directly exposed, so we can simply delete the underlying file when the
stream is closed, as then the file is inaccessible.
2017-07-14 12:08:50 +01:00
..
conf Update example conf and README 2016-09-06 09:11:32 +01:00
lib Add New Relic stuff 2016-09-06 09:13:34 +01:00
src Delete temporary files created by Tar on close 2017-07-14 12:08:50 +01:00
.gitignore Ignore .idea and *.iml again. 2016-09-06 09:11:32 +01:00
LICENSE Initial commit 2014-11-01 16:02:22 +00:00
newrelic.yml Add New Relic stuff 2016-09-06 09:13:34 +01:00
pom.xml Remove sleep and reset jgit version 2017-02-17 15:57:09 +00:00
README.md Update README about running tests 2016-09-12 14:27:00 +01:00

writelatex-git-bridge

Required

  • maven (for building, running tests and packaging)
  • jdk-8 (for compiling and running)

Commands

To be run from the base directory:

Build jar: mvn package

Run tests: mvn test

Clean: mvn clean

Installation

Install dependencies:

sudo apt-get update
sudo apt-get install -y maven
sudo apt-get install -y openjdk-8-jdk
sudo update-alternatives --set java /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/java
sudo update-alternatives --set javac /usr/lib/jvm/java-8-openjdk-amd64/jre/bin/javac

Create a config file according to the format below.

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.

{
    "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,
    "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
    },
    "swapStore" (object, optional): { the place to swap projects to.
                                      if null, type defaults to
                                      "noop"
        "type" (string): "s3", "memory", "noop" (not recommended),
        "awsAccessKey" (string, optional): only for s3,
        "awsSecret" (string, optional): only for s3,
        "s3BucketName" (string, optional): only for s3
    },
    "swapJob" (object, optional): { configure the project
                                    swapping job.
                                    if null, defaults to no-op
        "minProjects" (int64): lower bound on number of projects
                               present. The swap job will never go
                               below this, regardless of what the
                               watermark shows. Regardless, if
                               minProjects prevents an eviction,
                               the swap job will WARN,
        "lowGiB" (int32): the low watermark for swapping,
                          i.e. swap until disk usage is below this,
        "highGiB" (int32): the high watermark for swapping,
                           i.e. start swapping when
                           disk usage becomes this,
        "intervalMillis" (int64): amount of time in between running
                                  swap job and checking watermarks.
                                  3600000 is 1 hour
    }
}

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