---------------

Hooks can be managed in similar way to this used in .hgrc files.

To access hooks setting click `advanced setup` on Hooks section of Mercurial

Settings in Admin.

There are 4 built in hooks that cannot be changed (only enable/disable by

checkboxes on previos section).

To add another custom hook simply fill in first section with

<name>.<hook_type> and the second one with hook path. Example hooks

can be found at *rhodecode.lib.hooks*.

Changing default encoding

-------------------------

By default RhodeCode uses utf8 encoding, starting from 1.3 series this

can be changed, simply edit default_encoding in .ini file to desired one.

This affects many parts in rhodecode including committers names, filenames,

encoding of commit messages. In addition RhodeCode can detect if `chardet`

library is installed. If `chardet` is detected RhodeCode will fallback to it

when there are encode/decode errors.

Setting Up Celery

-----------------

Since version 1.1 celery is configured by the rhodecode ini configuration files.

Simply set use_celery=true in the ini file then add / change the configuration

variables inside the ini file.

Remember that the ini files use the format with '.' not with '_' like celery.

So for example setting `BROKER_HOST` in celery means setting `broker.host` in

the config file.

In order to start using celery run::

 paster celeryd <configfile.ini>

.. note::

   Make sure you run this command from the same virtualenv, and with the same

   user that rhodecode runs.

HTTPS support

-------------

There are two ways to enable https:

- Set HTTP_X_URL_SCHEME in your http server headers, than rhodecode will

  recognize this headers and make proper https redirections

- Alternatively, change the `force_https = true` flag in the ini configuration

  to force using https, no headers are needed than to enable https

Nginx virtual host example

--------------------------

Sample config for nginx using proxy::

    upstream rc {

        server 127.0.0.1:5000;

        # add more instances for load balancing

        #server 127.0.0.1:5001;

        #server 127.0.0.1:5002;

    }

    server {

       listen          443;

       server_name     rhodecode.myserver.com;

       access_log      /var/log/nginx/rhodecode.access.log;

       error_log       /var/log/nginx/rhodecode.error.log;

       ssl on;

       ssl_certificate     rhodecode.myserver.com.crt;

       ssl_certificate_key rhodecode.myserver.com.key;

       ssl_session_timeout 5m;

       ssl_protocols SSLv3 TLSv1;

       ssl_ciphers DHE-RSA-AES256-SHA:DHE-RSA-AES128-SHA:EDH-RSA-DES-CBC3-SHA:AES256-SHA:DES-CBC3-SHA:AES128-SHA:RC4-SHA:RC4-MD5;

       ssl_prefer_server_ciphers on;

       # uncomment if you have nginx with chunking module compiled

       # fixes the issues of having to put postBuffer data for large git

       # pushes

       #chunkin on;

       #error_page 411 = @my_411_error;

       #location @my_411_error {

       #    chunkin_resume;

       #}

       # uncomment if you want to serve static files by nginx

       #root /path/to/installation/rhodecode/public;

       location / {

            try_files $uri @rhode;

       }

       location @rhode {

            proxy_pass      http://rc;

            include         /etc/nginx/proxy.conf;

       }

    }

Here's the proxy.conf. It's tuned so it will not timeout on long

pushes or large pushes::

    proxy_redirect              off;

    proxy_set_header            Host $host;

    proxy_set_header            X-Url-Scheme $scheme;

    proxy_set_header            X-Host $http_host;

    proxy_set_header            X-Real-IP $remote_addr;

    proxy_set_header            X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_set_header            Proxy-host $proxy_host;

    client_max_body_size        400m;

    client_body_buffer_size     128k;

    proxy_buffering             off;

    proxy_connect_timeout       7200;

    proxy_send_timeout          7200;

    proxy_read_timeout          7200;

    proxy_buffers               8 32k;

Also, when using root path with nginx you might set the static files to false

in the production.ini file::

    [app:main]

      use = egg:rhodecode

      full_stack = true

      static_files = false

      lang=en

      cache_dir = %(here)s/data

