From 75f4903ffbf7dba93900d1fe05de12563f36439b Mon Sep 17 00:00:00 2001 From: dariko Date: Mon, 23 Jan 2017 12:48:57 +0100 Subject: [PATCH] --temp_dir parameter documentation --- README.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/README.md b/README.md index 0cdb89414..ed89d3838 100644 --- a/README.md +++ b/README.md @@ -34,6 +34,13 @@ You can specify following options: - `--gitbucket.home=[DATA_DIR]` - `--temp_dir=[TEMP_DIR]` +`TEMP_DIR` is used as the [temporary directory for the jetty application context](https://www.eclipse.org/jetty/documentation/9.3.x/ref-temporary-directories.html). +This is the directory into which the gitbucket.war file is unpacked, the source +files are compiled, etc. +If given this parameter **must** match the path of an existing directory +or the application will quit reporting an error; if not given the path used +will be a `tmp` directory inside the gitbucket home. + You can also deploy gitbucket.war to a servlet container which supports Servlet 3.0 (like Jetty, Tomcat, JBoss, etc) For more information about installation on Mac or Windows Server (with IIS), or configuration of Apache or Nginx and also integration with other tools or services such as Jenkins or Slack, see [Wiki](https://github.com/gitbucket/gitbucket/wiki).