From c892c7d705af40c896e05a0b397c8032173d2644 Mon Sep 17 00:00:00 2001 From: James Moger <james.moger@gitblit.com> Date: Thu, 07 Jul 2011 18:04:14 -0400 Subject: [PATCH] Documentation. Noted commit hooks not supported. --- docs/01_setup.mkd | 35 +++++++++++++++++++++++++++++++++++ 1 files changed, 35 insertions(+), 0 deletions(-) diff --git a/docs/01_setup.mkd b/docs/01_setup.mkd index eca0be2..d595a99 100644 --- a/docs/01_setup.mkd +++ b/docs/01_setup.mkd @@ -62,6 +62,16 @@ **NOTE:**<br/> If you change the name of the service from *gitblit* you must also change the name of `gitblitw.exe` to match the new service name otherwise the connection between the service and the utility is lost, at least to double-click execution. +#### VM Considerations +By default, the service installation script configures your Windows service to use your default JVM. This setup usually defaults to a client VM.<br/> +If you have installed a JDK, you might consider using the `gitblitw.exe` utility to manually specify the *server* VM. + +1. Execute `gitblitw.exe` +2. On the *Java* tab uncheck *Use default*. +3. Manually navigate your filesystem and specify the server VM with the `...` button<br/><pre> + Java Virtual Machine: + C:\Program Files\Java\jre6\bin\server\jvm.dll</pre> + #### Command-Line Parameters Command-Line parameters override the values in `gitblit.properties` at runtime. @@ -77,6 +87,31 @@ **Example** java -jar gitblit.jar --userService c:\myrealm.properties --storePassword something + +## Upgrading Gitblit +Generally, upgrading is easy. + +Since Gitblit does not use a database the only files you have to worry about are your configuration file (`gitblit.properties` or `web.xml`) and possibly your `users.properties` file. + +Any important changes to the setting keys or default values will always be mentioned in the [release log](releases.html). + +### Upgrading Gitblit WAR +1. Backup your `web.xml` file +2. Delete currently deployed gitblit WAR +3. Deploy new WAR and overwrite the `web.xml` file with your backup +4. Review and optionally apply any new settings as indicated in the [release log](releases.html). + +### Upgrading Gitblit GO + +1. Backup your `gitblit.properties` file +2. Backup your `users.properties` file *(if it is located in the Gitblit GO folder)* +3. Unzip Gitblit GO to a new folder +4. Overwrite the `gitblit.properties` file with your backup +5. Overwrite the `users.properties` file with your backup *(if it was located in the Gitblit GO folder)* +6. Review and optionally apply any new settings as indicated in the [release log](releases.html). + +#### Upgrading Windows Service +You may need to delete your old service definition and install a new one depending on what has changed in the release. ## Gitblit Configuration -- Gitblit v1.9.1