In order to not have the statics served by the application. This improves speed.

Apache virtual host reverse proxy example

-----------------------------------------

Here is a sample configuration file for apache using proxy::

    <VirtualHost *:80>

            ServerName hg.myserver.com

            ServerAlias hg.myserver.com

            <Proxy *>

              Order allow,deny

              Allow from all

            </Proxy>

            #important !

            #Directive to properly generate url (clone url) for pylons

            ProxyPreserveHost On

            #rhodecode instance

            ProxyPass / http://127.0.0.1:5000/

            ProxyPassReverse / http://127.0.0.1:5000/

            #to enable https use line below

            #SetEnvIf X-Url-Scheme https HTTPS=1

    </VirtualHost>

Additional tutorial

http://wiki.pylonshq.com/display/pylonscookbook/Apache+as+a+reverse+proxy+for+Pylons

Apache as subdirectory

----------------------

Apache subdirectory part::

    <Location /<someprefix> >

      ProxyPass http://127.0.0.1:5000/<someprefix>

      ProxyPassReverse http://127.0.0.1:5000/<someprefix>

      SetEnvIf X-Url-Scheme https HTTPS=1

    </Location>

Besides the regular apache setup you will need to add the following line

into [app:main] section of your .ini file::

    filter-with = proxy-prefix

Add the following at the end of the .ini file::

    [filter:proxy-prefix]

    use = egg:PasteDeploy#prefix

    prefix = /<someprefix>

Apache's WSGI config

--------------------

Alternatively, RhodeCode can be set up with Apache under mod_wsgi. For

that, you'll need to:

- Install mod_wsgi. If using a Debian-based distro, you can install

  the package libapache2-mod-wsgi::

    aptitude install libapache2-mod-wsgi

- Enable mod_wsgi::

    a2enmod wsgi

- Create a wsgi dispatch script, like the one below. Make sure you

  check the paths correctly point to where you installed RhodeCode

  and its Python Virtual Environment.

- Enable the WSGIScriptAlias directive for the wsgi dispatch script,

  as in the following example. Once again, check the paths are

  correctly specified.

Here is a sample excerpt from an Apache Virtual Host configuration file::

    WSGIDaemonProcess pylons \

        threads=4 \

        python-path=/home/web/rhodecode/pyenv/lib/python2.6/site-packages

    WSGIScriptAlias / /home/web/rhodecode/dispatch.wsgi

    WSGIPassAuthorization On

.. note::

   when running apache as root please add: `user=www-data group=www-data`

   into above configuration

.. note::

   Running RhodeCode in multiprocess mode in apache is not supported,

   make sure you don't specify `processes=num` directive in the config

Example wsgi dispatch script::

    import os

    os.environ["HGENCODING"] = "UTF-8"

    os.environ['PYTHON_EGG_CACHE'] = '/home/web/rhodecode/.egg-cache'

    # sometimes it's needed to set the curent dir

    os.chdir('/home/web/rhodecode/')

    import site

    site.addsitedir("/home/web/rhodecode/pyenv/lib/python2.6/site-packages")

    from paste.deploy import loadapp

    from paste.script.util.logging_config import fileConfig

    fileConfig('/home/web/rhodecode/production.ini')

    application = loadapp('config:/home/web/rhodecode/production.ini')

Note: when using mod_wsgi you'll need to install the same version of

Mercurial that's inside RhodeCode's virtualenv also on the system's Python

environment.

Other configuration files

-------------------------

Some example init.d scripts can be found in init.d directory::

  https://secure.rhodecode.org/rhodecode/files/beta/init.d

.. _virtualenv: http://pypi.python.org/pypi/virtualenv

.. _python: http://www.python.org/

.. _mercurial: http://mercurial.selenic.com/

.. _celery: http://celeryproject.org/

.. _rabbitmq: http://www.rabbitmq.com/

.. _python-ldap: http://www.python-ldap.org/

.. _mercurial-server: http://www.lshift.net/mercurial-server.html

