Documentation

James Moger

2013-07-14 044549d7c39780f19326ff1492aa818ad51a8d48

Documentation

 build.xml

@@ -683,11 +683,17 @@
                        <page name="upgrade WAR" src="upgrade_war.mkd" />

                    </menu>

                    <divider />

                    <menu name="Gitblit Express" pager="true" pagerPlacement="bottom" pagerLayout="justified">

                        <page name="setup Express" src="setup_express.mkd" />

                        <page name="upgrade Express" src="upgrade_express.mkd" />

                    </menu>

                    <divider />

                    <page name="administration" src="administration.mkd" />

                    <page name="authentication" src="setup_authentication.mkd" />

                    <page name="push hooks" src="setup_hooks.mkd" />

                    <page name="lucene indexing" src="setup_lucene.mkd" />

                    <page name="reverse proxies" src="setup_proxy.mkd" />

                    <page name="client app menus" src="setup_clientmenus.mkd" />

                    <divider />

                    <page name="Gitblit as a viewer" src="setup_viewer.mkd" />

                    <divider />

@@ -939,11 +945,17 @@
                            <page name="upgrade WAR" src="upgrade_war.mkd" />

                        </menu>

                        <divider />

                        <menu name="Gitblit Express" pager="true" pagerPlacement="bottom" pagerLayout="justified">

                            <page name="setup Express" src="setup_express.mkd" />

                            <page name="upgrade Express" src="upgrade_express.mkd" />

                        </menu>

                        <divider />

                        <page name="administration" src="administration.mkd" />

                        <page name="authentication" src="setup_authentication.mkd" />

                        <page name="push hooks" src="setup_hooks.mkd" />

                        <page name="lucene indexing" src="setup_lucene.mkd" />

                        <page name="reverse proxies" src="setup_proxy.mkd" />

                        <page name="client app menus" src="setup_clientmenus.mkd" />

                        <divider />

                        <page name="Gitblit as a viewer" src="setup_viewer.mkd" />

                        <divider />


 releases.moxie

@@ -25,7 +25,7 @@
          Thank you to <a href="http://syntevo.com">syntevo</a>, <a href="http://atlassian.com">Atlassian</a>, <a href="http://fournova.com">fournova</a>, and <a href="http://github.com">Github</a> for their permission and use of their artwork for the native app clone menus.

          ''

    note: ''

          If you have forked repositories and your are upgrading to ${project.version}, please DO NOT RELOCATE your repositories folder when running ${project.version} the first time.  Gitblit will update forked repository configs on the first execution and it is critical that ${git.repositoriesFolder} points to the same location used by 1.2.x.

          If you have forked repositories and your are upgrading to 1.3.0, please DO NOT RELOCATE your repositories folder when running ${project.version} the first time.  Gitblit will update forked repository configs on the first execution and it is critical that ${git.repositoriesFolder} points to the same location used by 1.2.x.

          ''

    security:

    - Raw servlet was insecure. If someone knew the exact repository name and path to a file, the raw blob could be retrieved bypassing security constraints. (issue 198)

@@ -107,6 +107,7 @@
     - Support --baseFolder parameter in Federation Client



    contributors:

    - James Moger

    - Bandarupalli Satyanarayana

    - Chad Horohoe

    - Christian Aistleitner

@@ -225,6 +226,7 @@
    - { name: fanout.connectionLimit, defaultValue: 0 }



    contributors:

    - James Moger

    - github/mystygage

    - github/ds5apn

    - github/kwoot

@@ -341,6 +343,7 @@
    - XZ for Java 1.0



    contributors:

    - James Moger

    - github/rafaelcavazin

    - github/mallowlabs

    - github/sauthieg

@@ -417,6 +420,7 @@
    - { name: git.defaultAuthorizationControl, defaultValue: NAMED }



    contributors:

    - James Moger

    - Steffen Gebert

}



@@ -486,6 +490,7 @@
    - Ivy 2.2.0



    contributors:

    - James Moger

    - Eduardo Guervos Narvaez

    - Lukasz Jader

    - github/mragab

@@ -505,6 +510,9 @@
    fixes:

    - Fixed bug where you could not remove all selections from a RepositoryModel list (permitted users, permitted teams, hook scripts, federation sets, etc) (issue 81)

    - Automatically set *java.awt.headless=true* for Gitblit GO



    contributors:

    - James Moger

}



#

@@ -525,6 +533,7 @@
    - Fixed EditRepositoryPage for IE8; missing save button (issue 80)



    contributors:

    - James Moger

    - github/jonnybbb

    - github/mohamedmansour

    - github/jcrygier

@@ -540,6 +549,9 @@


    fixes:

    - Lucene folder was stored in working copy instead of in .git folder



    contributors:

    - James Moger

}



#

@@ -607,6 +619,7 @@
    - Wicket 1.4.20



    contributors:

    - James Moger

    - github/lemval

    - github/zakki

    - github/plm

@@ -622,6 +635,9 @@


    fixes:

    - Fixed bug when upgrading from users.properties to users.conf (issue 41)



    contributors:

    - James Moger

}



#

@@ -635,6 +651,9 @@
    fixes:

    - Include missing icon resource for the manager (issue 40)

    - Fixed sendmail.groovy message content with incorrect tag/branch labels



    contributors:

    - James Moger

}



#

@@ -693,6 +712,9 @@
    - JGit 1.2.0

    - Groovy 1.8.5

    - Clippy



    contributors:

    - James Moger

}



#

@@ -747,6 +769,7 @@
    - Wicket 1.4.19



    contributors:

    - James Moger

    - github/dadalar

    - github/alyandon

    - github/trygvis

@@ -783,6 +806,9 @@
    - JGit 1.1.0

    - google-gson

    - javamail



    contributors:

    - James Moger

}



#

@@ -813,6 +839,9 @@
    dependencyChanges:

    - MarkdownPapers 1.1.0

    - Jetty 7.4.3



    contributors:

    - James Moger

}



#

@@ -827,6 +856,9 @@
    - 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



    contributors:

    - James Moger

}



#

@@ -837,6 +869,9 @@
    id: 0.5.0

    date: 2011-06-26

    text: initial release



    contributors:

    - James Moger

}



snapshot: &r17


 src/site/setup_clientmenus.mkd

New file
@@ -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---

 src/site/setup_express.mkd

New file
@@ -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)


 src/site/upgrade_express.mkd

New file
@@ -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