Documentation

James Moger

2013-06-19 724da52635fbcc7c80cd0b7932f8b0d1cff6cb73

Documentation

 build.xml

@@ -298,6 +298,7 @@
            <!-- Manually include alternative User Services -->

            <class name="com.gitblit.LdapUserService" />

            <class name="com.gitblit.RedmineUserService" />

            <class name="com.gitblit.SalesforceUserService" />

        </mx:genjar>



        <!-- Build the WAR file -->

@@ -412,6 +413,7 @@
            <!-- Manually include alternative User Services -->

            <class name="com.gitblit.LdapUserService" />

            <class name="com.gitblit.RedmineUserService" />

            <class name="com.gitblit.SalesforceUserService" />

        </mx:genjar>



        <!-- Build Express Zip file -->

@@ -701,7 +703,8 @@
                </menu>

                

                <menu name="links">

                    <link name="Demo" src="https://demo-gitblit.rhcloud.com" />

                    <link name="Gitblit Demo (RELEASE)" src="https://demo-gitblit.rhcloud.com" />

                    <link name="Gitblit Next (SNAPSHOT)" src="https://next-gitblit.rhcloud.com" />

                    <divider />

                    <link name="Github" src="${project.scmUrl}" />

                    <link name="Issues" src="${project.issuesUrl}" />

@@ -917,7 +920,8 @@
                        <page name="older releases" src="releasehistory.mkd" />

                    </menu>

                    <menu name="links">

                        <link name="Demo" src="https://demo-gitblit.rhcloud.com" />

                        <link name="Gitblit Demo (RELEASE)" src="https://demo-gitblit.rhcloud.com" />

                        <link name="Gitbilt Next (SNAPSHOT)" src="https://next-gitblit.rhcloud.com" />

                        <divider />

                        <link name="Github" src="${project.scmUrl}" />

                        <link name="Issues" src="${project.issuesUrl}" />


 releases.moxie

@@ -51,10 +51,10 @@
     - Added simple star/unstar function to flag or bookmark interesting repositories

     - Added Dashboard page which shows a news feed for starred repositories and offers a filterable list of repositories you care about

     - Added a ui for the push log introduced in 1.2.1 (issue-177)

     - Added client application menus for Git, SourceTree, Tower, GitHub for Windows, GitHub for Mac, and SparkleShare

     - Added client application menus for Git, SmartGit/Hg, SourceTree, Tower, GitHub for Windows, GitHub for Mac, and SparkleShare

     - Added GO http/https connector thread pool size setting

     - Added a server setting to force a particular translation/Locale for all sessions

     - Added smart Git Daemon serving.  If enabled, git:// access will be offered for any repository which permits anonymous access.  If the repository permits anonymous cloning, anonymous git:// clone will be permitted while anonmymous git:// pushes will be rejected.
     - Added smart Git Daemon serving.  If enabled, git:// access will be offered for any repository which permits anonymous access.  If the repository permits anonymous cloning, anonymous git:// clone will be permitted while anonmymous git:// pushes will be rejected.

     - Option to automatically tag branch tips on each push with an incremental revision number

     - Implemented multiple repository owners

     - Optional periodic LDAP user and team pre-fetching & synchronization

@@ -99,24 +99,25 @@
    - Thomas Pummer

    - William Whittle

    - Yukihiko Sawanobori

    - github/akquinet

    - github/dapengme

        - github/akquinet

        - github/dapengme

    

    dependencyChanges:

    - JGit 3.0.0-SNAPSHOT

    - Iconic font

    - AngularJS 1.0.7

        - FreeMarker 2.3.19

    

    settings:

    - { name: 'git.daemonBindInterface', defaultValue: 'localhost' }

    - { name: 'git.daemonPort', defaultValue: 0 }

    - { name: 'git.defaultIncrementalPushTagPrefix', defaultValue: 'r' }

    - { name: 'mail.smtps', defaultValue: false }

        - { name: 'git.defaultIncrementalPushTagPrefix', defaultValue: 'r' }

    - { name: 'mail.smtps', defaultValue: 'false' }

    - { name: 'realm.container.autoCreateAccounts', defaultValue: 'false' }

    - { name: 'realm.salesforce.backingUserService', defaultValue: 'users.conf' }

    - { name: 'realm.salesforce.orgId', defaultValue: 0 }

    - { name: 'web.activityDurationChoices', defaultValue: '7 14 28 60 90 180' }

    - { name: 'web.allowAppCloneLinks', defaultValue: true }

    - { name: 'web.allowAppCloneLinks', defaultValue: 'true' }

    - { name: 'web.forceDefaultLocale', defaultValue: ' ' }

    - { name: 'web.metricAuthorExclusions', defaultValue: ' ' }

    - { name: 'web.overviewPushCount', defaultValue: 5 }


 src/site/features.mkd

