Documentation.

James Moger

2012-01-06 e927f4ed9c81455e156ffc88bb193df2bf2c4a69

Documentation.

 docs/01_setup.mkd

@@ -284,10 +284,11 @@
### Enabling Push Notifications



In order to send email notifications on a push to Gitblit, this script must be specified somewhere in the *post-receive* script chain.  

You may specify *sendmail* in one of two places:

You may specify *sendmail* in one of three places:



1. *groovy.postReceiveScripts* in `gitblit.properties` or `web.xml`, globally applied to all repositories

2. post-receive scripts of a Repository definition

2. post-receive scripts of a Team definition

3. post-receive scripts of a Repository definition



### Destination Addresses




 docs/04_releases.mkd

@@ -3,39 +3,55 @@
### Current Release

**%VERSION%** ([go](http://code.google.com/p/gitblit/downloads/detail?name=%GO%) | [war](http://code.google.com/p/gitblit/downloads/detail?name=%WAR%) | [express](http://code.google.com/p/gitblit/downloads/detail?name=%EXPRESS%) | [fedclient](http://code.google.com/p/gitblit/downloads/detail?name=%FEDCLIENT%) | [manager](http://code.google.com/p/gitblit/downloads/detail?name=%MANAGER%) | [api](http://code.google.com/p/gitblit/downloads/detail?name=%API%)) based on [%JGIT%][jgit]   *released %BUILDDATE%*



- updated: Gitblit GO is now monolithic like the WAR build. (issue 30)  
This change helps adoption of GO in environments without an internet connection or with a restricted connection.

- added: Groovy 1.8.4 and a push hook script mechanism.  Hook scripts can be set per-repository, per-team, or globally for all repositories.  
Unfortunately this adds another 6 MB to the 8MB Gitblit package, but it allows for a *very* powerful, flexible, platform-independent hook script mechanism.  
#### additions



- Platform-independent, Groovy push hook script mechanism.  
Hook scripts can be set per-repository, per-team, or globally for all repositories.  
    **New:** *groovy.scriptsFolder = groovy*  

    **New:** *groovy.preReceiveScripts =*  

    **New:** *groovy.postReceiveScripts =*

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

- added: New key for mailing lists.  This is used in conjunction with the *sendmail.groovy* hook script.  
- *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:** *mail.mailingLists =*

- added: 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 insulate customized behavior from new IUserService API and changes in model classes.

- added: new default user service implementation: com.gitblit.ConfigUserService (users.conf)  
This user service implementation allows for serialization and deserialization of more sophisticated Gitblit User objects and will open the door for more advanced Gitblit features. For upgrading installations, a `users.conf` file will automatically be created for you from your existing `users.properties` file on your first launch of Gitblit.  You will have to manually set *realm.userService=users.conf* to switch to the new user service.  
- *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`)  
This user service implementation allows for serialization and deserialization of more sophisticated Gitblit User objects without requiring the encoding trickery now present in FileUserService (users.properties).  This will open the door for more advanced Gitblit features.  
For those upgrading from an earlier Gitblit version, a `users.conf` file will automatically be created for you from your existing `users.properties` file on your first launch of Gitblit <u>however</u> you will have to manually set *realm.userService=users.conf* to switch to the new user service.  
The original `users.properties` file and it's corresponding implementation are **deprecated**.  

    **New:** *realm.userService = users.conf*

- added: Teams for specifying user-repository access in bulk.  Teams may also specify mailing lists addresses and pre- & post- receive hook scripts.

- added: Gitblit Express bundle to get started running Gitblit on RedHat's OpenShift cloud

- added: optional Gravatar integration  
- Teams for specifying user-repository access in bulk.  Teams may also specify mailing lists addresses and pre- & post- receive hook scripts.

- Gravatar integration  
    **New:** *web.allowGravatar = true*   

- added: aggregated repository activity page.  this is a timeline of commit activity over the last N days for one or more repositories.  
- Activity page for aggregated repository activity.  This is a timeline of commit activity over the last N days for one or more repositories.  
   **New:** *web.activityDuration = 14*  

   **New:** *web.timeFormat = HH:mm*  

   **New:** *web.datestampLongFormat = EEEE, MMMM d, yyyy*  

- added: filters menu to repositories page and activity page.  You can filter by federation set, team, and simple custom regular expressions (issue 27)  
- *Filters* menu for the Repositories page and Activity page.  You can filter by federation set, team, and simple custom regular expressions.  Custom expressions can be stored in `gitblit.properties` or `web.xml` or directly defined in your url (issue 27)  
   **New:** *web.customFilters=*

- fixed: several a bugs in FileUserService related to cleaning up old repository permissions on a rename or delete

- fixed: renaming a repository into a new subfolder failed (issue 33)

- added: optional flash-based 1-step *copy to clipboard* of the primary repository url

- added: javascript-based 3-step (click, ctrl+c, enter) *copy to clipboard* of the primary repository url  
- Flash-based 1-step *copy to clipboard* of the primary repository url based on Clippy  
   **New:** *web.allowFlashCopyToClipboard = true*

- improved: empty repositories now link to a new *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)

- improved: unit testing framework has been migrated to JUnit4 syntax and the test suite has been redesigned to run all unit tests, including rpc, federation, and git push/clone tests

- updated: JGit 1.2.0

- 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)

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



#### changes



- Dropped display of trailing .git from repository names

- Gitblit GO is now monolithic like the WAR build. (issue 30)  
This change helps adoption of GO in environments without an internet connection or with a restricted connection.

- Unit testing framework has been migrated to JUnit4 syntax and the test suite has been redesigned to run all unit tests, including rpc, federation, and git push/clone tests



#### fixes



- Several a bugs in FileUserService related to cleaning up old repository permissions on a rename or delete

- Renaming a repository into a new subfolder failed (issue 33)



#### dependency changes



- updated to JGit 1.2.0

- added Groovy 1.8.4 
- added Clippy (bundled)



### Older Releases