.. _PublishingRepositories: http://mercurial.selenic.com/wiki/PublishingRepositories

.. _Issues tracker: https://bitbucket.org/marcinkuzminski/rhodecode/issues

.. _google group rhodecode: http://groups.google.com/group/rhodecode

/**

 * TABLE SORTING

 */

// returns a node from given html;

var fromHTML = function(html){

	  var _html = document.createElement('element');

	  _html.innerHTML = html;

	  return _html;

}

var get_rev = function(node){

    var n = node.firstElementChild.firstElementChild;

    if (n===null){

        return -1

    }

    else{

        out = n.firstElementChild.innerHTML.split(':')[0].replace('r','');

        return parseInt(out);

    }

}

var get_name = function(node){

	 var name = node.firstElementChild.children[2].innerHTML; 

	 return name

}

var get_group_name = function(node){

	var name = node.firstElementChild.children[1].innerHTML;

	return name

}

var get_date = function(node){

	var date_ = YUD.getAttribute(node.firstElementChild,'date');

	return date_

}

var get_age = function(node){

	return node

}

var get_link = function(node){

	return node.firstElementChild.text;

}

var revisionSort = function(a, b, desc, field) {

	  var a_ = fromHTML(a.getData(field));

	  var b_ = fromHTML(b.getData(field));

	  // extract revisions from string nodes 

	  a_ = get_rev(a_)

	  b_ = get_rev(b_)

	  var comp = YAHOO.util.Sort.compare;

	  var compState = comp(a_, b_, desc);

	  return compState;

};

var ageSort = function(a, b, desc, field) {

    var a_ = fromHTML(a.getData(field));

    var b_ = fromHTML(b.getData(field));

    // extract name from table

    a_ = get_date(a_)

    b_ = get_date(b_)          

    var comp = YAHOO.util.Sort.compare;

    var compState = comp(a_, b_, desc);

    return compState;

};

var lastLoginSort = function(a, b, desc, field) {

	var a_ = a.getData('last_login_raw') || 0;

    var b_ = b.getData('last_login_raw') || 0;

    var comp = YAHOO.util.Sort.compare;

    var compState = comp(a_, b_, desc);

    return compState;

};

var nameSort = function(a, b, desc, field) {

    var a_ = fromHTML(a.getData(field));

    var b_ = fromHTML(b.getData(field));

    // extract name from table

    a_ = get_name(a_)

    b_ = get_name(b_)          

    var comp = YAHOO.util.Sort.compare;

    var compState = comp(a_, b_, desc);

    return compState;

};

var permNameSort = function(a, b, desc, field) {

    var a_ = fromHTML(a.getData(field));

    var b_ = fromHTML(b.getData(field));

    // extract name from table

    a_ = a_.children[0].innerHTML;

    b_ = b_.children[0].innerHTML;      

    var comp = YAHOO.util.Sort.compare;

    var compState = comp(a_, b_, desc);

    return compState;

};

var groupNameSort = function(a, b, desc, field) {

    var a_ = fromHTML(a.getData(field));

    var b_ = fromHTML(b.getData(field));

    // extract name from table

    a_ = get_group_name(a_)

    b_ = get_group_name(b_)          

    var comp = YAHOO.util.Sort.compare;

    var compState = comp(a_, b_, desc);

    return compState;

};

var dateSort = function(a, b, desc, field) {

    var a_ = fromHTML(a.getData(field));

    var b_ = fromHTML(b.getData(field));

    // extract name from table

    a_ = get_date(a_)

    b_ = get_date(b_)          

    var comp = YAHOO.util.Sort.compare;

    var compState = comp(a_, b_, desc);

    return compState;

};

var linkSort = function(a, b, desc, field) {

	  var a_ = fromHTML(a.getData(field));

	  var b_ = fromHTML(a.getData(field));

	  // extract url text from string nodes 

	  a_ = get_link(a_)

	  b_ = get_link(b_)

	  var comp = YAHOO.util.Sort.compare;

	  var compState = comp(a_, b_, desc);

	  return compState;

}

