Documentation

3 files changed, 118 insertions, 0 deletions

diff --git a/src/site/setup_clientmenus.mkd b/src/site/setup_clientmenus.mkd
new file mode 100644
index 00000000..c40c3b29
--- /dev/null
+++ b/src/site/setup_clientmenus.mkd
@@ -0,0 +1,48 @@
+## Client App Menus

+

+*SINCE 1.3.0*

+

+Gitblit supports defining menus for native platform git client clone urls.  By default, Gitblit ships with client definitions for Git, SmartGit/Hg, SourceTree, Tower, and Github for Mac & Windows.  Gitblit uses the browser's user-agent to help filter the list of available clients in addition to served transports and user access permissions.

+

+You can define new client integrations and deactivate/remove the default integrations by creating a file *$(baseFolder}/clientapps.json*.

+

+### Example definitions

+---JSON---

+[

+    {

+        "name": "SmartGit/Hg",

+        "title": "syntevo SmartGit/Hg\u2122",

+        "description": "a Git client for Windows, Mac, & Linux",

+        "legal": "\u00a9 2013 syntevo GmbH. All rights reserved.",

+        "cloneUrl": "smartgit://cloneRepo/${repoUrl}",

+        "productUrl": "http://www.syntevo.com/smartgithg",

+        "platforms": [ "windows", "macintosh", "linux" ],

+        "icon": "smartgithg_32x32.png",

+        "isActive": true

+    },

+    {

+        "name": "GitHub",

+        "title": "GitHub\u2122 for Windows",

+        "description": "a free Git client for Windows",

+        "legal": "\u00a9 2013 GitHub. All rights reserved.",

+        "cloneUrl": "github-windows://openRepo/${repoUrl}",

+        "productUrl": "http://windows.github.com",

+        "transports": [ "http", "https" ],

+        "platforms": [ "windows" ],

+        "icon": "github_32x32.png",

+        "isActive": true

+    },

+    {

+        "name": "SparkleShare",

+        "title": "SparkleShare\u2122",

+        "description": "an open source collaboration and sharing tool",

+        "legal": "released under the GPLv3 open source license",

+        "cloneUrl": "sparkleshare://addProject/${baseUrl}/sparkleshare/${repoUrl}.xml",

+        "productUrl": "http://sparkleshare.org",

+        "platforms": [ "windows", "macintosh", "linux" ],

+        "icon": "sparkleshare_32x32.png",

+        "minimumPermission" : "RW+",

+        "isActive": false

+    }

+]

+---JSON---
\ No newline at end of file
diff --git a/src/site/setup_express.mkd b/src/site/setup_express.mkd
new file mode 100644
index 00000000..6753542c
--- /dev/null
+++ b/src/site/setup_express.mkd
@@ -0,0 +1,56 @@
+## Gitblit on RedHat's OpenShift Cloud Service

+

+The Gitblit Express distribution can be copied to the root of your RedHat OpenShift

+application repository.  Gitblit Express is an exploded WAR file with all appropriate

+dependencies bundled.

+

+You should delete the `pom.xml` file and the `src` folder from your application repository

+as Gitblit Express is not a source distribution to be built with Maven on OpenShift.

+

+Gitblit automatically adjusts itself to running on OpenShift.  Repositories, users,

+federation proposals, setting overrides, and Groovy push scripts are stored in *OPENSHIFT_DATA_DIR*.

+

+It is recommended to enable all RPC settings in the `web.xml` file to allow remote

+administration and, more importantly, configuration of your Gitblit Express

+installation using the Gitblit Manager.

+

+It is also recommended to set *web.forwardSlashCharacter* to ! because OpenShift

+runs on JBoss/Tomcat behind a proxy, neither of which are friendly to embedded

+forward-slashes.

+

+Please do not change the following settings unless you know exactly what you are

+doing:

+

+- *git.repositoriesFolder*

+- *groovy.scriptsFolder*

+- *federation.proposalsFolder*

+- *realm.userService* (for standard users.conf)

+ 

+Additionally, it is recommended to force your Gitblit installation to cleanup up

+older versions on your OpenShift filesystem to maximize available space for your

+repositories.

+

+Append the following command to your ./openshift/action_hooks/build file:

+

+    rm -fr $OPENSHIFT_APP_DIR/jbossas-7.0/standalone/tmp/vfs/*

+

+Lastly, you may want to play with the heap and permgen settings of your Gitblit

+instance because the default heap for the JVM is 95 MB, which may be a little

+tight.

+

+To do that you will have to login to your account via ssh:

+

+    ssh hashcode@app-domain.rhcloud.com

+

+and then you will have to manipulate the -Xmx and -XX:MaxPermSize values.

+

+    vi $OPENSHIFT_APP_DIR/jbossas-7.0/bin/standalone.conf

+    ctl_app restart

+

+OpenShift currently allows 300MB of memory per application which includes ssh access, JVM, etc.

+The Gitblit demo hosted on OpenShift Express operates with -Xmx160m and -XX:MaxPermSize=90m.

+

+For more detailed instructions on how to setup and deploy an OpenShift application

+please see this excellent turorial:

+

+[Deploying to OpenShift](https://github.com/opensas/play-demo/wiki/Step-12.5---deploy-to-openshift)

diff --git a/src/site/upgrade_express.mkd b/src/site/upgrade_express.mkd
new file mode 100644
index 00000000..103cfc9a
--- /dev/null
+++ b/src/site/upgrade_express.mkd
@@ -0,0 +1,14 @@
+## Upgrading Gitblit Express

+

+1. Make a  backup copy of */deployments/ROOT.war/WEB-INF/web.xml*

+2. Delete your */deployments/ROOT.war* and then copy the new */deployments/ROOT.war* from the archive.

+3. Diff your backup copy of web.xml with the pristine one you copied as part of */deployments/ROOT.war* and apply any necessary changes.

+

+These steps are necessary to ensure that you end up using the specified libraries and resources for the new version.  Otherwise you could end up with a hybrid filesystem that would make it difficult to troubleshoot.  It is important to note that the web.xml file contains both your default settings AND application configuration.  Not updating the web.xml is just a likely to create problems as making a hybrid filesystem.

+

+### 1.3.0 web.xml

+

+- Added LogoServlet

+- Added SparkleShareInviteServlet

+- Added EnforceAuthenticationFilter

+- Moved GitServlet
\ No newline at end of file