Documentation/git-cvsserver.txt

   1 git-cvsserver(1)
   2 ================
   3
   4 NAME
   5 ----
   6 git-cvsserver - A CVS server emulator for git
   7
   8 SYNOPSIS
   9 --------
  10 [verse]
  11 export CVS_SERVER=git-cvsserver
  12 'cvs' -d :ext:user@server/path/repo.git co <HEAD_name>
  13
  14 DESCRIPTION
  15 -----------
  16
  17 This application is a CVS emulation layer for git.
  18
  19 It is highly functional. However, not all methods are implemented,
  20 and for those methods that are implemented,
  21 not all switches are implemented.
  22
  23 Testing has been done using both the CLI CVS client, and the Eclipse CVS
  24 plugin. Most functionality works fine with both of these clients.
  25
  26 LIMITATIONS
  27 -----------
  28
  29 Currently cvsserver works over SSH connections for read/write clients, and
  30 over pserver for anonymous CVS access.
  31
  32 CVS clients cannot tag, branch or perform GIT merges.
  33
  34 git-cvsserver maps GIT branches to CVS modules. This is very different
  35 from what most CVS users would expect since in CVS modules usually represent
  36 one or more directories.
  37
  38 INSTALLATION
  39 ------------
  40
  41 1. If you are going to offer anonymous CVS access via pserver, add a line in
  42    /etc/inetd.conf like
  43 +
  44 --
  45 ------
  46    cvspserver stream tcp nowait nobody git-cvsserver pserver
  47
  48 ------
  49 Note: Some inetd servers let you specify the name of the executable
  50 independently of the value of argv[0] (i.e. the name the program assumes
  51 it was executed with). In this case the correct line in /etc/inetd.conf
  52 looks like
  53
  54 ------
  55    cvspserver stream tcp nowait nobody /usr/bin/git-cvsserver git-cvsserver pserver
  56
  57 ------
  58 No special setup is needed for SSH access, other than having GIT tools
  59 in the PATH. If you have clients that do not accept the CVS_SERVER
  60 environment variable, you can rename git-cvsserver to cvs.
  61
  62 Note: Newer cvs versions (>= 1.12.11) also support specifying
  63 CVS_SERVER directly in CVSROOT like
  64
  65 ------
  66 cvs -d ":ext;CVS_SERVER=git-cvsserver:user@server/path/repo.git" co <HEAD_name>
  67 ------
  68 This has the advantage that it will be saved in your 'CVS/Root' files and
  69 you don't need to worry about always setting the correct environment
  70 variable.
  71 --
  72 2. For each repo that you want accessible from CVS you need to edit config in
  73    the repo and add the following section.
  74 +
  75 --
  76 ------
  77    [gitcvs]
  78         enabled=1
  79         # optional for debugging
  80         logfile=/path/to/logfile
  81
  82 ------
  83 Note: you need to ensure each user that is going to invoke git-cvsserver has
  84 write access to the log file and to the database (see
  85 <<dbbackend,Database Backend>>. If you want to offer write access over
  86 SSH, the users of course also need write access to the git repository itself.
  87
  88 [[configaccessmethod]]
  89 All configuration variables can also be overridden for a specific method of
  90 access. Valid method names are "ext" (for SSH access) and "pserver". The
  91 following example configuration would disable pserver access while still
  92 allowing access over SSH.
  93 ------
  94    [gitcvs]
  95         enabled=0
  96
  97    [gitcvs "ext"]
  98         enabled=1
  99 ------
 100 --
 101 3. On the client machine you need to set the following variables.
 102    CVSROOT should be set as per normal, but the directory should point at the
 103    appropriate git repo. For example:
 104 +
 105 --
 106 For SSH access, CVS_SERVER should be set to git-cvsserver
 107
 108 Example:
 109
 110 ------
 111      export CVSROOT=:ext:user@server:/var/git/project.git
 112      export CVS_SERVER=git-cvsserver
 113 ------
 114 --
 115 4. For SSH clients that will make commits, make sure their .bashrc file
 116    sets the GIT_AUTHOR and GIT_COMMITTER variables.
 117
 118 5. Clients should now be able to check out the project. Use the CVS 'module'
 119    name to indicate what GIT 'head' you want to check out. Example:
 120 +
 121 ------
 122      cvs co -d project-master master
 123 ------
 124
 125 [[dbbackend]]
 126 Database Backend
 127 ----------------
 128
 129 git-cvsserver uses one database per git head (i.e. CVS module) to
 130 store information about the repository for faster access. The
 131 database doesn't contain any persistent data and can be completely
 132 regenerated from the git repository at any time. The database
 133 needs to be updated (i.e. written to) after every commit.
 134
 135 If the commit is done directly by using git (as opposed to
 136 using git-cvsserver) the update will need to happen on the
 137 next repository access by git-cvsserver, independent of
 138 access method and requested operation.
 139
 140 That means that even if you offer only read access (e.g. by using
 141 the pserver method), git-cvsserver should have write access to
 142 the database to work reliably (otherwise you need to make sure
 143 that the database if up-to-date all the time git-cvsserver is run).
 144
 145 By default it uses SQLite databases in the git directory, named
 146 `gitcvs.<module_name>.sqlite`. Note that the SQLite backend creates
 147 temporary files in the same directory as the database file on
 148 write so it might not be enough to grant the users using
 149 git-cvsserver write access to the database file without granting
 150 them write access to the directory, too.
 151
 152 You can configure the database backend with the following
 153 configuration variables:
 154
 155 Configuring database backend
 156 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 157
 158 git-cvsserver uses the Perl DBI module. Please also read
 159 its documentation if changing these variables, especially
 160 about `DBI->connect()`.
 161
 162 gitcvs.dbname::
 163         Database name. The exact meaning depends on the
 164         used database driver, for SQLite this is a filename.
 165         Supports variable substitution (see below). May
 166         not contain semicolons (`;`).
 167         Default: '%Ggitcvs.%m.sqlite'
 168
 169 gitcvs.dbdriver::
 170         Used DBI driver. You can specify any available driver
 171         for this here, but it might not work. cvsserver is tested
 172         with 'DBD::SQLite', reported to work with
 173         'DBD::Pg', and reported *not* to work with 'DBD::mysql'.
 174         Please regard this as an experimental feature. May not
 175         contain double colons (`:`).
 176         Default: 'SQLite'
 177
 178 gitcvs.dbuser::
 179         Database user. Only useful if setting `dbdriver`, since
 180         SQLite has no concept of database users. Supports variable
 181         substitution (see below).
 182
 183 gitcvs.dbpass::
 184         Database password.  Only useful if setting `dbdriver`, since
 185         SQLite has no concept of database passwords.
 186
 187 All variables can also be set per access method, see <<configaccessmethod,above>>.
 188
 189 Variable substitution
 190 ^^^^^^^^^^^^^^^^^^^^^
 191 In `dbdriver` and `dbuser` you can use the following variables:
 192
 193 %G::
 194         git directory name
 195 %g::
 196         git directory name, where all characters except for
 197         alpha-numeric ones, `.`, and `-` are replaced with
 198         `_` (this should make it easier to use the directory
 199         name in a filename if wanted)
 200 %m::
 201         CVS module/git head name
 202 %a::
 203         access method (one of "ext" or "pserver")
 204 %u::
 205         Name of the user running git-cvsserver.
 206         If no name can be determined, the
 207         numeric uid is used.
 208
 209 Eclipse CVS Client Notes
 210 ------------------------
 211
 212 To get a checkout with the Eclipse CVS client:
 213
 214 1. Select "Create a new project -> From CVS checkout"
 215 2. Create a new location. See the notes below for details on how to choose the
 216    right protocol.
 217 3. Browse the 'modules' available. It will give you a list of the heads in
 218    the repository. You will not be able to browse the tree from there. Only
 219    the heads.
 220 4. Pick 'HEAD' when it asks what branch/tag to check out. Untick the
 221    "launch commit wizard" to avoid committing the .project file.
 222
 223 Protocol notes: If you are using anonymous access via pserver, just select that.
 224 Those using SSH access should choose the 'ext' protocol, and configure 'ext'
 225 access on the Preferences->Team->CVS->ExtConnection pane. Set CVS_SERVER to
 226 'git-cvsserver'. Note that password support is not good when using 'ext',
 227 you will definitely want to have SSH keys setup.
 228
 229 Alternatively, you can just use the non-standard extssh protocol that Eclipse
 230 offer. In that case CVS_SERVER is ignored, and you will have to replace
 231 the cvs utility on the server with git-cvsserver or manipulate your `.bashrc`
 232 so that calling 'cvs' effectively calls git-cvsserver.
 233
 234 Clients known to work
 235 ---------------------
 236
 237 - CVS 1.12.9 on Debian
 238 - CVS 1.11.17 on MacOSX (from Fink package)
 239 - Eclipse 3.0, 3.1.2 on MacOSX (see Eclipse CVS Client Notes)
 240 - TortoiseCVS
 241
 242 Operations supported
 243 --------------------
 244
 245 All the operations required for normal use are supported, including
 246 checkout, diff, status, update, log, add, remove, commit.
 247 Legacy monitoring operations are not supported (edit, watch and related).
 248 Exports and tagging (tags and branches) are not supported at this stage.
 249
 250 The server should set the '-k' mode to binary when relevant, however,
 251 this is not really implemented yet. For now, you can force the server
 252 to set '-kb' for all files by setting the `gitcvs.allbinary` config
 253 variable. In proper GIT tradition, the contents of the files are
 254 always respected. No keyword expansion or newline munging is supported.
 255
 256 Dependencies
 257 ------------
 258
 259 git-cvsserver depends on DBD::SQLite.
 260
 261 Copyright and Authors
 262 ---------------------
 263
 264 This program is copyright The Open University UK - 2006.
 265
 266 Authors:
 267
 268 - Martyn Smith    <martyn@catalyst.net.nz>
 269 - Martin Langhoff <martin@catalyst.net.nz>
 270
 271 with ideas and patches from participants of the git-list <git@vger.kernel.org>.
 272
 273 Documentation
 274 --------------
 275 Documentation by Martyn Smith <martyn@catalyst.net.nz>, Martin Langhoff <martin@catalyst.net.nz>, and Matthias Urlichs <smurf@smurf.noris.de>.
 276
 277 GIT
 278 ---
 279 Part of the gitlink:git[7] suite