var addPermAction = function(_html, users_list, groups_list){

    var elmts = YUD.getElementsByClassName('last_new_member');

    var last_node = elmts[elmts.length-1];

    if (last_node){

       var next_id = (YUD.getElementsByClassName('new_members')).length;

       _html = _html.format(next_id);

       last_node.innerHTML = _html;

       YUD.setStyle(last_node, 'display', '');

       YUD.removeClass(last_node, 'last_new_member');

       MembersAutoComplete("perm_new_member_name_"+next_id, 

               "perm_container_"+next_id, users_list, groups_list);          

       //create new last NODE

       var el = document.createElement('tr');

       el.id = 'add_perm_input';

       YUD.addClass(el,'last_new_member');

       YUD.addClass(el,'new_members');

       YUD.insertAfter(el, last_node);

    }	

}

/* Multi selectors */

var MultiSelectWidget = function(selected_id, available_id, form_id){

	//definition of containers ID's

	var selected_container = selected_id;

	var available_container = available_id;

	//temp container for selected storage.

	var cache = new Array();

	var av_cache = new Array();

	var c =  YUD.get(selected_container);

	var ac = YUD.get(available_container);

	//get only selected options for further fullfilment

	for(var i = 0;node =c.options[i];i++){

	    if(node.selected){

	        //push selected to my temp storage left overs :)

	        cache.push(node);

	    }

	}

	//get all available options to cache

	for(var i = 0;node =ac.options[i];i++){

	        //push selected to my temp storage left overs :)

	        av_cache.push(node);

	}

	ac.options.length=0;

	tmp_cache = new Array();

	for(var i = 0;node = av_cache[i];i++){

	    var add = true;

	    for(var i2 = 0;node_2 = cache[i2];i2++){

	        if(node.value == node_2.value){

	            add=false;

	            break;

	        }

	    }

	    if(add){

	        tmp_cache.push(new Option(node.text, node.value, false, false));

	    }

	}

	for(var i = 0;node = tmp_cache[i];i++){

	    ac.options[i] = node;

	}

	function prompts_action_callback(e){

	    var available = YUD.get(available_container);

	    //get checked and unchecked options from field

	    function get_checked(from_field){

	        //temp container for storage.

	        var sel_cache = new Array();

	        var oth_cache = new Array();

	        for(var i = 0;node = from_field.options[i];i++){

	            if(node.selected){

	                //push selected fields :)

	                sel_cache.push(node);

	            }

	            else{

	                oth_cache.push(node)

	            }

	        }

	        return [sel_cache,oth_cache]

	    }

	    //fill the field with given options

	    function fill_with(field,options){

	        //clear firtst

	        field.options.length=0;

	        for(var i = 0;node = options[i];i++){

	                field.options[i]=new Option(node.text, node.value,

	                        false, false);

	        }

	    }

	    //adds to current field

	    function add_to(field,options){

	        for(var i = 0;node = options[i];i++){

	                field.appendChild(new Option(node.text, node.value,

	                        false, false));

	        }

	    }

	    // add action

	    if (this.id=='add_element'){

	        var c = get_checked(available);

	        fill_with(available,c[1]);

	    }

	    // remove action

	    if (this.id=='remove_element'){

	        add_to(available,c[0]);

	    }

	    // add all elements

	    if(this.id=='add_all_elements'){

	        for(var i=0; node = available.options[i];i++){

	                        node.value, false, false));

	        }

	        available.options.length = 0;

	    }

	    //remove all elements

	    if(this.id=='remove_all_elements'){

	            available.appendChild(new Option(node.text,

	                    node.value, false, false));

	        }

	    }

	}

	YUE.addListener(['add_element','remove_element',

	               'add_all_elements','remove_all_elements'],'click',

	               prompts_action_callback)

	if (form_id !== undefined) {

		YUE.addListener(form_id,'submit',function(){

		    }

		});

	}

}

