| | |
|---|
| | | ## Gitblit WAR Setup
|
|---|
| | |
|
|---|
| | | 1. Download [Gitblit WAR %VERSION%](http://code.google.com/p/gitblit/downloads/detail?name=%WAR%) to the webapps folder of your servlet container.<br/>
|
|---|
| | | 1. Download [Gitblit WAR %VERSION%](http://code.google.com/p/gitblit/downloads/detail?name=%WAR%) to the webapps folder of your servlet container. |
|---|
| | | 2. You may have to manually extract the WAR (zip file) to a folder within your webapps folder.
|
|---|
| | | 3. Copy the `WEB-INF/users.properties` file to a location outside the webapps folder that is accessible by your servlet container. |
|---|
| | | 4. The Gitblit webapp is configured through its `web.xml` file.<br/>
|
|---|
| | | 3. Copy the `WEB-INF/users.conf` file to a location outside the webapps folder that is accessible by your servlet container. |
|---|
| | | 4. The Gitblit webapp is configured through its `web.xml` file. |
|---|
| | | Open `web.xml` in your favorite text editor and make sure to review and set:
|
|---|
| | | - <context-parameter> *git.repositoryFolder* (set the full path to your repositories folder)
|
|---|
| | | - <context-parameter> *realm.userService* (set the full path to `users.properties`)
|
|---|
| | | - <context-parameter> *realm.userService* (set the full path to `users.conf`)
|
|---|
| | | 5. You may have to restart your servlet container.
|
|---|
| | | 6. Open your browser to <http://localhost/gitblit> or whatever the url should be.
|
|---|
| | | 7. Click the *Login* link and enter the default administrator credentials: **admin / admin**<br/>
|
|---|
| | | 7. Enter the default administrator credentials: **admin / admin** and click the *Login* button |
|---|
| | | **NOTE:** Make sure to change the administrator username and/or password!!
|
|---|
| | |
|
|---|
| | | ## Gitblit GO Setup
|
|---|
| | |
|
|---|
| | | 1. Download and unzip [Gitblit GO %VERSION%](http://code.google.com/p/gitblit/downloads/detail?name=%GO%).<br/>
|
|---|
| | | 1. Download and unzip [Gitblit GO %VERSION%](http://code.google.com/p/gitblit/downloads/detail?name=%GO%). |
|---|
| | | *Its best to eliminate spaces in the path name.*
|
|---|
| | | 2. The server itself is configured through a simple text file.<br/>
|
|---|
| | | 2. The server itself is configured through a simple text file. |
|---|
| | | 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.httpBindInterface* and *server.httpsBindInterface*<br/>
|
|---|
| | | **https** is strongly recommended because passwords are insecurely transmitted form your browser/git client using Basic authentication! |
|---|
| | | - *server.httpPort* and *server.httpsPort*
|
|---|
| | | - *server.httpBindInterface* and *server.httpsBindInterface* |
|---|
| | | **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> or <https://localhost> depending on your chosen configuration.
|
|---|
| | | 6. Click the *Login* link and enter the default administrator credentials: **admin / admin**<br/>
|
|---|
| | | 4. Wait a minute or two while all dependencies are downloaded and your self-signed *localhost* certificate is generated. |
|---|
| | | 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.
|
|---|
| | | 6. Enter the default administrator credentials: **admin / admin** and click the *Login* button |
|---|
| | | **NOTE:** Make sure to change the administrator username and/or password!!
|
|---|
| | |
|
|---|
| | | ### 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:
|
|---|
| | |
|
|---|
| | |
|---|
| | | 2. Set *your hostname* into the *HOSTNAME* variable.
|
|---|
| | | 3. Execute the script.<br/>This will generate a new certificate and keystore for *your hostname* protected by *server.storePassword*.
|
|---|
| | |
|
|---|
| | | **NOTE:**<br/>If you use `makekeystore_jdk.cmd`, the certificate password AND the keystore password must match and must be set as *server.storePassword* or specified with the *storePassword* command-line parameter!
|
|---|
| | | **NOTE:** |
|---|
| | | If you use `makekeystore_jdk.cmd`, the certificate password AND the keystore password must match and must be set as *server.storePassword* or specified with the *storePassword* command-line parameter!
|
|---|
| | |
|
|---|
| | | Additionally, if you want to change the value of *server.storePassword* (recommended) you will have to generate a new certificate afterwards.
|
|---|
| | |
|
|---|
| | |
|---|
| | | Gitblit uses [Apache Commons Daemon](http://commons.apache.org/daemon) to install and configure its Windows service.
|
|---|
| | |
|
|---|
| | | 1. Review the contents of the `installService.cmd`
|
|---|
| | | 2. Set the *ARCH* value as appropriate for your installed Java Virtual Machine.<br/>
|
|---|
| | | 2. Set the *ARCH* value as appropriate for your installed Java Virtual Machine.
|
|---|
| | | 3. Add any necessary *--StartParams* as enumerated below in **Command-Line Parameters**.
|
|---|
| | | 4. Execute the script.
|
|---|
| | |
|
|---|
| | |
|---|
| | | 1. Execute `gitblitw.exe`
|
|---|
| | | 2. On the *Java* tab uncheck *Use default*.
|
|---|
| | | 3. Manually navigate your filesystem and specify the server VM with the `...` button<br/><pre>
|
|---|
| | | Java Virtual Machine:
|
|---|
| | | C:\Program Files\Java\jre6\bin\server\jvm.dll</pre>
|
|---|
| | | Java Virtual Machine:
|
|---|
| | | C:\Program Files\Java\jre6\bin\server\jvm.dll</pre>
|
|---|
| | |
|
|---|
| | | #### Command-Line Parameters
|
|---|
| | | Command-Line parameters override the values in `gitblit.properties` at runtime.
|
|---|
| | |
|---|
| | |
|
|---|
| | | **Example**
|
|---|
| | |
|
|---|
| | | java -jar gitblit.jar --userService c:\myrealm.properties --storePassword something
|
|---|
| | | |
|---|
| | | java -jar gitblit.jar --userService c:\myrealm.config --storePassword something
|
|---|
| | |
|
|---|
| | | ## Upgrading Gitblit
|
|---|
| | | Generally, upgrading is easy.
|
|---|
| | |
|
|---|
| | | Since Gitblit does not use a database the only files you have to worry about are your configuration file (`gitblit.properties` or `web.xml`) and possibly your `users.conf` or `users.properties` file.
|
|---|
| | |
|
|---|
| | | Any important changes to the setting keys or default values will always be mentioned in the [release log](releases.html).
|
|---|
| | |
|
|---|
| | | Gitblit v0.8.0 introduced a new default user service implementation which serializes and deserializes user objects into `users.conf`. A `users.conf` file will be automatically created from an existing `users.properties` file on the first launch after an upgrade. To use the `users.conf` service, *realm.userService=users.conf* must be set. This revised user service allows for more sophisticated Gitblit user objects and will facilitate the development of more advanced features without adding the complexity of an embedded SQL database.
|
|---|
| | |
|
|---|
| | | `users.properties` and its user service implementation are deprecated as of v0.8.0.
|
|---|
| | |
|
|---|
| | | ### Upgrading Gitblit WAR
|
|---|
| | | 1. Backup your `web.xml` file |
|---|
| | | Backup your `web.properties` file (if you have one, these are the setting overrides from using the RPC administration service)
|
|---|
| | | 2. Delete currently deployed gitblit WAR
|
|---|
| | | 3. Deploy new WAR and overwrite the `web.xml` file with your backup
|
|---|
| | | 4. Review and optionally apply any new settings as indicated in the [release log](releases.html). |
|---|
| | | |
|---|
| | | ### Upgrading Gitblit GO
|
|---|
| | | |
|---|
| | | 1. Backup your `gitblit.properties` file
|
|---|
| | | 2. Backup your `users.properties` file *(if it is located in the Gitblit GO folder)* |
|---|
| | | OR |
|---|
| | | Backup your `users.conf` file *(if it is located in the Gitblit GO folder)*
|
|---|
| | | 3. Unzip Gitblit GO to a new folder
|
|---|
| | | 4. Overwrite the `gitblit.properties` file with your backup
|
|---|
| | | 5. Overwrite the `users.properties` file with your backup *(if it was located in the Gitblit GO folder)* |
|---|
| | | OR |
|---|
| | | Overwrite the `users.conf` file with your backup *(if it was located in the Gitblit GO folder)*
|
|---|
| | | 6. Review and optionally apply any new settings as indicated in the [release log](releases.html).
|
|---|
| | |
|
|---|
| | | #### Upgrading Windows Service
|
|---|
| | | You may need to delete your old service definition and install a new one depending on what has changed in the release.
|
|---|
| | |
|
|---|
| | | ## Gitblit Configuration
|
|---|
| | |
|
|---|
| | | ### Administering Repositories
|
|---|
| | |
|---|
| | | accessRestriction = clone
|
|---|
| | | isFrozen = false
|
|---|
| | | showReadme = false
|
|---|
| | | |
|---|
| | | federationStrategy = FEDERATE_THIS
|
|---|
| | | isFederated = false
|
|---|
| | | skipSizeCalculation = 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/>
|
|---|
| | | Whitespace is illegal.
|
|---|
| | |
|---|
| | | #### Repository Owner
|
|---|
| | | The *Repository Owner* has the special permission of being able to edit a repository through the web UI. The Repository Owner is not permitted to rename the repository, delete the repository, or reassign ownership to another user.
|
|---|
| | |
|
|---|
| | | ### Administering Users
|
|---|
| | | All users are stored in the `users.properties` file or in the file you specified in `gitblit.properties`.<br/>
|
|---|
| | | ### Teams
|
|---|
| | |
|
|---|
| | | Since v0.8.0, Gitblit supports *teams* for the original `users.properties` user service and the current default user service `users.conf`. Teams have assigned users and assigned repositories. A user can be a member of multiple teams and a repository may belong to multiple teams. This allows the administrator to quickly add a user to a team without having to keep track of all the appropriate repositories. |
|---|
| | |
|
|---|
| | | ### Administering Users (users.conf, Gitblit v0.8.0+)
|
|---|
| | | All users are stored in the `users.conf` file or in the file you specified in `gitblit.properties`. Your file extension must be *.conf* in order to use this user service.
|
|---|
| | |
|
|---|
| | | The `users.conf` file uses a Git-style configuration format:
|
|---|
| | |
|
|---|
| | | [user "admin"]
|
|---|
| | | password = admin
|
|---|
| | | role = "#admin"
|
|---|
| | | role = "#notfederated"
|
|---|
| | | repository = repo1.git
|
|---|
| | | repository = repo2.git
|
|---|
| | | |
|---|
| | | [user "hannibal"]
|
|---|
| | | password = bossman
|
|---|
| | |
|
|---|
| | | [user "faceman"]
|
|---|
| | | password = vanity
|
|---|
| | |
|
|---|
| | | [user "murdock"]
|
|---|
| | | password = crazy |
|---|
| | | |
|---|
| | | [user "babaracus"]
|
|---|
| | | password = grrrr
|
|---|
| | | |
|---|
| | | [team "ateam"]
|
|---|
| | | user = hannibal
|
|---|
| | | user = faceman
|
|---|
| | | user = murdock
|
|---|
| | | user = babaracus
|
|---|
| | | repository = topsecret.git
|
|---|
| | |
|
|---|
| | | The `users.conf` file allows flexibility for adding new fields to a UserModel object that the original `users.properties` file does not afford without imposing the complexity of relying on an embedded SQL database. |
|---|
| | |
|
|---|
| | | ### Administering Users (users.properties, Gitblit v0.5.0 - v0.7.0)
|
|---|
| | | All users are stored in the `users.properties` file or in the file you specified in `gitblit.properties`. Your file extension must be *.properties* in order to use this user service.
|
|---|
| | |
|
|---|
| | | The format of `users.properties` follows Jetty's convention for HashRealms:
|
|---|
| | |
|
|---|
| | | username,password,role1,role2,role3...
|
|---|
| | | @teamname,!username1,!username2,!username3,repository1,repository2,repository3...
|
|---|
| | |
|
|---|
| | | #### Usernames
|
|---|
| | | Usernames must be unique and are case-insensitive.<br/>
|
|---|
| | | Usernames must be unique and are case-insensitive. |
|---|
| | | Whitespace is illegal.
|
|---|
| | |
|
|---|
| | | #### Passwords
|
|---|
| | | User passwords are CASE-SENSITIVE and may be *plain* or *md5* formatted (see `gitblit.properties` -> *realm.passwordStorage*).
|
|---|
| | | User passwords are CASE-SENSITIVE and may be *plain*, *md5*, or *combined-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.
|
|---|
| | | Instead of maintaining a `users.conf` or `users.properties` file, you may want to integrate Gitblit into an existing environment.
|
|---|
| | |
|
|---|
| | | You may use your own custom *com.gitblit.IUserService* implementation by specifying its fully qualified classname in the *realm.userService* setting.<br/>
|
|---|
| | | You may use your own custom *com.gitblit.IUserService* implementation by specifying its fully qualified classname in the *realm.userService* setting.
|
|---|
| | |
|
|---|
| | | Your user service class must be on Gitblit's classpath and must have a public default constructor. |
|---|
| | | Your user service class must be on Gitblit's classpath and must have a public default constructor. |
|---|
| | | Please see the following interface definition [com.gitblit.IUserService](https://github.com/gitblit/gitblit/blob/master/src/com/gitblit/IUserService.java).
|
|---|
| | |
|
|---|
| | | ## Client Setup and Configuration
|
|---|
| | | ### Https with Self-Signed Certificates
|
|---|
| | | You must tell Git/JGit not to verify the self-signed certificate in order to perform any remote Git operations.
|
|---|
| | |
|
|---|
| | | **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. |
|---|
| | | **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 (<= 1.1.0) always verifies certificate hostnames, regardless of the *http.sslVerify=false* client-side setting. |
|---|
| | |
|
|---|
| | | - Eclipse/EGit/JGit
|
|---|
| | | - **Eclipse/EGit/JGit**
|
|---|
| | | 1. Window->Preferences->Team->Git->Configuration
|
|---|
| | | 2. Click the *New Entry* button
|
|---|
| | | 3. <pre>Key = *http.sslVerify* |
|---|
| | | Value = *false*</pre>
|
|---|
| | | - Command-line Git ([Git-Config Manual Page](http://www.kernel.org/pub/software/scm/git/docs/git-config.html))
|
|---|
| | | <pre>git config --global --bool --add http.sslVerify false</pre>
|
|---|
| | | 3. <pre>Key = <em>http.sslVerify</em>
|
|---|
| | | Value = <em>false</em></pre>
|
|---|
| | | - **Command-line Git** ([Git-Config Manual Page](http://www.kernel.org/pub/software/scm/git/docs/git-config.html)) |
|---|
| | | <pre>git config --global --bool --add http.sslVerify false</pre>
|
|---|
| | |
|
|---|
| | | ### Cloning an Access Restricted Repository
|
|---|
| | | - Eclipse/EGit/JGit<br/>Nothing special to configure, EGit figures out everything.
|
|---|
| | | <pre>https://yourserver/git/your/repository</pre>
|
|---|
| | | - Command-line Git<br/>*My testing indicates that your username must be embedded in the url. YMMV.*
|
|---|
| | | <pre>https://username@yourserver/git/your/repository</pre>
|
|---|
| | | |
|---|
| | | - **Eclipse/EGit/JGit** |
|---|
| | | Nothing special to configure, EGit figures out everything.
|
|---|
| | | <pre>https://yourserver/git/your/repository</pre>
|
|---|
| | | - **Command-line Git** |
|---|
| | | My testing indicates that your username must be embedded in the url. YMMV. |
|---|
| | | <pre>https://username@yourserver/git/your/repository</pre> |
|---|
