| commit | author | age | ||
| 1f9dae | 1 | ## Troubleshooting |
| JM | 2 | |
| d39680 | 3 | ### Eclipse/Egit/JGit complains that it "can't open upload pack"? |
| 1f9dae | 4 | There are a few ways this can occur: |
| JM | 5 | |
| 6 | 1. You are using https with a self-signed certificate and you **did not** configure *http.sslVerify=false* | |
| 7 | 1. Window->Preferences->Team->Git->Configuration | |
| 8 | 2. Click the *New Entry* button | |
| 3b5289 | 9 | 3. <pre>Key = <em>http.sslVerify</em> |
| JM | 10 | Value = <em>false</em></pre> |
| d39680 | 11 | 2. Gitblit GO's default self-signed certificate is bound to *localhost* and you are trying to clone/push between machines. |
| JM | 12 | 1. Review the contents of `makekeystore.cmd` |
| 13 | 2. Set *your hostname* in the *HOSTNAME* variable. | |
| 14 | 3. Execute the script.<br/>This will generate a new certificate and keystore for *your hostname* protected by *server.storePassword*. | |
| 15 | 3. The repository is clone-restricted and you don't have access. | |
| 16 | 4. The repository is clone-restricted and your password changed. | |
| 17 | 5. A regression in Gitblit. :( | |
| 1f9dae | 18 | |
| 85c2e6 | 19 | ### Why can't I access Gitblit GO from another machine? |
| d39680 | 20 | 1. Please check *server.httpBindInterface* and *server.httpsBindInterface* in `gitblit.properties`, you may be only be serving on *localhost*. |
| JM | 21 | 2. Please see the above answer about "**can't open upload pack**". |
| 22 | 3. Ensure that any firewall you may have running on the Gitblit server either has an exception for your specified ports or for the running process. | |
| 85c2e6 | 23 | |
| JM | 24 | ### How do I run Gitblit GO on port 80 or 443 in Linux? |
| 1f9dae | 25 | Linux requires root permissions to serve on ports < 1024.<br/> |
| JM | 26 | Run the server as *root* (security concern) or change the ports you are serving to 8080 (http) and/or 8443 (https). |
| 85c2e6 | 27 | |
| JM | 28 | ### Gitblit GO does not list my repositories?! |
| d39680 | 29 | 1. Confirm that the value *git.repositoriesFolder* in `gitblit.properties` actually points to your repositories folder. |
| JM | 30 | 2. Confirm that the Gitblit GO process has full read-write-execute permissions to your *git.repositoriesFolder*. |
| 85c2e6 | 31 | |
| JM | 32 | ### Gitblit WAR does not list my repositories?! |
| d39680 | 33 | 1. Confirm that the <context-param> *git.repositoriesFolder* value in your `web.xml` file actually points to your repositories folder. |
| JM | 34 | 2. Confirm that the servlet container process has full read-write-execute permissions to your *git.repositoriesFolder*. |
| 85c2e6 | 35 | |
| JM | 36 | ### Gitblit WAR will not authenticate any users?! |
| 93f472 | 37 | Confirm that the <context-param> *realm.userService* value in your `web.xml` file actually points to a `users.conf` or `users.properties` file. |
| 1f9dae | 38 | |
| 70b492 | 39 | ### Gitblit won't open my grouped repository (/group/myrepo.git) or browse my log/branch/tag/ref?! |
| 3b5289 | 40 | This is likely an url encoding/decoding problem with forward slashes: |
| JM | 41 | |
| 42 | **bad** | |
| 43 | ||
| 44 | http://192.168.1.2/log/myrepo.git/refs/heads/master | |
| 45 | ||
| 46 | **good** | |
| 47 | ||
| 48 | http://192.168.1.2/log/myrepo.git/refs%2Fheads%2Fmaster | |
| 49 | ||
| 50 | **NOTE:** | |
| 3cc6e2 | 51 | You can not trust the url in the address bar of your browser since your browser may decode it for presentation. When in doubt, *View Source* of the generated html to confirm the *href*. |
| 3b5289 | 52 | |
| JM | 53 | There are two possible workarounds for this issue. In `gitblit.properties` or `web.xml`: |
| 230632 | 54 | |
| JM | 55 | 1. try setting *web.mountParameters* to *false*.<br/>This changes the url scheme from mounted (*/commit/myrepo.git/abcdef*) to parameterized (*/commit/?r=myrepo.git&h=abcdef*). |
| 56 | 2. try changing *web.forwardSlashCharacter* to an asterisk or a **!** | |
| 7e5ee5 | 57 | |
| 3b5289 | 58 | ### Running Gitblit behind mod_proxy or some other proxy layer |
| JM | 59 | |
| 60 | You must ensure that the proxy does not decode and then re-encode request urls with interpretation of forward-slashes (*%2F*). If your proxy layer does re-encode embedded forward-slashes then you may not be able to browse grouped repositories or logs, branches, and tags **unless** you set *web.mountParameters=false*. | |
| 61 | ||
| 3cc6e2 | 62 | If you are using Apache mod_proxy you may have luck with specifying [AllowEncodedSlashes NoDecode](http://httpd.apache.org/docs/2.2/mod/core.html#allowencodedslashes). |
| 70b492 | 63 | |
| 486ee1 | 64 | ### Running Gitblit on Tomcat |
| JM | 65 | |
| 66 | Tomcat takes the extra precaution of [disallowing embedded slashes by default](http://tomcat.apache.org/security-6.html#Fixed_in_Apache_Tomcat_6.0.10). This breaks Gitblit urls. | |
| 67 | You have a few options on how to handle this scenario: | |
| 68 | ||
| efba97 | 69 | 1. [Tweak Tomcat](http://tomcat.apache.org/security-6.html#Fixed_in_Apache_Tomcat_6.0.10) |
| 3cc6e2 | 70 | Add *-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true* to *CATALINA_OPTS* or to your JVM launch parameters |
| 486ee1 | 71 | 2. *web.mountParameters = false* and use non-pretty, parameterized urls |
| JM | 72 | 3. *web.forwardSlashCharacter = !* which tells Gitblit to use **!** instead of **/** |
| 73 | ||
| 1f9dae | 74 | ## General Interest Questions |
| f90dc6 | 75 | |
| f13c4c | 76 | ### Gitblit? What kind of name is that? |
| 1f9dae | 77 | It's a phonetic play on [bitblt][bitblt] which is an image processing operation meaning *bit-block transfer*. |
| f90dc6 | 78 | |
| f13c4c | 79 | ### Why use Gitblit? |
| 1f9dae | 80 | It's a small tool that allows you to easily manage shared repositories and doesn't require alot of setup or git kung-foo. |
| f90dc6 | 81 | |
| 168566 | 82 | ### Who is the target user for Gitblit? |
| JM | 83 | Small workgroups that require centralized repositories. |
| 84 | ||
| 85 | Gitblit is not meant to be a social coding resource like [Github](http://github.com) or [Bitbucket](http://bitbucket.com) with 100s or 1000s of users. Gitblit is designed to fulfill the same function as your centralized Subversion or CVS server. | |
| 86 | ||
| 85c2e6 | 87 | ### Why does Gitblit exist when there is Git and Gitweb? |
| 168566 | 88 | As a Java developer I prefer that as much of my tooling as possible is Java.<br/> |
| JM | 89 | Originally, I was going to use [Mercurial](http://mercurial.selenic.com) but... |
| 90 | ||
| 716745 | 91 | - MercurialEclipse [shells to Python, writes to System.out, and captures System.in](http://mercurial.808500.n3.nabble.com/Hg4J-Mercurial-pure-Java-library-tp2693090p2694555.html)<br/> |
| 168566 | 92 | Parsing command-line output is fragile and suboptimal.<br/>Unfortunately this is necessary because Mercurial is an application, not a library. |
| JM | 93 | - Mercurial HTTP/HTTPS needs to run as CGI through Apache/IIS/etc, as mod_python through Apache, or served with a built-in http server.<br/> |
| 94 | This requires setup and maintenance of multiple, mixed 3rd party components. | |
| 95 | ||
| 96 | Gitblit eliminates all that complication with its 100% Java stack and simple single configuration file. | |
| 97 | ||
| 85c2e6 | 98 | Additionally, Git and Gitweb do not offer repository creation or user management. |
| JM | 99 | |
| f90dc6 | 100 | ### Do I need real Git? |
| d39680 | 101 | No (mostly). Gitblit is based on [JGit][jgit] which is a pure Java implementation of the [Git version control system][git].<br/> |
| 85c2e6 | 102 | Everything you need for Gitblit (except Java) is either bundled in the distribution file or automatically downloaded on execution. |
| d39680 | 103 | |
| 3b5289 | 104 | #### mostly |
| d39680 | 105 | JGit does not fully support the git-gc featureset (garbage collection) so you may want native Git to periodically run git-gc until [JGit][jgit] fully supports this feature. |
| 716745 | 106 | |
| 168566 | 107 | ### Can I run Gitblit in conjunction with my existing Git tooling? |
| 5450d0 | 108 | Yes. |
| f90dc6 | 109 | |
| f13c4c | 110 | ### Do I need a JDK or can I use a JRE? |
| JM | 111 | Gitblit will run just fine with a JRE. Gitblit can optionally use `keytool` from the JDK to generate self-signed certificates, but normally Gitblit uses [BouncyCastle][bouncycastle] for that need. |
| 1f9dae | 112 | |
| f13c4c | 113 | ### Does Gitblit use a database to store its data? |
| 93f472 | 114 | No. Gitblit stores its repository configuration information within the `.git/config` file and its user information in `users.conf`, `users.properties`, or whatever filename is configured in `gitblit.properties`. |
| f13c4c | 115 | |
| 93f472 | 116 | ### Can I manually edit users.conf, users.properties, gitblit.properties, or .git/config? |
| 1f9dae | 117 | Yes. You can manually manipulate all of them and (most) changes will be immediately available to Gitblit.<br/>Exceptions to this are noted in `gitblit.properties`. |
| JM | 118 | |
| 3b5289 | 119 | **NOTE:** |
| JM | 120 | Care must be taken to preserve the relationship between user roles and repository names.<br/>Please see the *User Roles* section of the [setup](/setup.html) page for details. |
| a4d249 | 121 | |
| 6f46fa | 122 | ### Can I restrict access to branches or paths within a repository? |
| JM | 123 | No, not out-of-the-box. Access restrictions apply to the repository as a whole. |
| 56c549 | 124 | |
| 6f46fa | 125 | Gitblit's simple authentication and authorization mechanism can be used to facilitate one or more of the [workflows outlined here](http://progit.org/book/ch5-1.html). |
| JM | 126 | |
| 127 | Should you require more fine-grained access controls you might consider writing a Groovy *prereceive* script to block updating branch refs based on some permissions file. I would be interested in a generic, re-usable script to include with Gitblit, should someone want to implement it. | |
| 128 | ||
| 129 | Alternatively, you could use [gitolite](https://github.com/sitaramc/gitolite) and SSH for your repository access. | |
| 56c549 | 130 | |
| 5450d0 | 131 | ### Can I authenticate users against XYZ? |
| 6f46fa | 132 | Yes. The user service is pluggable. You may write your own complete user service by implementing the *com.gitblit.IUserService* interface. Or you may subclass *com.gitblit.GitblitUserService* and override just the authentication. Set the fully qualified classname as the *realm.userService* property. |
| 5450d0 | 133 | |
| f13c4c | 134 | ### Why doesn't Gitblit support SSH? |
| JM | 135 | Gitblit could integrate [Apache Mina][mina] to provide SSH access. However, doing so violates Gitblit's first design principle: [KISS](http://en.wikipedia.org/wiki/KISS_principle).<br/> |
| 716745 | 136 | SSH support requires creating, exchanging, and managing SSH keys (arguably not more complicated than managing users). While this is possible, JGit's SmartHTTP implementation is a simpler and universal transport mechanism. |
| a4d249 | 137 | |
| JM | 138 | You might consider running [Gerrit](http://gerrit.googlecode.org) which does integrate [Apache Mina][mina] and supports SSH or you might consider serving [Git][git] on Linux which would offer real SSH support and also allow use of [many other compelling Git solutions](https://git.wiki.kernel.org/index.php/InterfacesFrontendsAndTools). |
| f90dc6 | 139 | |
| f13c4c | 140 | ### What types of Search does Gitblit support? |
| JM | 141 | Gitblit supports case-insensitive searches of *commit message* (default), *author*, and *committer*.<br/> |
| f90dc6 | 142 | |
| JM | 143 | To search by *author* or *committer* use the following syntax in the search box: |
| 144 | ||
| 145 | author: james | |
| 146 | committer: james | |
| 147 | ||
| 148 | Alternatively, you could enable the search type dropdown list in your `gitblit.properties` file. | |
| 149 | ||
| 831469 | 150 | ### Why did you call the setting federation.N.frequency instead of federation.N.period?! |
| JM | 151 | |
| 152 | Yes, yes I know that you are really specifying the period, but Frequency sounds better to me. :) | |
| 153 | ||
| 716745 | 154 | ### Can Gitblit be translated? |
| JM | 155 | |
| 156 | Yes. Most messages are localized to a standard Java properties file. | |
| c19ae5 | 157 | |
| f90dc6 | 158 | [bitblt]: http://en.wikipedia.org/wiki/Bit_blit "Wikipedia Bitblt" |
| JM | 159 | [jgit]: http://eclipse.org/jgit "Eclipse JGit Site" |
| a4d249 | 160 | [git]: http://git-scm.com "Official Git Site" |
| f13c4c | 161 | [mina]: http://mina.apache.org "Apache Mina" |
| c22722 | 162 | [bouncycastle]: http://bouncycastle.org "The Legion of the Bouncy Castle" |
