From 790c3829edafcb41d6eeb14301a23db22c559e96 Mon Sep 17 00:00:00 2001 From: James Moger Date: Fri, 1 Jul 2011 17:45:23 -0400 Subject: [PATCH] Documentation. Added upgrade info to site. Moved todos to GoogleCode. --- docs/00_index.mkd | 4 ++++ docs/01_features.mkd | 16 ---------------- docs/01_setup.mkd | 25 +++++++++++++++++++++++++ docs/site_header.html | 2 +- 4 files changed, 30 insertions(+), 17 deletions(-) diff --git a/docs/00_index.mkd b/docs/00_index.mkd index 4a922567..d6457938 100644 --- a/docs/00_index.mkd +++ b/docs/00_index.mkd @@ -23,6 +23,10 @@ Gitblit requires a Java 6 Runtime Environment (JRE) or a Java 6 Development Kit %VERSION% ([go](http://code.google.com/p/gitblit/downloads/detail?name=%GO%)|[war](http://code.google.com/p/gitblit/downloads/detail?name=%WAR%)) based on [%JGIT%][jgit]   *released %BUILDDATE%* +- clarified SSL certificate generation and configuration for both server-side and client-side +- added some more troubleshooting information to documentation +- replaced JavaService with Apache Commons Daemon + issues & binaries @ [Google Code][googlecode]
sources @ [Github][gitbltsrc] diff --git a/docs/01_features.mkd b/docs/01_features.mkd index cecef734..7c522a7c 100644 --- a/docs/01_features.mkd +++ b/docs/01_features.mkd @@ -48,20 +48,4 @@ - Gitblit may eat your data. Use at your own risk. - Gitblit may have security holes. Patches welcome. :) -## Todo List -- Code documentation -- Unit testing - -### Under Consideration -- Clone remote repository feature -- Blob page improvements - - view images - - view other binary files (pdf, doc, etc) -- Markdown editing feature -- Stronger Ticgit read-only integration - - activity/timeline - - query feature with paging support - - change history -- Ticgit write integration - [jgit]: http://eclipse.org/jgit "Eclipse JGit Site" \ No newline at end of file diff --git a/docs/01_setup.mkd b/docs/01_setup.mkd index a601e682..d595a992 100644 --- a/docs/01_setup.mkd +++ b/docs/01_setup.mkd @@ -87,6 +87,31 @@ Command-Line parameters override the values in `gitblit.properties` at runtime. **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 diff --git a/docs/site_header.html b/docs/site_header.html index 7b8f63d5..62635045 100644 --- a/docs/site_header.html +++ b/docs/site_header.html @@ -5,7 +5,7 @@ - + -- 2.39.5