]>
Commit | Line | Data |
---|---|---|
3fda8c4c ML |
1 | git-cvsserver(1) |
2 | ================ | |
3 | ||
4 | NAME | |
5 | ---- | |
6 | git-cvsserver - A CVS server emulator for git | |
7 | ||
3fda8c4c ML |
8 | SYNOPSIS |
9 | -------- | |
693b6327 FL |
10 | |
11 | SSH: | |
12 | ||
3fda8c4c | 13 | [verse] |
da9973c6 | 14 | export CVS_SERVER="git cvsserver" |
3fda8c4c ML |
15 | 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name> |
16 | ||
693b6327 FL |
17 | pserver (/etc/inetd.conf): |
18 | ||
19 | [verse] | |
20 | cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver | |
21 | ||
22 | Usage: | |
23 | ||
24 | [verse] | |
0b444cdb | 25 | 'git-cvsserver' [options] [pserver|server] [<directory> ...] |
693b6327 FL |
26 | |
27 | OPTIONS | |
28 | ------- | |
29 | ||
30 | All these options obviously only make sense if enforced by the server side. | |
5162e697 | 31 | They have been implemented to resemble the linkgit:git-daemon[1] options as |
693b6327 FL |
32 | closely as possible. |
33 | ||
34 | --base-path <path>:: | |
35 | Prepend 'path' to requested CVSROOT | |
36 | ||
37 | --strict-paths:: | |
38 | Don't allow recursing into subdirectories | |
39 | ||
40 | --export-all:: | |
226bccb9 FL |
41 | Don't check for `gitcvs.enabled` in config. You also have to specify a list |
42 | of allowed directories (see below) if you want to use this option. | |
693b6327 | 43 | |
3240240f SB |
44 | -V:: |
45 | --version:: | |
693b6327 FL |
46 | Print version information and exit |
47 | ||
3240240f SB |
48 | -h:: |
49 | -H:: | |
50 | --help:: | |
693b6327 FL |
51 | Print usage information and exit |
52 | ||
53 | <directory>:: | |
54 | You can specify a list of allowed directories. If no directories | |
55 | are given, all are allowed. This is an additional restriction, gitcvs | |
56 | access still needs to be enabled by the `gitcvs.enabled` config option | |
57 | unless '--export-all' was given, too. | |
58 | ||
59 | ||
3fda8c4c ML |
60 | DESCRIPTION |
61 | ----------- | |
62 | ||
63 | This application is a CVS emulation layer for git. | |
64 | ||
65 | It is highly functional. However, not all methods are implemented, | |
66 | and for those methods that are implemented, | |
67 | not all switches are implemented. | |
68 | ||
69 | Testing has been done using both the CLI CVS client, and the Eclipse CVS | |
70 | plugin. Most functionality works fine with both of these clients. | |
71 | ||
72 | LIMITATIONS | |
73 | ----------- | |
3fda8c4c | 74 | |
b30cc0da | 75 | CVS clients cannot tag, branch or perform GIT merges. |
3fda8c4c | 76 | |
ba020ef5 | 77 | 'git-cvsserver' maps GIT branches to CVS modules. This is very different |
b2475703 FL |
78 | from what most CVS users would expect since in CVS modules usually represent |
79 | one or more directories. | |
80 | ||
3fda8c4c ML |
81 | INSTALLATION |
82 | ------------ | |
b30cc0da | 83 | |
031a027a | 84 | 1. If you are going to offer CVS access via pserver, add a line in |
b30cc0da | 85 | /etc/inetd.conf like |
0fc8573d FD |
86 | + |
87 | -- | |
88 | ------ | |
b30cc0da ML |
89 | cvspserver stream tcp nowait nobody git-cvsserver pserver |
90 | ||
0fc8573d | 91 | ------ |
893c365a FL |
92 | Note: Some inetd servers let you specify the name of the executable |
93 | independently of the value of argv[0] (i.e. the name the program assumes | |
94 | it was executed with). In this case the correct line in /etc/inetd.conf | |
95 | looks like | |
b30cc0da | 96 | |
0fc8573d | 97 | ------ |
893c365a | 98 | cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver |
b30cc0da | 99 | |
0fc8573d | 100 | ------ |
031a027a ÆAB |
101 | |
102 | Only anonymous access is provided by pserve by default. To commit you | |
c057bad3 SV |
103 | will have to create pserver accounts, simply add a gitcvs.authdb |
104 | setting in the config file of the repositories you want the cvsserver | |
105 | to allow writes to, for example: | |
031a027a ÆAB |
106 | |
107 | ------ | |
108 | ||
c057bad3 SV |
109 | [gitcvs] |
110 | authdb = /etc/cvsserver/passwd | |
031a027a ÆAB |
111 | |
112 | ------ | |
c057bad3 SV |
113 | The format of these files is username followed by the crypted password, |
114 | for example: | |
115 | ||
116 | ------ | |
117 | myuser:$1Oyx5r9mdGZ2 | |
118 | myuser:$1$BA)@$vbnMJMDym7tA32AamXrm./ | |
119 | ------ | |
120 | You can use the 'htpasswd' facility that comes with Apache to make these | |
121 | files, but Apache's MD5 crypt method differs from the one used by most C | |
122 | library's crypt() function, so don't use the -m option. | |
123 | ||
031a027a ÆAB |
124 | Then provide your password via the pserver method, for example: |
125 | ------ | |
126 | cvs -d:pserver:someuser:somepassword <at> server/path/repo.git co <HEAD_name> | |
127 | ------ | |
0fc8573d FD |
128 | No special setup is needed for SSH access, other than having GIT tools |
129 | in the PATH. If you have clients that do not accept the CVS_SERVER | |
ba020ef5 | 130 | environment variable, you can rename 'git-cvsserver' to `cvs`. |
54842895 | 131 | |
db218723 | 132 | Note: Newer CVS versions (>= 1.12.11) also support specifying |
54842895 FL |
133 | CVS_SERVER directly in CVSROOT like |
134 | ||
135 | ------ | |
da9973c6 | 136 | cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name> |
54842895 FL |
137 | ------ |
138 | This has the advantage that it will be saved in your 'CVS/Root' files and | |
139 | you don't need to worry about always setting the correct environment | |
ba020ef5 JN |
140 | variable. SSH users restricted to 'git-shell' don't need to override the default |
141 | with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean | |
2fd02c92 | 142 | 'git-cvsserver' and pretends that the other end runs the real 'cvs' better. |
0fc8573d | 143 | -- |
3fda8c4c ML |
144 | 2. For each repo that you want accessible from CVS you need to edit config in |
145 | the repo and add the following section. | |
0fc8573d FD |
146 | + |
147 | -- | |
148 | ------ | |
3fda8c4c ML |
149 | [gitcvs] |
150 | enabled=1 | |
b30cc0da | 151 | # optional for debugging |
3fda8c4c ML |
152 | logfile=/path/to/logfile |
153 | ||
0fc8573d | 154 | ------ |
ba020ef5 | 155 | Note: you need to ensure each user that is going to invoke 'git-cvsserver' has |
febe7dcc FL |
156 | write access to the log file and to the database (see |
157 | <<dbbackend,Database Backend>>. If you want to offer write access over | |
158 | SSH, the users of course also need write access to the git repository itself. | |
d55820ce | 159 | |
a41a32bf MO |
160 | You also need to ensure that each repository is "bare" (without a git index |
161 | file) for `cvs commit` to work. See linkgit:gitcvs-migration[7]. | |
162 | ||
febe7dcc | 163 | [[configaccessmethod]] |
a192a909 | 164 | All configuration variables can also be overridden for a specific method of |
d55820ce FL |
165 | access. Valid method names are "ext" (for SSH access) and "pserver". The |
166 | following example configuration would disable pserver access while still | |
167 | allowing access over SSH. | |
168 | ------ | |
169 | [gitcvs] | |
170 | enabled=0 | |
171 | ||
172 | [gitcvs "ext"] | |
173 | enabled=1 | |
174 | ------ | |
0fc8573d | 175 | -- |
2c2d02a6 SC |
176 | 3. If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command, |
177 | automatically saving it in your 'CVS/Root' files, then you need to set them | |
178 | explicitly in your environment. CVSROOT should be set as per normal, but the | |
179 | directory should point at the appropriate git repo. As above, for SSH clients | |
ba020ef5 | 180 | _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'. |
0fc8573d FD |
181 | + |
182 | -- | |
0fc8573d | 183 | ------ |
b30cc0da | 184 | export CVSROOT=:ext:user@server:/var/git/project.git |
da9973c6 | 185 | export CVS_SERVER="git cvsserver" |
0fc8573d FD |
186 | ------ |
187 | -- | |
2c2d02a6 SC |
188 | 4. For SSH clients that will make commits, make sure their server-side |
189 | .ssh/environment files (or .bashrc, etc., according to their specific shell) | |
190 | export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL, | |
191 | GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL. For SSH clients whose login | |
192 | shell is bash, .bashrc may be a reasonable alternative. | |
b30cc0da ML |
193 | |
194 | 5. Clients should now be able to check out the project. Use the CVS 'module' | |
2c2d02a6 SC |
195 | name to indicate what GIT 'head' you want to check out. This also sets the |
196 | name of your newly checked-out directory, unless you tell it otherwise with | |
197 | `-d <dir_name>`. For example, this checks out 'master' branch to the | |
198 | `project-master` directory: | |
0fc8573d FD |
199 | + |
200 | ------ | |
b30cc0da | 201 | cvs co -d project-master master |
0fc8573d | 202 | ------ |
3fda8c4c | 203 | |
febe7dcc FL |
204 | [[dbbackend]] |
205 | Database Backend | |
206 | ---------------- | |
207 | ||
ba020ef5 | 208 | 'git-cvsserver' uses one database per git head (i.e. CVS module) to |
2fdc0cfc MO |
209 | store information about the repository to maintain consistent |
210 | CVS revision numbers. The database needs to be | |
211 | updated (i.e. written to) after every commit. | |
0f76a543 | 212 | |
483bc4f0 | 213 | If the commit is done directly by using `git` (as opposed to |
ba020ef5 JN |
214 | using 'git-cvsserver') the update will need to happen on the |
215 | next repository access by 'git-cvsserver', independent of | |
0f76a543 FL |
216 | access method and requested operation. |
217 | ||
218 | That means that even if you offer only read access (e.g. by using | |
ba020ef5 | 219 | the pserver method), 'git-cvsserver' should have write access to |
febe7dcc | 220 | the database to work reliably (otherwise you need to make sure |
ba020ef5 | 221 | that the database is up-to-date any time 'git-cvsserver' is executed). |
febe7dcc FL |
222 | |
223 | By default it uses SQLite databases in the git directory, named | |
224 | `gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates | |
225 | temporary files in the same directory as the database file on | |
226 | write so it might not be enough to grant the users using | |
ba020ef5 | 227 | 'git-cvsserver' write access to the database file without granting |
0f76a543 | 228 | them write access to the directory, too. |
febe7dcc | 229 | |
2fdc0cfc MO |
230 | The database can not be reliably regenerated in a |
231 | consistent form after the branch it is tracking has changed. | |
232 | Example: For merged branches, 'git-cvsserver' only tracks | |
0b444cdb | 233 | one branch of development, and after a 'git merge' an |
2fdc0cfc MO |
234 | incrementally updated database may track a different branch |
235 | than a database regenerated from scratch, causing inconsistent | |
236 | CVS revision numbers. `git-cvsserver` has no way of knowing which | |
237 | branch it would have picked if it had been run incrementally | |
238 | pre-merge. So if you have to fully or partially (from old | |
239 | backup) regenerate the database, you should be suspicious | |
240 | of pre-existing CVS sandboxes. | |
241 | ||
febe7dcc FL |
242 | You can configure the database backend with the following |
243 | configuration variables: | |
244 | ||
245 | Configuring database backend | |
246 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | |
247 | ||
ba020ef5 | 248 | 'git-cvsserver' uses the Perl DBI module. Please also read |
febe7dcc FL |
249 | its documentation if changing these variables, especially |
250 | about `DBI->connect()`. | |
251 | ||
252 | gitcvs.dbname:: | |
253 | Database name. The exact meaning depends on the | |
a5d86f74 | 254 | selected database driver, for SQLite this is a filename. |
febe7dcc FL |
255 | Supports variable substitution (see below). May |
256 | not contain semicolons (`;`). | |
257 | Default: '%Ggitcvs.%m.sqlite' | |
258 | ||
259 | gitcvs.dbdriver:: | |
260 | Used DBI driver. You can specify any available driver | |
261 | for this here, but it might not work. cvsserver is tested | |
262 | with 'DBD::SQLite', reported to work with | |
263 | 'DBD::Pg', and reported *not* to work with 'DBD::mysql'. | |
264 | Please regard this as an experimental feature. May not | |
a5d86f74 | 265 | contain colons (`:`). |
febe7dcc FL |
266 | Default: 'SQLite' |
267 | ||
268 | gitcvs.dbuser:: | |
269 | Database user. Only useful if setting `dbdriver`, since | |
270 | SQLite has no concept of database users. Supports variable | |
271 | substitution (see below). | |
272 | ||
273 | gitcvs.dbpass:: | |
274 | Database password. Only useful if setting `dbdriver`, since | |
275 | SQLite has no concept of database passwords. | |
276 | ||
6aeeffd1 JE |
277 | gitcvs.dbTableNamePrefix:: |
278 | Database table name prefix. Supports variable substitution | |
279 | (see below). Any non-alphabetic characters will be replaced | |
280 | with underscores. | |
281 | ||
febe7dcc FL |
282 | All variables can also be set per access method, see <<configaccessmethod,above>>. |
283 | ||
284 | Variable substitution | |
285 | ^^^^^^^^^^^^^^^^^^^^^ | |
286 | In `dbdriver` and `dbuser` you can use the following variables: | |
287 | ||
288 | %G:: | |
289 | git directory name | |
290 | %g:: | |
291 | git directory name, where all characters except for | |
292 | alpha-numeric ones, `.`, and `-` are replaced with | |
293 | `_` (this should make it easier to use the directory | |
294 | name in a filename if wanted) | |
295 | %m:: | |
296 | CVS module/git head name | |
297 | %a:: | |
298 | access method (one of "ext" or "pserver") | |
299 | %u:: | |
ba020ef5 | 300 | Name of the user running 'git-cvsserver'. |
febe7dcc FL |
301 | If no name can be determined, the |
302 | numeric uid is used. | |
303 | ||
03bd0d60 PM |
304 | ENVIRONMENT |
305 | ----------- | |
306 | ||
307 | These variables obviate the need for command-line options in some | |
308 | circumstances, allowing easier restricted usage through git-shell. | |
309 | ||
310 | GIT_CVSSERVER_BASE_PATH takes the place of the argument to --base-path. | |
311 | ||
312 | GIT_CVSSERVER_ROOT specifies a single-directory whitelist. The | |
313 | repository must still be configured to allow access through | |
314 | git-cvsserver, as described above. | |
315 | ||
316 | When these environment variables are set, the corresponding | |
317 | command-line arguments may not be used. | |
318 | ||
ee75d4cd ML |
319 | Eclipse CVS Client Notes |
320 | ------------------------ | |
321 | ||
322 | To get a checkout with the Eclipse CVS client: | |
323 | ||
b30cc0da ML |
324 | 1. Select "Create a new project -> From CVS checkout" |
325 | 2. Create a new location. See the notes below for details on how to choose the | |
326 | right protocol. | |
327 | 3. Browse the 'modules' available. It will give you a list of the heads in | |
328 | the repository. You will not be able to browse the tree from there. Only | |
329 | the heads. | |
330 | 4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the | |
331 | "launch commit wizard" to avoid committing the .project file. | |
332 | ||
abda1ef5 | 333 | Protocol notes: If you are using anonymous access via pserver, just select that. |
b30cc0da ML |
334 | Those using SSH access should choose the 'ext' protocol, and configure 'ext' |
335 | access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to | |
ca768288 | 336 | "`git cvsserver`". Note that password support is not good when using 'ext', |
b30cc0da ML |
337 | you will definitely want to have SSH keys setup. |
338 | ||
339 | Alternatively, you can just use the non-standard extssh protocol that Eclipse | |
340 | offer. In that case CVS_SERVER is ignored, and you will have to replace | |
ba020ef5 JN |
341 | the cvs utility on the server with 'git-cvsserver' or manipulate your `.bashrc` |
342 | so that calling 'cvs' effectively calls 'git-cvsserver'. | |
ee75d4cd ML |
343 | |
344 | Clients known to work | |
345 | --------------------- | |
346 | ||
ad0f8c9e FL |
347 | - CVS 1.12.9 on Debian |
348 | - CVS 1.11.17 on MacOSX (from Fink package) | |
349 | - Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes) | |
350 | - TortoiseCVS | |
ee75d4cd | 351 | |
3fda8c4c ML |
352 | Operations supported |
353 | -------------------- | |
354 | ||
355 | All the operations required for normal use are supported, including | |
356 | checkout, diff, status, update, log, add, remove, commit. | |
357 | Legacy monitoring operations are not supported (edit, watch and related). | |
358 | Exports and tagging (tags and branches) are not supported at this stage. | |
359 | ||
8a06a632 | 360 | CRLF Line Ending Conversions |
b592d88f | 361 | ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
8a06a632 MO |
362 | |
363 | By default the server leaves the '-k' mode blank for all files, | |
364 | which causes the cvs client to treat them as a text files, subject | |
365 | to crlf conversion on some platforms. | |
366 | ||
367 | You can make the server use `crlf` attributes to set the '-k' modes | |
368 | for files by setting the `gitcvs.usecrlfattr` config variable. | |
369 | In this case, if `crlf` is explicitly unset ('-crlf'), then the | |
90948a42 | 370 | server will set '-kb' mode for binary files. If `crlf` is set, |
8a06a632 MO |
371 | then the '-k' mode will explicitly be left blank. See |
372 | also linkgit:gitattributes[5] for more information about the `crlf` | |
373 | attribute. | |
374 | ||
375 | Alternatively, if `gitcvs.usecrlfattr` config is not enabled | |
376 | or if the `crlf` attribute is unspecified for a filename, then | |
90948a42 MO |
377 | the server uses the `gitcvs.allbinary` config for the default setting. |
378 | If `gitcvs.allbinary` is set, then file not otherwise | |
8a06a632 | 379 | specified will default to '-kb' mode. Otherwise the '-k' mode |
90948a42 MO |
380 | is left blank. But if `gitcvs.allbinary` is set to "guess", then |
381 | the correct '-k' mode will be guessed based on the contents of | |
382 | the file. | |
383 | ||
2fd02c92 | 384 | For best consistency with 'cvs', it is probably best to override the |
90948a42 MO |
385 | defaults by setting `gitcvs.usecrlfattr` to true, |
386 | and `gitcvs.allbinary` to "guess". | |
3fda8c4c ML |
387 | |
388 | Dependencies | |
389 | ------------ | |
ba020ef5 | 390 | 'git-cvsserver' depends on DBD::SQLite. |
3fda8c4c ML |
391 | |
392 | Copyright and Authors | |
393 | --------------------- | |
394 | ||
395 | This program is copyright The Open University UK - 2006. | |
396 | ||
ad0f8c9e FL |
397 | Authors: |
398 | ||
399 | - Martyn Smith <martyn@catalyst.net.nz> | |
400 | - Martin Langhoff <martin@catalyst.net.nz> | |
401 | ||
402 | with ideas and patches from participants of the git-list <git@vger.kernel.org>. | |
3fda8c4c ML |
403 | |
404 | Documentation | |
405 | -------------- | |
ad0f8c9e | 406 | Documentation by Martyn Smith <martyn@catalyst.net.nz>, Martin Langhoff <martin@catalyst.net.nz>, and Matthias Urlichs <smurf@smurf.noris.de>. |
3fda8c4c ML |
407 | |
408 | GIT | |
409 | --- | |
9e1f0a85 | 410 | Part of the linkgit:git[1] suite |