// global hooks after DOM is loaded

YUE.onDOMReady(function(){

	YUE.on(YUQ('.diff-collapse-button'), 'click', function(e){

		var button = e.currentTarget;

		var t = YUD.get(button).getAttribute('target');

	    console.log(t);

		if(YUD.hasClass(t, 'hidden')){

			YUD.removeClass(t, 'hidden');

			YUD.get(button).innerHTML = "↑ {0} ↑".format(_TM['Collapse diff']);

		}

		else if(!YUD.hasClass(t, 'hidden')){

			YUD.addClass(t, 'hidden');

			YUD.get(button).innerHTML = "↓ {0} ↓".format(_TM['Expand diff']);

		}

	});

});

## -*- coding: utf-8 -*-

<%inherit file="/base/base.html"/>

<%def name="title()">

    ${_('Permissions administration')} · ${c.rhodecode_name}

</%def>

<%def name="breadcrumbs_links()">

    ${h.link_to(_('Admin'),h.url('admin_home'))}

    »

    ${_('permissions')}

</%def>

<%def name="page_nav()">

    ${self.menu('admin')}

</%def>

<%def name="main()">

<div class="box box-left">

    <!-- box / title -->

    <div class="title">

        ${self.breadcrumbs()}

    </div>

    <h3>${_('Default permissions')}</h3>

    ${h.form(url('permission', id='default'),method='put')}

    <div class="form">

        <!-- fields -->

        <div class="fields">

            <div class="field">

                <div class="label label-checkbox">

                    <label for="anonymous">${_('Anonymous access')}:</label>

                </div>

                <div class="checkboxes">

                    <div class="checkbox">

                        ${h.checkbox('anonymous',True)}

                    </div>

                </div>

            </div>

            <div class="field">

                <div class="label">

                    <label for="default_repo_perm">${_('Repository')}:</label>

                </div>

                <div class="select">

                    ${h.select('default_repo_perm','',c.repo_perms_choices)}

                    ${h.checkbox('overwrite_default_repo','true')}

                    <label for="overwrite_default_repo">

                    <span class="tooltip"

                    ${_('overwrite existing settings')}</span> </label>

                </div>

            </div>

            <div class="field">

                <div class="label">

                    <label for="default_group_perm">${_('Repository group')}:</label>

                </div>

                <div class="select">

                    ${h.select('default_group_perm','',c.group_perms_choices)}

                    ${h.checkbox('overwrite_default_group','true')}

                    <label for="overwrite_default_group">

                    <span class="tooltip"

                    ${_('overwrite existing settings')}</span> </label>

                </div>

            </div>

            <div class="field">

                <div class="label">

                    <label for="default_register">${_('Registration')}:</label>

                </div>

                <div class="select">

                    ${h.select('default_register','',c.register_choices)}

                </div>

            </div>

             <div class="field">

                <div class="label">

                    <label for="default_create">${_('Repository creation')}:</label>

                </div>

                <div class="select">

                    ${h.select('default_create','',c.create_choices)}

                </div>

             </div>

             <div class="field">

                <div class="label">

                    <label for="default_fork">${_('Repository forking')}:</label>

                </div>

                <div class="select">

                    ${h.select('default_fork','',c.fork_choices)}

                </div>

             </div>

            <div class="buttons">

              ${h.submit('save',_('Save'),class_="ui-btn large")}

              ${h.reset('reset',_('Reset'),class_="ui-btn large")}

            </div>

        </div>

    </div>

    ${h.end_form()}

</div>

