gitolite/doc/misc.mkd

3.8 KiB

odds and ends

Most of these items don't fit anywhere or fit in more than one place or are of the nature of background information.

#include include files

Gitolite allows you to break up the configuration into multiple files and include them in the main file for convenience.

include     "foo.conf"

will include the contents of the file "foo.conf" from the "conf" directory.

Details:

  • You can also use a glob (include "*.conf"), or put your include files into subdirectories of "conf" (include "foo/bar.conf"), or both (include "repos/*.conf").

  • Included files are always searched relative to the gitolite-admin repo's "conf/" directory.

  • If you ended up recursing, files that have been already processed once are skipped, with a warning.

Advanced users: subconf, a command that is very closely related to include, is documented [here][subconf].

#deny-rules applying deny rules at the pre-git access check

The access [rules][] rules section describes the problem. To recap, you want this:

@staff          =   alice bob wally ashok

repo foo
    RW+         =   alice       # line 1
    RW+ dev     =   bob         # line 2
    -           =   wally       # line 3
    RW  temp/   =   @staff      # line 4

to deny Wally even read access.

The way to do this is to add this line to the repo:

option deny-rules = 1

If you want this for all your repos, just add this somewhere at the top of your conf file

repo @all
    option deny-rules = 1

#rule-accum rule accumulation

Gitolite was meant to collect rules from multiple places and apply them all. For example, this:

repo foo
    RW  =   u1

@gr1 = foo bar

repo @gr1
    RW  =   u2
    R   =   u3

repo @all
    R   =   gitweb

is effectively the same as this, for repo foo:

repo foo
    RW  =   u1
    RW  =   u2
    R   =   u3
    R   =   gitweb

This extends to patterns also, but I'll leave an example for later.

#subconf the subconf command

This is just like the include command:

subconf "foo/bar.conf"      # example 1
subconf "foo/*.conf"        # example 2

with the difference that, for the duration of the file(s) being included, a subconf restriction is in effect. This restrictions limits the repos that can be access controlled by the lines within the included file(s).

Here's how it works. First, a subconf name is derived from the filename being included, which is basically the basename of the file. For example 1 that is "bar". For example 2, assuming foo contains "a.conf" and "b.conf", the subconf name is "a" while processing "a.conf", and "b" while processing "b.conf".

A variation of the subconf command allows you to specify the subconf name explicitly, while including files as before:

subconf frob "foo/bar.conf  # example 3
subconf frob "foo/*.conf    # example 4

In this case the subconf name is "frob" in both cases.

A subconf restricts the repos that can be named in 'repo' lines while the subconf is in effect. If the subconf name is "foo", the conf lines parsed while under the subconf restriction can only refer to

  • a repo called 'foo'
  • a repo group called '@foo'
  • the members of the same repo group '@foo'
  • match a regex that is a member of the repo group '@foo'

In the last 3 cases, the repo group '@foo' must be defined in the main conf file (i.e., outside the subconf restriction).

For example, if you have this in the main conf file:

@foo    =   bar baz frob/..*

subconf "foo.conf"

then foo.conf can only refer to 'foo', '@foo', 'bar', 'baz', or any repo name matching the pattern frob/..*.

#HOSTNAME HOSTNAME substitution

Wherever gitolite sees the word %HOSTNAME, it will replace it with the HOSTNAME supplied in the rc file, if one was supplied. This is mainly useful in [mirroring][].