README

   1 This is the duct tape that ties repo.or.cz together. You will find
   2 some hardcoded paths inside, and some other kludgy stuff.
   3
   4 The user interface is kept in the cgi/ subdirectory (repo.or.cz/m/ is symlink
   5 to that).
   6
   7 There are two modes of operation for each project: hosting and mirroring.
   8
   9
  10 Hosting mode
  11 ------------
  12
  13 (All uids and gids are allocated from range 65536..infty. All passwords are
  14 stored in DES crypt(3) format because Apache is moronic - in the past the group
  15 file was also used as htpasswd file.)
  16
  17
  18 This is how the push access is provided:
  19
  20 The whole setup is confined in a chroot with its own instance of sshd running.
  21 The chroot looks like:
  22
  23         /bin/sh
  24         /bin/git-shell
  25         /bin/git-upload-pack
  26         /bin/git-receive-pack
  27         /bin/git-rev-list
  28         /bin/git-pack-objects
  29         /bin/git-unpack-objects
  30         /bin/git-update-server-info
  31         /bin/git-repack
  32         /sbin/sshd
  33         /dev/randomstuff
  34         /lib/randomstuff
  35         /var/empty
  36         /var/run/mob
  37         /srv/git/...
  38         /etc/group
  39         /etc/passwd
  40         /etc/sshkeys/*
  41         /etc/ssh/randomstuff
  42
  43 There is a (non-chroot) system user 'repo' and a group of the same name (the
  44 webserver is member of the group; TODO: suexec). The files in /etc are owned
  45 by repo.repo and group-writable, as well as all files in /srv/git/*/ but
  46 refs/**, info/**, and objects/** which are repo.project. /var/run/mob has zero
  47 permissions bits but is owned by the mob user.
  48
  49
  50 When you register a project, it will get a gid allocation and you will set a
  51 password for it. The triple is stored in a group(5) file (but containing just
  52 the project groups):
  53
  54         projname:crypt:gid:list,of,users
  55
  56 When you register a user, it will get a uid allocation and you will upload
  57 an ssh public key for it. The user is stored in a passwd(5) file (but
  58 containing just the repo.or.cz users; 65534 is nogroup):
  59
  60         username:x:uid:65534:email:/:/bin/git-shell
  61
  62 The authorized keys are stored in /etc/sshkeys/username.
  63
  64 When you (un)assign user to a project, you just manipulate the list of users
  65 for the project in /etc/group. The web interface for the project administration
  66 is protected by the group password; chroot/etc/group is used as the htpasswd
  67 file here.
  68
  69 Since Apache is not in the project groups, there is a special cronjob run
  70 every minute to fix up the permissions for the refs/, info/, and objects/
  71 project directories, under the root user.
  72
  73
  74 Mirror mode
  75 -----------
  76
  77 To keep things safe and neat, repo.or.cz is job-controlled: the only thing the
  78 cgi script does is scheduling a clone job (by creating a directory with some
  79 files at a magic location) and then the clonecheck.sh script is invoked every
  80 minute by cron (under more reasonable uid) to check if there are any jobs
  81 scheduled, and calls clone.sh to do the clone itself, notifying the user about
  82 the results.
  83
  84 The script that keeps repositories up-to-date is updatecheck.sh, being run
  85 by cron every hour and calling update.sh for all the relevant repositories.
  86
  87 updateglibc.sh stands somewhat out of the crowd and keeps the Git mirror of
  88 the glibc CVS repository up-to-date, so it's probably not interesting for
  89 anyone.
  90
  91 To make sure a project is not pushable when in mirror mode, the last colon
  92 in the /etc/group entry for the project is doubled.