@@ -1,6 +1,7 @@
## Standard Features (GO/WAR)

- JGit http/https SmartHTTP servlet

- JGit git protocol daemon

- Menu driven native platform clone links for all popular Git clients

- Browser and git client authentication

- Four *per-repository* access restriction configurations with a Read-Only control flag

    - ![anonymous](blank.png) *Anonymous View, Clone & Push*

@@ -34,10 +35,11 @@
- Administrators and Repository Owners may set the default branch through the web UI or RPC interface

- LDAP authentication and optional LDAP-controlled Team memberships

- Redmine authentication

- Salesforce.com authentication

- Gravatar integration

- Git-notes display support

- Submodule support

- Push log based on a hidden, orphan branch refs/gitblit/pushes

- User-tracked reflog for pushes, tags, etc.

- Fanout PubSub notifications service for self-hosted [Sparkleshare](http://sparkleshare.org) use

- gh-pages display support (Jekyll is not supported)

- Branch metrics (uses Google Charts)

@@ -53,16 +55,16 @@
- Single text file for users configuration

- Optional utility pages

    - ![docs](book_16x16.png) Docs page which enumerates all Markdown files within a repository

    - ![tickets](bug_16x16.png) **readonly** Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*

    - ![tickets](bug_16x16.png) **readonly and deprecated** Ticgit ticket pages *(based on last MIT release bf57b032 2009-01-27)*

- Translations

    - English

    - Japanese

    - Spanish

    - Polish

    - Korean

    - Brazilian Portuguese

    - Dutch

    - Chinese (zh_CN)

    - Brazilian Portuguese

    - Dutch

    - Chinese (zh_CN)



## Gitblit GO Features

- Out-of-the-box integrated stack requiring minimal configuration


 src/site/roadmap.mkd

@@ -8,7 +8,6 @@
* Eclipse: create plugin to enumerate repositories and delegate cloning to EGit

* Manager: support federation RPCs

* Manager: redesign ref indicators in log, search, and activity views to support multiple local branches, remote branches, and tags

* Gitblit: Serve repositories on root URL rather than /git (investigate JGit 1.2 GitFilter)



### TODO (medium priority)



@@ -21,9 +20,7 @@


### IDEAS



* Gitblit: Pull requests

* Gitblit: Watch/Star like github with personalized activity feed

* Gitblit: Push database or orphan branch

* Gitblit: GitHub-style Pull Requests or Gerrit-style Patchsets

* Gitblit: Re-use the EGit branch visualization table cell renderer as some sort of servlet

* Gitblit: diff should highlight inserted/removed fragment compared to original line

* Gitblit: respect Gerrit branch permissions


 src/site/setup.mkd

@@ -49,7 +49,7 @@
### Creating your own Self-Signed SSL Certificate

Gitblit GO (and Gitblit Certificate Authority) automatically generates a Certificate Authority (CA) certificate and an ssl certificate signed by this CA certificate that is bound to *localhost*.



Remote Eclipse/EGit/JGit clients (<= 2.2.0) will fail to communicate using this certificate because JGit always verifies the hostname of the certificate, regardless of the *http.sslVerify=false* client-side setting.

Remote Eclipse/EGit/JGit clients (< 3.0) will fail to communicate using this certificate because JGit always verifies the hostname of the certificate, regardless of the *http.sslVerify=false* client-side setting.



The EGit failure message is something like:



@@ -365,7 +365,7 @@
    2. Else if a team has an explicit permission, use that

    3. Else check for the first regex match in team permissions



#### No-So-Discrete Permissions (Gitblit <= v1.1.0)

#### No-So-Discrete Permissions (Gitblit &lt;= v1.1.0)



Prior to v1.2.0, Gitblit has two main access permission groupings:  



@@ -741,7 +741,7 @@
**NOTE:**  

The default self-signed certificate generated by Gitlbit GO is bound to *localhost*.  

If you are using Eclipse/EGit/JGit clients, you will have to generate your own certificate that specifies the exact hostname used in your clone/push url.  

You must do this because Eclipse/EGit/JGit (<= 2.3.1) always verifies certificate hostnames, regardless of the *http.sslVerify=false* client-side setting. 
You must do this because Eclipse/EGit/JGit (< 3.0) always verifies certificate hostnames, regardless of the *http.sslVerify=false* client-side setting. 
 

- **Eclipse/EGit/JGit**

    1. Window->Preferences->Team->Git->Configuration