You are here: start » git » generic-settings

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision 		Previous revision
git:generic-settings [2009/01/16 04:07]
janakj 		git:generic-settings [2010/01/12 22:02] (current)
linulin no spam
Line 4: Line 4:
 ===== Mail Notifications ===== ===== Mail Notifications =====
  
-The central git repository can send email notifications whenever a contributor +The central git repository can send email notifications whenever a 
-pushes commits into it. The mailing script is in $GIT_REPO/hooks/mail and it +contributor pushes commits into it. The mailing script is in 
-is called from $GIT_REPO/hooks/update. The notifications can be configured +$GIT_REPO/hooks/mail and it is called from $GIT_REPO/hooks/update. The 
-from the repository. To enable mail notifications you have to set +notifications can be configured from the repository. To enable mail 
-mailNotifications to true in the hooks section:+notifications you have to set mailNotifications to true in the hooks 
 +section:
  
-&lt;code&gt;+<code>
 [hooks] [hooks]
     mailNotification = true     mailNotification = true
-&lt;/code&gt;+</code>
  
-After that you need to configure the sender and recipient email addresses and +After that you need to configure the sender and recipient email 
-a link to gitweb. These parameters belong to section mail:+addresses and a link to gitweb. These parameters belong to section 
 +mail:
  
-&lt;code&gt;+<code>
 [mail] [mail]
     envelopeSender = admin@sip-router.org     envelopeSender = admin@sip-router.org
     recipient = admin@sip-router.org     recipient = admin@sip-router.org
     gitwebURL = http://git.sip-router.org/cgi-bin/gitweb.cgi     gitwebURL = http://git.sip-router.org/cgi-bin/gitweb.cgi
-&lt;/code&gt;+</code>
  
-Parameter ''envelopeSender'' configures the sender address to be put in the +Parameter ''envelopeSender'' configures the sender address to be put 
-message envelope. This is the email address that will receive delivery status +in the message envelope. This is the email address that will receive 
-notification and notifications of failures. This is not the email address that +delivery status notification and notifications of failures. This is 
-will be put in From header, the From header will be set to your name and email +not the email address that will be put in From header, the From header 
-address which you configured in git and which appears in the commits.+will be set to your name and email address which you configured in git 
 +and which appears in the commits.
  
-Parameter ''recipient'' is the destination address, usually a development +Parameter ''recipient'' is the destination address, usually a 
-mailing list. Mail notifications can contain a link to gitweb in the body, +development mailing list. Mail notifications can contain a link to 
-configure ''gitwebURL'' with the URL to your gitweb if you want to have a link +gitweb in the body, configure ''gitwebURL'' with the URL to your 
-to gitweb in your email notifications.+gitweb if you want to have a link to gitweb in your email 
 +notifications.
  
-The mapping of usernames to email addresses is done using a static file. The +The mapping of usernames to email addresses is done using a static 
-original commitlog script used a static address in From. I then modified the +file. The original commitlog script used a static address in From. I 
-script to extract the author information from the commit object so that we can +then modified the script to extract the author information from the 
-use it in From and people can reply to commitlog messages directly -- reaching +commit object so that we can use it in From and people can reply to 
-the author of the change. Unfortunately this did not work as I expected. A +commitlog messages directly -- reaching the author of the 
-contributor might pull some changes from a private repository for somebody +change. Unfortunately this did not work as I expected. A contributor 
-else and then the email address of that person would be in the author field +might pull some changes from a private repository for somebody else 
-and in From header of the commitlog, although the commit was done by somebody +and then the email address of that person would be in the author field 
-else. Then we tried to use the committer field from the commit object, but the +and in From header of the commitlog, although the commit was done by 
-result was the same, most of the time it contains the same email address as +somebody else. Then we tried to use the committer field from the 
-the author field.+commit object, but the result was the same, most of the time it 
 +contains the same email address as the author field.
  
-It turned out that we couldn't use GIT_COMMITTER_NAME and GIT_COMMITTER_EMAIL +It turned out that we couldn't use GIT_COMMITTER_NAME and 
-environment variables in people's ''~/.bashrc'' either to be used in From, +GIT_COMMITTER_EMAIL environment variables in people's ''~/.bashrc'' 
-because git executes the shell as non-interactive and non-login so the startup +either to be used in From, because git executes the shell as 
-files are ignored when git executes commands and hooks on the server.+non-interactive and non-login so the startup files are ignored when 
 +git executes commands and hooks on the server.
  
 So I ended up adding a simple mapping file, it is in $GIT_DIR/email_map So I ended up adding a simple mapping file, it is in $GIT_DIR/email_map
  
-format is &amp;quot;username=First Last &amp;lt;email&amp;gt;&amp;quot;+format is  
 +<code> 
 +username=First Last <email> 
 +</code>
  
 You can define a catch-all rule in the mapping file which will be used You can define a catch-all rule in the mapping file which will be used
