options.mkd

   1 <!-- options: toc -->
   2
   3 % gitolite options
   4
   5 include sidebar-toc
   6
   7 Some gitolite features are enabled, or gitolite's behaviour changed, by
   8 setting "options".
   9
  10 A line like 'option foo = 1' is really just syntactic sugar for 'config
  11 gitolite-options.foo = 1', so everything in the [git-config][] page also
  12 applies here (especially the bit about [overriding config
  13 values][override_conf]).
  14
  15 **However**, these values are **not** written into git's own `config` file, so
  16 git (or other programs running `git config`) will not see them.  You can only
  17 query them using `gitolite git-config`, where they will appear in full in the
  18 output.
  19
  20 Options are set by repo.  The syntax is very simple:
  21
  22 .#! conf/vim-color
  23     option  foo.bar     =   baz
  24 .end
  25
  26 Of course this is useless if some other part of gitolite, or some external
  27 command, is not querying for the option key 'foo.bar'!
  28
  29 Options are therefore documented in the section/page they belong in, not here.
  30 Here are some examples, although this list is not exhaustive:
  31
  32   * Ask gitolite to honor [deny rules][deny-rules]  during the pre-git check
  33     also.
  34
  35   * [Mirroring][] related options -- tell gitolite who is the master server,
  36     and who are the slaves, for each repo.
  37
  38   * The optional post-compile trigger 'update-gitweb-daemon-from-options'
  39     allows you to use options instead of special usernames gitweb and daemon
  40     to determine access for those tools.
  41
  42   * You can set [repo-specific environment variables][rsev] for triggers and
  43     hooks to test, which is very useful.
  44
  45 Here's how to disable an option from a single repo if it was enabled earlier
  46 in a group (which you might guess from reading the [git-config][] page):
  47
  48 .#! conf/vim-color
  49     @g = r1 r2 r3
  50
  51     repo @g
  52         option gitweb = 1
  53
  54     # but repo r2 should not be accessible by gitweb
  55     repo r2
  56         option gitweb = ""
  57 .end