Documentation.

James Moger

2012-01-11 444101836567ea091c26a389ce0f20633b61558e

Documentation.

 docs/00_index.mkd

@@ -32,6 +32,10 @@


You can browse a live demo [here](http://demo-gitblit.rhcloud.com) hosted on [RedHat's OpenShift][rhcloud] cloud service.



**NOTE:**  
The demo is a bit unstable due to a bug in JBossAS7/Tomcat when running in LOW_MEMORY mode which OpenShift mandates.  
RedHat engineers hope to have this issue resolved soon.



### GO: Single-Stack Solution



*Gitblit GO* is an integrated, single-stack solution based on Jetty.


 docs/01_setup.mkd

@@ -242,7 +242,7 @@


*SINCE 0.8.0*



The preferred hook mechanism is Groovy.  This mechanism only executes when pushing to Gitblit, not when pushing to some other Git tooling in your stack.

Gitblit uses Groovy for its push hook mechanism.  This mechanism only executes when pushing to Gitblit, not when pushing to some other Git tooling in your stack.



The Groovy hook mechanism allows for dynamic extension of Gitblit to execute custom tasks on receiving and processing push events.  The scripts run within the context of your Gitblit instance and therefore have access to Gitblit's internals at runtime.




 docs/04_releases.mkd

@@ -12,7 +12,7 @@
    **New:** *groovy.postReceiveScripts =*

- *sendmail.groovy* for optional email notifications on push.  

You must properly configure your SMTP server settings in `gitblit.properties` or `web.xml` to use *sendmail.groovy*.

- New global key for mailing lists.  This is used in conjunction with the *sendmail.groovy* hook script.  All repositories that use the *sendmail.groovy* script will include these addresses in the notification process.  
- New global key for mailing lists.  This is used in conjunction with the *sendmail.groovy* hook script.  All repositories that use the *sendmail.groovy* script will include these addresses in the notification process.  Please see the Setup page for more details about configuring sendmail.  
    **New:** *mail.mailingLists =*

- *com.gitblit.GitblitUserService*.  This is a wrapper object for the built-in user service implementations.  For those wanting to only implement custom authentication it is recommended to subclass GitblitUserService and override the appropriate methods.  Going forward, this will help insulate custom authentication from new IUserService API and/or changes in model classes.

- New default user service implementation: *com.gitblit.ConfigUserService* (`users.conf`)  

@@ -33,8 +33,7 @@
   **New:** *web.allowFlashCopyToClipboard = true*

- JavaScript-based 3-step (click, ctrl+c, enter) *copy to clipboard* of the primary repository url in the event that you do not want to use Flash on your installation

- Empty repositories now link to an *empty repository* page which gives some direction to the user for the next step in using Gitblit.  This page displays the primary push/clone url of the repository and gives sample syntax for the git command-line client. (issue 31)

- automatic *gh-pages* branch serving (Jekyll is not supported)  
Gitblit does not checkout your gh-pages branch to a temporary filesystem, all page and resource requests are live through the repository

- Repositories with a *gh-pages* branch will now have a *pages* link which will serve the content of this branch.  All resource requests are against the repository, Gitblit does not checkout/export this branch to a temporary filesystem.  Jekyll templating is not supported.

- Gitblit Express bundle to get started running Gitblit on RedHat's OpenShift cloud <span class="label warning">BETA</span>



#### changes