]> source.dussan.org Git - gitblit.git/commitdiff
Updated Express documentation
authorJames Moger <james.moger@gitblit.com>
Fri, 6 Jan 2012 22:21:13 +0000 (17:21 -0500)
committerJames Moger <james.moger@gitblit.com>
Fri, 6 Jan 2012 22:21:13 +0000 (17:21 -0500)
distrib/openshift.mkd

index 5d144bd66d8bbd0388f99d170deaa0dc18b2a6d9..63b1b0076fdef409de82ac6917ef4f95b0a531c1 100644 (file)
@@ -5,21 +5,26 @@ application repository.  Gitblit Express is an exploded WAR file with all approp
 dependencies bundled.\r
 \r
 You should delete the `pom.xml` file and the `src` folder from your application repository\r
-as this Gitblit Express is not a source distribution to be built with Maven on OpenShift.\r
+as Gitblit Express is not a source distribution to be built with Maven on OpenShift.\r
 \r
 Gitblit automatically adjusts itself to running on OpenShift.  Repositories, users,\r
-federation proposals, and setting overrides are stored in *OPENSHIFT_DATA_DIR*.\r
+federation proposals, setting overrides, and Groovy push scripts are stored in *OPENSHIFT_DATA_DIR*.\r
 \r
 It is recommended to enable all RPC settings in the `web.xml` file to allow remote\r
 administration and, more importantly, configuration of your Gitblit Express\r
 installation using the Gitblit Manager.\r
 \r
+It is also recommended to set *web.forwardSlashCharacter* to ! because OpenShift\r
+runs on JBoss/Tomcat behind a proxy, neither of which are friendly to embedded\r
+forward-slashes.\r
+\r
 Please do not change the following settings unless you know exactly what you are\r
 doing:\r
 \r
 - *git.repositoriesFolder*\r
+- *groovy.scriptsFolder*\r
 - *federation.proposalsFolder*\r
-- *realm.userService* (for standard users.properties)\r
+- *realm.userService* (for standard users.conf)\r
  \r
 Additionally, it is recommended to force your Gitblit installation to cleanup up\r
 older versions on your OpenShift filesystem to maximize available space for your\r
@@ -29,6 +34,22 @@ Append the following command to your ./openshift/action_hooks/build file:
 \r
     rm -fr $OPENSHIFT_APP_DIR/jbossas-7.0/standalone/tmp/vfs/*\r
 \r
+Lastly, you may want to play with the heap and permgen settings of your Gitblit\r
+instance because the default heap for the JVM is 95 MB, which may be a little\r
+tight.\r
+\r
+To do that you will have to login to your account via ssh:\r
+\r
+    ssh hashcode@app-domain.rhcloud.com\r
+\r
+and then you will have to manipulate the -Xmx and -XX:MaxPermSize values.\r
+\r
+    vi $OPENSHIFT_APP_DIR/jbossas-7.0/bin/standalone.conf\r
+    ctl_app restart\r
+\r
+OpenShift currently allows 300MB of memory per application which includes ssh access, JVM, etc.\r
+The Gitblit demo hosted on OpenShift Express operates with -Xmx160m and -XX:MaxPermSize=90m.\r
+\r
 For more detailed instructions on how to setup and deploy an OpenShift application\r
 please see this excellent turorial:\r
 \r