|
|
@@ -32,28 +32,46 @@ 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,
|
|
|
+ "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 */
|
|
|
+ "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
|
|
|
+ "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"
|
|
|
+ "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): you will never go below this many projects; if above low watermark, it should WARN,
|
|
|
- "lowGiB" (int32): the low watermark for swapping, i.e. try to 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): the repeat time in milliseconds that the swap job will check the watermark. 3600000 is 1 hour.
|
|
|
+ "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
|
|
|
}
|
|
|
}
|
|
|
|
Winston Li