docs/files.mkd

   1 # gitolite files and directories
   2
   3 ----
   4
   5 # directories
   6
   7 Gitolite creates and uses the following files and directories:
   8
   9   * `~/repositories` -- the actual (bare) repositories are here
  10   * `~/.gitolite.rc` -- configuration parameters that must be done directly on
  11     the server
  12   * `~/.gitolite` -- gitolite's "working" directory.  This contains everything
  13     else that gitolite needs.  (Warning: you're not supposed to fiddle with
  14     the files and directories within; instead, make changes in a clone of the
  15     gitolite-admin repository and push, and those appear magically here).
  16
  17 Once the install/setup is done, any (or all) of these may be moved
  18 elsewhere and replaced by symlinks.  The most common reason for
  19 locating `~/repositories` somewhere else is disk space, but FHS
  20 compliance could also be a reason.
  21
  22 In addition, the following are of interest:
  23
  24   * `~/.ssh` -- if you're using ssh (as opposed to http), since this is where
  25     the `authorized_keys` file is kept
  26
  27 # special files
  28
  29 You may want to backup the contents of `~/.gitolite/logs` if you care about
  30 auditability etc.
  31
  32 # inside a "gitolite repo"
  33
  34 A gitolite repo is just like a normal bare repo on any normal git server.
  35 There are a few extra files placed in the repo directory whose names start
  36 with "gl-", and there is also an update hook placed in the hooks subdirectory,
  37 but that's about it, for the most part.
  38
  39 In other words, you can treat a gitolite-managed repo just like any other bare
  40 repo as long as you leave those files alone.
  41
  42 # gitolite software
  43
  44 The above list does not include the gitolite software itself.
  45
  46 Gitolite offers you 3 ways to install software.  After cloning the gitolite
  47 sources, run the install command in it with a `-h` argument to see what they
  48 are.  Where the actual software is found depends on that.
  49