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 |
|
2fe1e2
|
6 |
1. Are you running Java 7?<br />Java 7 introduced SNI support for SSL connections and it is enabled by default.<br />[Java 7 Security Enhancements](http://docs.oracle.com/javase/7/docs/technotes/guides/security/enhancements-7.html)<br />To disable SNI alerts, add this line to your eclipse.ini file and restart Eclipse.<br /><pre>-Djsse.enableSNIExtension=false</pre>
|
JM |
7 |
2. You are using https with a self-signed certificate and you **did not** configure *http.sslVerify=false*
|
1f9dae
|
8 |
1. Window->Preferences->Team->Git->Configuration
|
JM |
9 |
2. Click the *New Entry* button
|
3b5289
|
10 |
3. <pre>Key = <em>http.sslVerify</em>
|
JM |
11 |
Value = <em>false</em></pre>
|
2fe1e2
|
12 |
3. Gitblit GO's default self-signed certificate is bound to *localhost* and you are trying to clone/push between machines.
|
d39680
|
13 |
1. Review the contents of `makekeystore.cmd`
|
JM |
14 |
2. Set *your hostname* in the *HOSTNAME* variable.
|
|
15 |
3. Execute the script.<br/>This will generate a new certificate and keystore for *your hostname* protected by *server.storePassword*.
|
2fe1e2
|
16 |
4. The repository is clone-restricted and you don't have access.
|
JM |
17 |
5. The repository is clone-restricted and your password changed.
|
|
18 |
6. A regression in Gitblit. :(
|
1f9dae
|
19 |
|
99c974
|
20 |
### I can not push using git:// protocol on Windows using native Git
|
JM |
21 |
|
|
22 |
This is a long-standing, known bug in the native Git for Windows implementation.
|
|
23 |
|
|
24 |
https://groups.google.com/d/topic/msysgit/at8D7J-h7mw/discussion
|
|
25 |
|
85c2e6
|
26 |
### Why can't I access Gitblit GO from another machine?
|
d39680
|
27 |
1. Please check *server.httpBindInterface* and *server.httpsBindInterface* in `gitblit.properties`, you may be only be serving on *localhost*.
|
JM |
28 |
2. Please see the above answer about "**can't open upload pack**".
|
|
29 |
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
|
30 |
|
JM |
31 |
### How do I run Gitblit GO on port 80 or 443 in Linux?
|
1f9dae
|
32 |
Linux requires root permissions to serve on ports < 1024.<br/>
|
JM |
33 |
Run the server as *root* (security concern) or change the ports you are serving to 8080 (http) and/or 8443 (https).
|
85c2e6
|
34 |
|
JM |
35 |
### Gitblit GO does not list my repositories?!
|
d39680
|
36 |
1. Confirm that the value *git.repositoriesFolder* in `gitblit.properties` actually points to your repositories folder.
|
JM |
37 |
2. Confirm that the Gitblit GO process has full read-write-execute permissions to your *git.repositoriesFolder*.
|
85c2e6
|
38 |
|
JM |
39 |
### Gitblit WAR does not list my repositories?!
|
d39680
|
40 |
1. Confirm that the <context-param> *git.repositoriesFolder* value in your `web.xml` file actually points to your repositories folder.
|
JM |
41 |
2. Confirm that the servlet container process has full read-write-execute permissions to your *git.repositoriesFolder*.
|
85c2e6
|
42 |
|
JM |
43 |
### Gitblit WAR will not authenticate any users?!
|
93f472
|
44 |
Confirm that the <context-param> *realm.userService* value in your `web.xml` file actually points to a `users.conf` or `users.properties` file.
|
1f9dae
|
45 |
|
70b492
|
46 |
### Gitblit won't open my grouped repository (/group/myrepo.git) or browse my log/branch/tag/ref?!
|
3b5289
|
47 |
This is likely an url encoding/decoding problem with forward slashes:
|
JM |
48 |
|
|
49 |
**bad**
|
|
50 |
|
|
51 |
http://192.168.1.2/log/myrepo.git/refs/heads/master
|
|
52 |
|
|
53 |
**good**
|
|
54 |
|
|
55 |
http://192.168.1.2/log/myrepo.git/refs%2Fheads%2Fmaster
|
|
56 |
|
|
57 |
**NOTE:**
|
3cc6e2
|
58 |
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
|
59 |
|
JM |
60 |
There are two possible workarounds for this issue. In `gitblit.properties` or `web.xml`:
|
230632
|
61 |
|
JM |
62 |
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*).
|
|
63 |
2. try changing *web.forwardSlashCharacter* to an asterisk or a **!**
|
7e5ee5
|
64 |
|
3b5289
|
65 |
### Running Gitblit behind mod_proxy or some other proxy layer
|
JM |
66 |
|
|
67 |
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*.
|
|
68 |
|
3cc6e2
|
69 |
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
|
70 |
|
486ee1
|
71 |
### Running Gitblit on Tomcat
|
JM |
72 |
|
|
73 |
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.
|
|
74 |
You have a few options on how to handle this scenario:
|
|
75 |
|
efba97
|
76 |
1. [Tweak Tomcat](http://tomcat.apache.org/security-6.html#Fixed_in_Apache_Tomcat_6.0.10)
|
3cc6e2
|
77 |
Add *-Dorg.apache.tomcat.util.buf.UDecoder.ALLOW_ENCODED_SLASH=true* to *CATALINA_OPTS* or to your JVM launch parameters
|
486ee1
|
78 |
2. *web.mountParameters = false* and use non-pretty, parameterized urls
|
JM |
79 |
3. *web.forwardSlashCharacter = !* which tells Gitblit to use **!** instead of **/**
|
|
80 |
|
b34048
|
81 |
#### UTF-8 Filenames
|
JM |
82 |
|
|
83 |
Tomcat also dislikes urls with non-ASCII characters. If your repositories have non-ASCII filenames you will have to modify your connector properties to allow UTF-8 encoded urls.
|
|
84 |
|
|
85 |
[Tomcat Character Encoding](http://wiki.apache.org/tomcat/FAQ/CharacterEncoding)
|
|
86 |
[Tomcat Connector Properties](http://tomcat.apache.org/tomcat-6.0-doc/config/http.html)
|
|
87 |
|
1f9dae
|
88 |
## General Interest Questions
|
f90dc6
|
89 |
|
f13c4c
|
90 |
### Gitblit? What kind of name is that?
|
1f9dae
|
91 |
It's a phonetic play on [bitblt][bitblt] which is an image processing operation meaning *bit-block transfer*.
|
f90dc6
|
92 |
|
f13c4c
|
93 |
### Why use Gitblit?
|
1f9dae
|
94 |
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
|
95 |
|
168566
|
96 |
### Who is the target user for Gitblit?
|
JM |
97 |
Small workgroups that require centralized repositories.
|
|
98 |
|
|
99 |
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.
|
|
100 |
|
85c2e6
|
101 |
### Why does Gitblit exist when there is Git and Gitweb?
|
168566
|
102 |
As a Java developer I prefer that as much of my tooling as possible is Java.<br/>
|
JM |
103 |
Originally, I was going to use [Mercurial](http://mercurial.selenic.com) but...
|
|
104 |
|
716745
|
105 |
- 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
|
106 |
Parsing command-line output is fragile and suboptimal.<br/>Unfortunately this is necessary because Mercurial is an application, not a library.
|
JM |
107 |
- 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/>
|
|
108 |
This requires setup and maintenance of multiple, mixed 3rd party components.
|
|
109 |
|
|
110 |
Gitblit eliminates all that complication with its 100% Java stack and simple single configuration file.
|
|
111 |
|
85c2e6
|
112 |
Additionally, Git and Gitweb do not offer repository creation or user management.
|
JM |
113 |
|
f90dc6
|
114 |
### Do I need real Git?
|
d39680
|
115 |
No (mostly). Gitblit is based on [JGit][jgit] which is a pure Java implementation of the [Git version control system][git].<br/>
|
85c2e6
|
116 |
Everything you need for Gitblit (except Java) is either bundled in the distribution file or automatically downloaded on execution.
|
d39680
|
117 |
|
3b5289
|
118 |
#### mostly
|
d39680
|
119 |
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
|
120 |
|
168566
|
121 |
### Can I run Gitblit in conjunction with my existing Git tooling?
|
5450d0
|
122 |
Yes.
|
f90dc6
|
123 |
|
f13c4c
|
124 |
### Do I need a JDK or can I use a JRE?
|
JM |
125 |
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
|
126 |
|
f13c4c
|
127 |
### Does Gitblit use a database to store its data?
|
93f472
|
128 |
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
|
129 |
|
93f472
|
130 |
### Can I manually edit users.conf, users.properties, gitblit.properties, or .git/config?
|
1f9dae
|
131 |
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 |
132 |
|
3b5289
|
133 |
**NOTE:**
|
JM |
134 |
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
|
135 |
|
6f46fa
|
136 |
### Can I restrict access to branches or paths within a repository?
|
JM |
137 |
No, not out-of-the-box. Access restrictions apply to the repository as a whole.
|
56c549
|
138 |
|
6f46fa
|
139 |
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 |
140 |
|
|
141 |
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.
|
|
142 |
|
|
143 |
Alternatively, you could use [gitolite](https://github.com/sitaramc/gitolite) and SSH for your repository access.
|
56c549
|
144 |
|
5450d0
|
145 |
### Can I authenticate users against XYZ?
|
6f46fa
|
146 |
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
|
147 |
|
f13c4c
|
148 |
### Why doesn't Gitblit support SSH?
|
JM |
149 |
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
|
150 |
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
|
151 |
|
JM |
152 |
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
|
153 |
|
f13c4c
|
154 |
### What types of Search does Gitblit support?
|
e4547f
|
155 |
|
JM |
156 |
As of 0.9.0, Gitblit supports Lucene-based searching.
|
|
157 |
|
|
158 |
If Lucene indexing is disabled, Gitblit falls back to brute-force commit-traversal search. Commit-traversal search supports case-insensitive searching of *commit message* (default), *author*, and *committer*.<br/>
|
f90dc6
|
159 |
|
JM |
160 |
To search by *author* or *committer* use the following syntax in the search box:
|
|
161 |
|
|
162 |
author: james
|
|
163 |
committer: james
|
|
164 |
|
|
165 |
Alternatively, you could enable the search type dropdown list in your `gitblit.properties` file.
|
|
166 |
|
831469
|
167 |
### Why did you call the setting federation.N.frequency instead of federation.N.period?!
|
JM |
168 |
|
|
169 |
Yes, yes I know that you are really specifying the period, but Frequency sounds better to me. :)
|
|
170 |
|
716745
|
171 |
### Can Gitblit be translated?
|
JM |
172 |
|
|
173 |
Yes. Most messages are localized to a standard Java properties file.
|
c19ae5
|
174 |
|
f90dc6
|
175 |
[bitblt]: http://en.wikipedia.org/wiki/Bit_blit "Wikipedia Bitblt"
|
JM |
176 |
[jgit]: http://eclipse.org/jgit "Eclipse JGit Site"
|
a4d249
|
177 |
[git]: http://git-scm.com "Official Git Site"
|
f13c4c
|
178 |
[mina]: http://mina.apache.org "Apache Mina"
|
c22722
|
179 |
[bouncycastle]: http://bouncycastle.org "The Legion of the Bouncy Castle" |