<div style="min-height:780px" class="box box-right">

    <!-- box / title -->

    <div class="title">

        <h5>${_('Default User Permissions')}</h5>

    </div>

    ## permissions overview

    <div id="perms" class="table">

           %for section in sorted(c.perm_user.permissions.keys()):

              <div class="perms_section_head">${section.replace("_"," ").capitalize()}</div>

              %if not c.perm_user.permissions[section]:

                  <span class="empty_data">${_('Nothing here yet')}</span>

              %else:

              <div id='tbl_list_wrap_${section}' class="yui-skin-sam">

               <table id="tbl_list_${section}">

                <thead>

                    <tr>

                    <th class="left">${_('Name')}</th>

                    <th class="left">${_('Permission')}</th>

                    <th class="left">${_('Edit Permission')}</th>

                </thead>

                <tbody>

                %for k in c.perm_user.permissions[section]:

                     <%

                     if section != 'global':

                         section_perm = c.perm_user.permissions[section].get(k)

                         _perm = section_perm.split('.')[-1]

                     else:

                         _perm = section_perm = None

                     %>

                    <tr>

                        <td>

                            %if section == 'repositories':

                                <a href="${h.url('summary_home',repo_name=k)}">${k}</a>

                            %elif section == 'repositories_groups':

                                <a href="${h.url('repos_group_home',group_name=k)}">${k}</a>

                            %else:

                                ${h.get_permission_name(k)}

                            %endif

                        </td>

                        <td>

                            %if section == 'global':

                             ${h.bool2icon(k.split('.')[-1] != 'none')}

                            %else:

                             <span class="perm_tag ${_perm}">${section_perm}</span>

                            %endif

                        </td>

                        <td>

                            %if section == 'repositories':

                                <a href="${h.url('edit_repo',repo_name=k,anchor='permissions_manage')}">${_('edit')}</a>

                            %elif section == 'repositories_groups':

                                <a href="${h.url('edit_repos_group',group_name=k,anchor='permissions_manage')}">${_('edit')}</a>

                            %else:

                                --

                            %endif

                        </td>

                    </tr>

                %endfor

                </tbody>

               </table>

              </div>

              %endif

           %endfor

    </div>

</div>

<div class="box box-left" style="clear:left">

    <!-- box / title -->

    <div class="title">

        <h5>${_('Allowed IP addresses')}</h5>

    </div>

    <div class="ips_wrap">

      <table class="noborder">

      %if c.user_ip_map:

        %for ip in c.user_ip_map:

          <tr>

              <td><div class="ip">${ip.ip_addr}</div></td>

              <td><div class="ip">${h.ip_range(ip.ip_addr)}</div></td>

              <td>

                ${h.form(url('user_ips_delete', id=c.user.user_id),method='delete')}

                    ${h.hidden('del_ip',ip.ip_id)}

                    ${h.hidden('default_user', 'True')}

                    ${h.submit('remove_',_('delete'),id="remove_ip_%s" % ip.ip_id,

                    class_="delete_icon action_button", onclick="return  confirm('"+_('Confirm to delete this ip: %s') % ip.ip_addr+"');")}

                ${h.end_form()}

              </td>

          </tr>

        %endfor

       %else:

        <tr><td><div class="ip">${_('All IP addresses are allowed')}</div></td></tr>

       %endif

      </table>

    </div>

    ${h.form(url('user_ips', id=c.user.user_id),method='put')}

    <div class="form">

        <!-- fields -->

        <div class="fields">

             <div class="field">

                <div class="label">

                    <label for="new_ip">${_('New ip address')}:</label>

                </div>

                <div class="input">

                    ${h.hidden('default_user', 'True')}

                    ${h.text('new_ip', class_='medium')}

                </div>

             </div>

            <div class="buttons">

              ${h.submit('save',_('Add'),class_="ui-btn large")}

              ${h.reset('reset',_('Reset'),class_="ui-btn large")}

            </div>

        </div>

    </div>

    ${h.end_form()}

</div>

</%def>

## -*- coding: utf-8 -*-

<%inherit file="/base/base.html"/>

<%def name="title()">

    ${_('Edit user group')} ${c.users_group.users_group_name} · ${c.rhodecode_name}

</%def>

<%def name="breadcrumbs_links()">

    ${h.link_to(_('Admin'),h.url('admin_home'))}

    »

    ${h.link_to(_('UserGroups'),h.url('users_groups'))}