-whenever no matching username can be find if you replace the username with *:+whenever no matching username can be find if you replace the username 
 +with *:
  
-&lt;code&gt;+<code>
 *=root@localhost *=root@localhost
-&lt;/cod&gt;+</code>
  
-and I added a new configuration option to the git config where you can specify with mapping file will be used for the repository:+and I added a new configuration option to the git config where you can 
 +specify with mapping file will be used for the repository:
  
-&amp;lt;code&amp;gt;+<code>
 [mail] [mail]
     envelopeSender = email_addr     envelopeSender = email_addr
Line 72: Line 83:
     gitwebURL = http://git.sip-router.org/cgi-bin/gitweb.cgi     gitwebURL = http://git.sip-router.org/cgi-bin/gitweb.cgi
     emailMap = $GIT_DIR/email_map     emailMap = $GIT_DIR/email_map
-&amp;lt;/code&amp;gt;+</code>
  
-The mailing script dies if it cannot translate a username to email address. It is also possible specify a static From address in the git confiuration file, i.e:+The mailing script dies if it cannot translate a username to email 
 +address. It is also possible specify a static From address in the git 
 +confiuration file, i.e:
  
-&amp;lt;code&amp;gt;+<code>
 [mail] [mail]
     from=admin@sip-router.org     from=admin@sip-router.org
-&amp;lt;/code&amp;gt;+</code>
  
-Then the static configuration takes precedence. Two more improvements to come are:+Then the static configuration takes precedence. Two more improvements 
 +to come are:
  
   * Update the cvs synchronization script so that we get notifications of commits from cvs.   * Update the cvs synchronization script so that we get notifications of commits from cvs.
Line 88: Line 102:
 ===== Branch ACLs ===== ===== Branch ACLs =====
  
-Write access to specific branches can be limited. This is implemented in the update hook. +Write access to specific branches can be limited. This is implemented 
-There are 2 files that control who can commit and on which branch:+in the update hook.  There are 2 files that control who can commit and 
 +on which branch:
    *  **$GIT_DIR/info/allowed-users** : contains one branch pattern and a user pattern list on each line (the patterns are     *  **$GIT_DIR/info/allowed-users** : contains one branch pattern and a user pattern list on each line (the patterns are 
  regular expressions separated by white space). Empty lines and comments (lines starting with '#') are allowed. The branch rules evaluate in the order  regular expressions separated by white space). Empty lines and comments (lines starting with '#') are allowed. The branch rules evaluate in the order
 they are written in the file and they stop at the first match. If the username matches one of the user patterns on the first line matching the branch it will be allowed to commit, else if the branch matched it will be denied and if no branch pattern matched it depends on the **acl.defaultPolicy** config variable. they are written in the file and they stop at the first match. If the username matches one of the user patterns on the first line matching the branch it will be allowed to commit, else if the branch matched it will be denied and if no branch pattern matched it depends on the **acl.defaultPolicy** config variable.
-&amp;lt;code&amp;gt;+<code>
 # Example: # Example:
 # Format: branch_pattern user_pattern_list # Format: branch_pattern user_pattern_list
Line 113: Line 128:
 # everybody can make any tag # everybody can make any tag
 refs/tags/.*            .* refs/tags/.*            .*
-&amp;lt;/code&amp;gt;+</code>
  
   * **$GIT_DIR/info/allowed-groups** : same as above but uses unix group names instead of usernames. It's evaluated only if no match   * **$GIT_DIR/info/allowed-groups** : same as above but uses unix group names instead of usernames. It's evaluated only if no match
Line 119: Line 134:
  
 Config options: Config options:
-  * **acl.defaultPolicy** : if set to &amp;quot;allow&amp;quot; and no rules match the branchname in the allowed-user or allowed-group files, the commit will be allowed. If set to any other value, it will be denied. +  * **acl.defaultPolicy** : if set to "allow" and no rules match the branchname in the allowed-user or allowed-group files, the commit will be allowed. If set to any other value, it will be denied. 
-  * **acl.usernameBranches** : is set to &amp;quot;allow&amp;quot; commits to branches of the form ${username}/.* are allowed, even if access to them+  * **acl.usernameBranches** : is set to "allow" commits to branches of the form ${username}/.* are allowed, even if access to them
 is not explicitely allowed in the allowed-user file. is not explicitely allowed in the allowed-user file.
  
 Example config acl section: Example config acl section:
-&amp;lt;code&amp;gt;+<code>
 [acl] [acl]
         defaultPolicy = deny         defaultPolicy = deny
         usernameBranches = allow         usernameBranches = allow
-&amp;lt;/code&amp;gt;+</code>
  
  

Trace:

Navigation

Wiki

Other

QR Code
QR Code git:generic-settings (generated for current page)