diff options
| author | James Moger <james.moger@gitblit.com> | 2013-07-03 21:35:02 -0400 |
|---|---|---|
| committer | James Moger <james.moger@gitblit.com> | 2013-07-03 21:35:02 -0400 |
| commit | 8c99a7929b48b4c4a33c80d0b6646f6e6bb563b5 (patch) | |
| tree | f0cce1420e9196339c612c2994d393455a23d365 /src/site/setup_war.mkd | |
| parent | 5c5b7a8659851abc6ce1654414ceeef2e7f9c803 (diff) | |
| download | gitblit-8c99a7929b48b4c4a33c80d0b6646f6e6bb563b5.tar.gz gitblit-8c99a7929b48b4c4a33c80d0b6646f6e6bb563b5.zip | |
Documentation
Diffstat (limited to 'src/site/setup_war.mkd')
| -rw-r--r-- | src/site/setup_war.mkd | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/site/setup_war.mkd b/src/site/setup_war.mkd new file mode 100644 index 00000000..18a0799c --- /dev/null +++ b/src/site/setup_war.mkd @@ -0,0 +1,20 @@ +## Gitblit WAR Installation & Setup
+
+1. Download Gitblit WAR [${project.releaseVersion}](%GCURL%gitblit-${project.releaseVersion}.war) to the webapps folder of your servlet container.
+2. You may have to manually extract the WAR (zip file) to a folder within your webapps folder.
+3. By default, the Gitblit webapp is configured through `WEB-INF/data/gitblit.properties`.<br/>
+Open `WEB-INF/data/gitblit.properties` in your favorite text editor and make sure to review and set:
+ - <context-parameter> *git.packedGitLimit* (set larger than the size of your largest repository)
+ - <context-parameter> *git.streamFileThreshold* (set larger than the size of your largest committed file)
+4. You may have to restart your servlet container.
+5. Open your browser to <http://localhost/gitblit> or whatever the url should be.
+6. Enter the default administrator credentials: **admin / admin** and click the *Login* button
+ **NOTE:** Make sure to change the administrator username and/or password!!
+
+### WAR Data Location
+By default, Gitblit WAR stores all data (users, settings, repositories, etc) in `${contextFolder}/WEB-INF/data`. This is fine for a quick setup, but there are many reasons why you don't want to keep your data within the webapps folder of your servlet container. You may specify an external location for your data by editing `WEB-INF/web.xml` and manipulating the *baseFolder* context parameter. Choose a location that is writeable by your servlet container. Your servlet container may be smart enough to recognize the change and to restart Gitblit.
+
+On the next restart of Gitblit, Gitblit will copy the contents of the `WEB-INF/data` folder to your specified *baseFolder* **IF** the file `${baseFolder}/gitblit.properties` does not already exist. This allows you to get going with minimal fuss.
+
+Specifying an alternate *baseFolder* also allows for simpler upgrades in the future.
+
|