Sync with 2.38.5
[git/debian.git] / Documentation / git-cvsserver.txt
blob53f111bc0acaf08a0a208501a32973cd420d0b35
1 git-cvsserver(1)
2 ================
4 NAME
5 ----
6 git-cvsserver - A CVS server emulator for Git
8 SYNOPSIS
9 --------
11 SSH:
13 [verse]
14 export CVS_SERVER="git cvsserver"
15 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name>
17 pserver (/etc/inetd.conf):
19 [verse]
20 cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
22 Usage:
24 [verse]
25 'git-cvsserver' [<options>] [pserver|server] [<directory> ...]
27 DESCRIPTION
28 -----------
30 This application is a CVS emulation layer for Git.
32 It is highly functional. However, not all methods are implemented,
33 and for those methods that are implemented,
34 not all switches are implemented.
36 Testing has been done using both the CLI CVS client, and the Eclipse CVS
37 plugin. Most functionality works fine with both of these clients.
39 OPTIONS
40 -------
42 All these options obviously only make sense if enforced by the server side.
43 They have been implemented to resemble the linkgit:git-daemon[1] options as
44 closely as possible.
46 --base-path <path>::
47 Prepend 'path' to requested CVSROOT
49 --strict-paths::
50 Don't allow recursing into subdirectories
52 --export-all::
53 Don't check for `gitcvs.enabled` in config. You also have to specify a list
54 of allowed directories (see below) if you want to use this option.
56 -V::
57 --version::
58 Print version information and exit
60 -h::
61 -H::
62 --help::
63 Print usage information and exit
65 <directory>::
66 The remaining arguments provide a list of directories. If no directories
67 are given, then all are allowed. Repositories within these directories
68 still require the `gitcvs.enabled` config option, unless `--export-all`
69 is specified.
71 LIMITATIONS
72 -----------
74 CVS clients cannot tag, branch or perform Git merges.
76 'git-cvsserver' maps Git branches to CVS modules. This is very different
77 from what most CVS users would expect since in CVS modules usually represent
78 one or more directories.
80 INSTALLATION
81 ------------
83 1. If you are going to offer CVS access via pserver, add a line in
84    /etc/inetd.conf like
87 ------
88    cvspserver stream tcp nowait nobody git-cvsserver pserver
90 ------
91 Note: Some inetd servers let you specify the name of the executable
92 independently of the value of argv[0] (i.e. the name the program assumes
93 it was executed with). In this case the correct line in /etc/inetd.conf
94 looks like
96 ------
97    cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
99 ------
101 Only anonymous access is provided by pserver by default. To commit you
102 will have to create pserver accounts, simply add a gitcvs.authdb
103 setting in the config file of the repositories you want the cvsserver
104 to allow writes to, for example:
106 ------
108    [gitcvs]
109         authdb = /etc/cvsserver/passwd
111 ------
112 The format of these files is username followed by the encrypted password,
113 for example:
115 ------
116    myuser:sqkNi8zPf01HI
117    myuser:$1$9K7FzU28$VfF6EoPYCJEYcVQwATgOP/
118    myuser:$5$.NqmNH1vwfzGpV8B$znZIcumu1tNLATgV2l6e1/mY8RzhUDHMOaVOeL1cxV3
119 ------
120 You can use the 'htpasswd' facility that comes with Apache to make these
121 files, but only with the -d option (or -B if your system suports it).
123 Preferably use the system specific utility that manages password hash
124 creation in your platform (e.g. mkpasswd in Linux, encrypt in OpenBSD or
125 pwhash in NetBSD) and paste it in the right location.
127 Then provide your password via the pserver method, for example:
128 ------
129    cvs -d:pserver:someuser:somepassword@server:/path/repo.git co <HEAD_name>
130 ------
131 No special setup is needed for SSH access, other than having Git tools
132 in the PATH. If you have clients that do not accept the CVS_SERVER
133 environment variable, you can rename 'git-cvsserver' to `cvs`.
135 Note: Newer CVS versions (>= 1.12.11) also support specifying
136 CVS_SERVER directly in CVSROOT like
138 ------
139    cvs -d ":ext;CVS_SERVER=git cvsserver:user@server/path/repo.git" co <HEAD_name>
140 ------
141 This has the advantage that it will be saved in your 'CVS/Root' files and
142 you don't need to worry about always setting the correct environment
143 variable.  SSH users restricted to 'git-shell' don't need to override the default
144 with CVS_SERVER (and shouldn't) as 'git-shell' understands `cvs` to mean
145 'git-cvsserver' and pretends that the other end runs the real 'cvs' better.
147 2. For each repo that you want accessible from CVS you need to edit config in
148    the repo and add the following section.
151 ------
152    [gitcvs]
153         enabled=1
154         # optional for debugging
155         logFile=/path/to/logfile
157 ------
158 Note: you need to ensure each user that is going to invoke 'git-cvsserver' has
159 write access to the log file and to the database (see
160 <<dbbackend,Database Backend>>. If you want to offer write access over
161 SSH, the users of course also need write access to the Git repository itself.
163 You also need to ensure that each repository is "bare" (without a Git index
164 file) for `cvs commit` to work. See linkgit:gitcvs-migration[7].
166 [[configaccessmethod]]
167 All configuration variables can also be overridden for a specific method of
168 access. Valid method names are "ext" (for SSH access) and "pserver". The
169 following example configuration would disable pserver access while still
170 allowing access over SSH.
171 ------
172    [gitcvs]
173         enabled=0
175    [gitcvs "ext"]
176         enabled=1
177 ------
179 3. If you didn't specify the CVSROOT/CVS_SERVER directly in the checkout command,
180    automatically saving it in your 'CVS/Root' files, then you need to set them
181    explicitly in your environment.  CVSROOT should be set as per normal, but the
182    directory should point at the appropriate Git repo.  As above, for SSH clients
183    _not_ restricted to 'git-shell', CVS_SERVER should be set to 'git-cvsserver'.
186 ------
187    export CVSROOT=:ext:user@server:/var/git/project.git
188    export CVS_SERVER="git cvsserver"
189 ------
191 4. For SSH clients that will make commits, make sure their server-side
192    .ssh/environment files (or .bashrc, etc., according to their specific shell)
193    export appropriate values for GIT_AUTHOR_NAME, GIT_AUTHOR_EMAIL,
194    GIT_COMMITTER_NAME, and GIT_COMMITTER_EMAIL.  For SSH clients whose login
195    shell is bash, .bashrc may be a reasonable alternative.
197 5. Clients should now be able to check out the project. Use the CVS 'module'
198    name to indicate what Git 'head' you want to check out.  This also sets the
199    name of your newly checked-out directory, unless you tell it otherwise with
200    `-d <dir_name>`.  For example, this checks out 'master' branch to the
201    `project-master` directory:
203 ------
204    cvs co -d project-master master
205 ------
207 [[dbbackend]]
208 DATABASE BACKEND
209 ----------------
211 'git-cvsserver' uses one database per Git head (i.e. CVS module) to
212 store information about the repository to maintain consistent
213 CVS revision numbers. The database needs to be
214 updated (i.e. written to) after every commit.
216 If the commit is done directly by using `git` (as opposed to
217 using 'git-cvsserver') the update will need to happen on the
218 next repository access by 'git-cvsserver', independent of
219 access method and requested operation.
221 That means that even if you offer only read access (e.g. by using
222 the pserver method), 'git-cvsserver' should have write access to
223 the database to work reliably (otherwise you need to make sure
224 that the database is up to date any time 'git-cvsserver' is executed).
226 By default it uses SQLite databases in the Git directory, named
227 `gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates
228 temporary files in the same directory as the database file on
229 write so it might not be enough to grant the users using
230 'git-cvsserver' write access to the database file without granting
231 them write access to the directory, too.
233 The database cannot be reliably regenerated in a
234 consistent form after the branch it is tracking has changed.
235 Example: For merged branches, 'git-cvsserver' only tracks
236 one branch of development, and after a 'git merge' an
237 incrementally updated database may track a different branch
238 than a database regenerated from scratch, causing inconsistent
239 CVS revision numbers. `git-cvsserver` has no way of knowing which
240 branch it would have picked if it had been run incrementally
241 pre-merge. So if you have to fully or partially (from old
242 backup) regenerate the database, you should be suspicious
243 of pre-existing CVS sandboxes.
245 You can configure the database backend with the following
246 configuration variables:
248 Configuring database backend
249 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
251 'git-cvsserver' uses the Perl DBI module. Please also read
252 its documentation if changing these variables, especially
253 about `DBI->connect()`.
255 gitcvs.dbName::
256         Database name. The exact meaning depends on the
257         selected database driver, for SQLite this is a filename.
258         Supports variable substitution (see below). May
259         not contain semicolons (`;`).
260         Default: '%Ggitcvs.%m.sqlite'
262 gitcvs.dbDriver::
263         Used DBI driver. You can specify any available driver
264         for this here, but it might not work. cvsserver is tested
265         with 'DBD::SQLite', reported to work with
266         'DBD::Pg', and reported *not* to work with 'DBD::mysql'.
267         Please regard this as an experimental feature. May not
268         contain colons (`:`).
269         Default: 'SQLite'
271 gitcvs.dbuser::
272         Database user. Only useful if setting `dbDriver`, since
273         SQLite has no concept of database users. Supports variable
274         substitution (see below).
276 gitcvs.dbPass::
277         Database password.  Only useful if setting `dbDriver`, since
278         SQLite has no concept of database passwords.
280 gitcvs.dbTableNamePrefix::
281         Database table name prefix.  Supports variable substitution
282         (see below).  Any non-alphabetic characters will be replaced
283         with underscores.
285 All variables can also be set per access method, see <<configaccessmethod,above>>.
287 Variable substitution
288 ^^^^^^^^^^^^^^^^^^^^^
289 In `dbDriver` and `dbUser` you can use the following variables:
291 %G::
292         Git directory name
293 %g::
294         Git directory name, where all characters except for
295         alphanumeric ones, `.`, and `-` are replaced with
296         `_` (this should make it easier to use the directory
297         name in a filename if wanted)
298 %m::
299         CVS module/Git head name
300 %a::
301         access method (one of "ext" or "pserver")
302 %u::
303         Name of the user running 'git-cvsserver'.
304         If no name can be determined, the
305         numeric uid is used.
307 ENVIRONMENT
308 -----------
310 These variables obviate the need for command-line options in some
311 circumstances, allowing easier restricted usage through git-shell.
313 GIT_CVSSERVER_BASE_PATH::
314         This variable replaces the argument to --base-path.
316 GIT_CVSSERVER_ROOT::
317         This variable specifies a single directory, replacing the
318         `<directory>...` argument list. The repository still requires the
319         `gitcvs.enabled` config option, unless `--export-all` is specified.
321 When these environment variables are set, the corresponding
322 command-line arguments may not be used.
324 ECLIPSE CVS CLIENT NOTES
325 ------------------------
327 To get a checkout with the Eclipse CVS client:
329 1. Select "Create a new project -> From CVS checkout"
330 2. Create a new location. See the notes below for details on how to choose the
331    right protocol.
332 3. Browse the 'modules' available. It will give you a list of the heads in
333    the repository. You will not be able to browse the tree from there. Only
334    the heads.
335 4. Pick `HEAD` when it asks what branch/tag to check out. Untick the
336    "launch commit wizard" to avoid committing the .project file.
338 Protocol notes: If you are using anonymous access via pserver, just select that.
339 Those using SSH access should choose the 'ext' protocol, and configure 'ext'
340 access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
341 "`git cvsserver`". Note that password support is not good when using 'ext',
342 you will definitely want to have SSH keys setup.
344 Alternatively, you can just use the non-standard extssh protocol that Eclipse
345 offer. In that case CVS_SERVER is ignored, and you will have to replace
346 the cvs utility on the server with 'git-cvsserver' or manipulate your `.bashrc`
347 so that calling 'cvs' effectively calls 'git-cvsserver'.
349 CLIENTS KNOWN TO WORK
350 ---------------------
352 - CVS 1.12.9 on Debian
353 - CVS 1.11.17 on MacOSX (from Fink package)
354 - Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
355 - TortoiseCVS
357 OPERATIONS SUPPORTED
358 --------------------
360 All the operations required for normal use are supported, including
361 checkout, diff, status, update, log, add, remove, commit.
363 Most CVS command arguments that read CVS tags or revision numbers
364 (typically -r) work, and also support any git refspec
365 (tag, branch, commit ID, etc).
366 However, CVS revision numbers for non-default branches are not well
367 emulated, and cvs log does not show tags or branches at
368 all.  (Non-main-branch CVS revision numbers superficially resemble CVS
369 revision numbers, but they actually encode a git commit ID directly,
370 rather than represent the number of revisions since the branch point.)
372 Note that there are two ways to checkout a particular branch.
373 As described elsewhere on this page, the "module" parameter
374 of cvs checkout is interpreted as a branch name, and it becomes
375 the main branch.  It remains the main branch for a given sandbox
376 even if you temporarily make another branch sticky with
377 cvs update -r.  Alternatively, the -r argument can indicate
378 some other branch to actually checkout, even though the module
379 is still the "main" branch.  Tradeoffs (as currently
380 implemented): Each new "module" creates a new database on disk with
381 a history for the given module, and after the database is created,
382 operations against that main branch are fast.  Or alternatively,
383 -r doesn't take any extra disk space, but may be significantly slower for
384 many operations, like cvs update.
386 If you want to refer to a git refspec that has characters that are
387 not allowed by CVS, you have two options.  First, it may just work
388 to supply the git refspec directly to the appropriate CVS -r argument;
389 some CVS clients don't seem to do much sanity checking of the argument.
390 Second, if that fails, you can use a special character escape mechanism
391 that only uses characters that are valid in CVS tags.  A sequence
392 of 4 or 5 characters of the form (underscore (`"_"`), dash (`"-"`),
393 one or two characters, and dash (`"-"`)) can encode various characters based
394 on the one or two letters: `"s"` for slash (`"/"`), `"p"` for
395 period (`"."`), `"u"` for underscore (`"_"`), or two hexadecimal digits
396 for any byte value at all (typically an ASCII number, or perhaps a part
397 of a UTF-8 encoded character).
399 Legacy monitoring operations are not supported (edit, watch and related).
400 Exports and tagging (tags and branches) are not supported at this stage.
402 CRLF Line Ending Conversions
403 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
405 By default the server leaves the `-k` mode blank for all files,
406 which causes the CVS client to treat them as a text files, subject
407 to end-of-line conversion on some platforms.
409 You can make the server use the end-of-line conversion attributes to
410 set the `-k` modes for files by setting the `gitcvs.usecrlfattr`
411 config variable.  See linkgit:gitattributes[5] for more information
412 about end-of-line conversion.
414 Alternatively, if `gitcvs.usecrlfattr` config is not enabled
415 or the attributes do not allow automatic detection for a filename, then
416 the server uses the `gitcvs.allBinary` config for the default setting.
417 If `gitcvs.allBinary` is set, then file not otherwise
418 specified will default to '-kb' mode. Otherwise the `-k` mode
419 is left blank. But if `gitcvs.allBinary` is set to "guess", then
420 the correct `-k` mode will be guessed based on the contents of
421 the file.
423 For best consistency with 'cvs', it is probably best to override the
424 defaults by setting `gitcvs.usecrlfattr` to true,
425 and `gitcvs.allBinary` to "guess".
427 DEPENDENCIES
428 ------------
429 'git-cvsserver' depends on DBD::SQLite.
433 Part of the linkgit:git[1] suite