Documentation.

James Moger

2011-09-27 ea936aa63d7a756ca7d0284f76b830656d1e8918

 docs/01_setup.mkd

@@ -20,9 +20,9 @@
Open `gitblit.properties` in your favorite text editor and make sure to review and set:

    - *git.repositoryFolder* (path may be relative or absolute)

    - *server.tempFolder* (path may be relative or absolute)

    - *server.httpPort* and *server.httpsPort*<br/>

    - *server.httpPort* and *server.httpsPort*

    - *server.httpBindInterface* and *server.httpsBindInterface*<br/>

    **https** is strongly recommended because passwords are insecurely transmitted form your browser/git client using Basic authentication!     
    **https** is strongly recommended because passwords are insecurely transmitted form your browser/git client using Basic authentication!

3. Execute `gitblit.cmd` or `java -jar gitblit.jar` from a command-line

4. Wait a minute or two while all dependencies are downloaded and your self-signed *localhost* certificate is generated.<br/>Please see the section titled **Creating your own Self-Signed Certificate** to generate a certificate for *your hostname*.

5. Open your browser to <http://localhost:8080> or <https://localhost:8443> depending on your chosen configuration.

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

Gitblit GO automatically generates an ssl certificate for you that is bound to *localhost*.



Remote Eclipse/EGit/JGit clients (<= 1.0.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 (<= 1.1.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:



@@ -130,6 +130,9 @@
       accessRestriction = clone

       isFrozen = false

       showReadme = false

       federationStrategy = FEDERATE_THIS

       isFederated = false

       federationSets = 
       

#### Repository Names

Repository names must be unique and are CASE-SENSITIVE ON CASE-SENSITIVE FILESYSTEMS.  The name must be composed of letters, digits, or `/ _ - .`<br/>

@@ -156,7 +159,7 @@
User passwords are CASE-SENSITIVE and may be *plain* or *md5* formatted (see `gitblit.properties` -> *realm.passwordStorage*).



#### User Roles

There is only one actual *role* in Gitblit and that is *#admin* which grants administrative powers to that user.  Administrators automatically have access to all repositories.  All other *roles* are repository names.  If a repository is access-restricted, the user must have the repository's name within his/her roles to bypass the access restriction.  This is how users are granted access to a restricted repository.

There are two actual *roles* in Gitblit: *#admin*, which grants administrative powers to that user, and *#notfederated*, which prevents an account from being pulled by another Gitblit instance.  Administrators automatically have access to all repositories.  All other *roles* are repository names.  If a repository is access-restricted, the user must have the repository's name within his/her roles to bypass the access restriction.  This is how users are granted access to a restricted repository.



## Authentication and Authorization Customization

Instead of maintaining a `users.properties` file, you may want to integrate Gitblit into an existing environment.

@@ -304,7 +307,7 @@
**NOTE:**<br/>

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

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.<br/>

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

- Eclipse/EGit/JGit

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