=================================================

Welcome to RhodeCode (RhodiumCode) documentation!

=================================================

``RhodeCode`` (formerly hg-app) is Pylons framework based Mercurial repository 

RhodeCode uses `Semantic Versioning <http://semver.org/>`_

RhodeCode demo

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

http://hg.python-works.com

The default access is anonymous but You can login to administrative account

using those credentials

- username: demo

Installation

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

 Please visit http://packages.python.org/RhodeCode/installation.html

Features

--------

- Has it's own middleware to handle mercurial_ protocol request. 

  Each request can be logged and authenticated. Runs on threads unlikely to 

  hgweb. You can make multiple pulls/pushes simultaneous. Supports http/https 

- Full permissions (private/read/write/admin) and authentication per project. 

  One account for web interface and mercurial_ push/pull/clone operations.

- Mako templates let's you customize look and feel of application.

- Beautiful diffs, annotations and source codes all colored by pygments.

- Mercurial_ branch graph and yui-flot powered graphs with zooming and statistics

- Admin interface with user/permission management. Admin activity journal, logs

  pulls, pushes, forks, registrations and other actions made by all users.

- Server side forks, it's possible to fork a project and hack it free without

  breaking the main repository.

- Full text search powered by Whoosh on source codes, and file names.

  Build in indexing daemons, with optional incremental index build

  (no external search servers required all in one application)

- Setup project descriptions and info inside built in db for easy, non 

  file-system operations

  performance and always up to date data.    

- Rss / atom feeds, gravatar support, download sources as zip/tar/gz

- Async tasks for speed and performance using celery_ (works without them too)  

- Backup scripts can do backup of whole app and send it over scp to desired 

  location 

- Based on pylons / sqlalchemy / sqlite / whoosh / vcs

.. include:: ./docs/screenshots.rst

Incoming / Plans

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

- project grouping

- User groups/teams

- code review (probably based on hg-review)

- full git_ support, with push/pull server (currently in beta tests)

- redmine integration

- public accessible activity feeds

- commit based build in wiki system

- more statistics and graph (global annotation + some more statistics)

- other cools stuff that i can figure out (or You can help me figure out)

License

-------

Mailing group Q&A

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

join the `Google group <http://groups.google.com/group/rhodecode>`_

open an issue at `issue tracker <http://bitbucket.org/marcinkuzminski/rhodecode/issues>`_

join #rhodecode on FreeNode (irc.freenode.net)

or use http://webchat.freenode.net/?channels=rhodecode for web access to irc.

Online documentation

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

 Online documentation for current version is available at

 http://packages.python.org/RhodeCode/.

 You may also build documentation for yourself - go into ``docs/`` and run::

   make html

.. _changelog:

Changelog

=========

1.1.3 (**2011-02-16**)

======================

news

----

- implemented #102 allowing the '.' character in username

- added option to access repository just by entering http://server/<repo_name>

- celery task ignores result for better performance

fixes

-----

  apollo13 and Johan Walles

- small fixes in journal

- fixed problems with getting setting for celery from .ini files

- registration, password reset and login boxes share the same title as main 

  application now

- fixed #113: to high permissions to fork repository

- fixed problem with '[' chars in commit messages in journal

- removed issue with space inside renamed repository after deletion

- db transaction fixes when filesystem repository creation failed

- fixed #106 relation issues on databases different than sqlite

- fixed static files paths links to use of url() method

1.1.2 (**2011-01-12**)

======================

news

----

fixes

-----

- fixes #98 protection against float division of percentage stats

- fixed graph bug

.. _contributing:

Contributing in RhodeCode

=========================

If You would like to contribute to RhodeCode, please contact me, any help is

greatly appreciated.

Thank You.

many big repositories. If You plan to use it for 7 or 10 small repositories, it

will work just fine without celery running.

After You decide to Run it with celery make sure You run celeryd using paster

and message broker together with the application.   

Install from Cheese Shop

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

Rhodecode requires python 2.x greater than version 2.5

Easiest way to install ``rhodecode`` is to run::

Or::

If you prefer to install manually simply grab latest release from

Step by step installation example

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

- Assuming You have installed virtualenv_ create one using. 

::

- this will install new virtualenv_ into `/var/www/rhodecode-venv`. 

- Activate the virtualenv_ by running 

::

- Make a folder for rhodecode somewhere on the filesystem for example 

::

- Run this command to install rhodecode

::

- this will install rhodecode together with pylons

  and all other required python libraries

Requirements for Celery (optional)

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

.. note::

   Installing message broker and using celery is optional, RhodeCode will

   work without them perfectly fine.

.. _setup:

Setup

=====

Setting up the application

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

to do this

::

 paster make-config RhodeCode production.ini

- This will create `production.ini` config inside the directory

  this config contains various settings for RhodeCode, e.g proxy port, 

  email settings, usage of static files, cache, celery settings and logging.

::

 paster setup-app production.ini

- This command will create all needed tables and an admin account. 

  When asked for a path You can either use a new location of one with already 

  existing ones. RhodeCode will simply add all new found repositories to 

  it's database. Also make sure You specify correct path to repositories.

- Remember that the given path for mercurial_ repositories must be write 

  accessible for the application. It's very important since RhodeCode web 

  interface will work even without such an access but, when trying to do a 

  push it'll eventually fail with permission denied errors. 

::

 paster serve production.ini

- This command runs the RhodeCode server the app should be available at the 

  127.0.0.1:5000. This ip and port is configurable via the production.ini 

  file created in previous step

- Use admin account you created to login.

- Default permissions on each repository is read, and owner is admin. So 

  remember to update these if needed. In the admin panel You can toggle ldap,

  anonymous, permissions settings. As well as edit more advanced options on 

  users and repositories

Setting up Whoosh full text search

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

to enable full index rebuild. Without that indexing will run always in in

incremental mode.

- For full text search You can either put crontab entry for

::

 /path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos> 

of each file and add it to reindex if newer file is available. Also indexing 

daemon checks for removed files and removes them from index. 

Sometime You might want to rebuild index from scratch. You can do that using 

the `-f` flag passed to paster command or, in admin panel You can check 

`build from scratch` flag.

Setting up LDAP support

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

RhodeCode starting from version 1.1 supports ldap authentication. In order

via pypi, so You can install it by running

::

 easy_install python-ldap

::

 pip install python-ldap

.. note::

   python-ldap requires some certain libs on Your system, so before installing 

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 uses 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 make start using celery run::

 paster celeryd <configfile.ini>

.. note::

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

   that rhodecode runs.

HTTPS support

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

There are two ways to enable https, first is to set HTTP_X_URL_SCHEME in

Your http server headers, than rhodecode will recognise this headers and make

proper https redirections, another way is to set `force_https = true` 

in the ini cofiguration to force using https, no headers are needed than to

enable https

Nginx virtual host example

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

Sample config for nginx using proxy::

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

pushes and also on large pushes::

    proxy_redirect              off;

    proxy_set_header            Host $host;

    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       3600;

    proxy_send_timeout          3600;

    proxy_read_timeout          3600;

    proxy_busy_buffers_size     64k;

    proxy_temp_file_write_size  64k;

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

in production.ini file::

To not have the statics served by the application. And improve speed.

Apache virtual host example

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

Sample config for apache using proxy::

    <VirtualHost *:80>

            ServerName hg.myserver.com

            ServerAlias hg.myserver.com

            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's example FCGI config

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

TODO !

Other configuration files

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

Some example init.d script can be found here, for debian and gentoo:

https://rhodeocode.org/rhodecode/files/tip/init.d

 - don't worry RhodeCode works without them too. No extra setup required

- long lasting push timeouts ?

 - make sure You set a longer timeouts in Your proxy/fcgi settings, timeouts

   are caused by https server and not RhodeCode

- large pushes timeouts ?

 - make sure You set a proper max_body_size for the http server

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

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

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

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

Then make sure You run from the installation directory

::

 paster make-config RhodeCode production.ini

This will display any changes made from new version of RhodeCode To your

current config. And tries to do an automerge. It's always better to do a backup

of config file and recheck the content after merge.

It's also good to rebuild the whoosh index since after upgrading the whoosh 

version there could be introduced incompatible index changes.

The last step is to upgrade the database. To do this simply run

::

This will upgrade schema, as well as update some default on the database,

always recheck the settings of the application, if there are no new options

that need to be set.

.. note::

   Always perform a database backup before doing upgrade.

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

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

# 

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

# 

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

# MA  02110-1301, USA.

__version__ = '.'.join((str(each) for each in VERSION[:4]))

__dbversion__ = 2 #defines current db version for migrations

try:

    from rhodecode.lib.utils import get_current_revision

    _rev = get_current_revision()

except ImportError:

    #this is needed when doing some setup.py operations

    _rev = False

if len(VERSION) > 3 and _rev:

    __version__ += ' [rev:%s]' % _rev[0]

    map.connect('atom_feed_home', '/{repo_name:.*}/feed/atom',

                controller='feed', action='atom',

                conditions=dict(function=check_repo))

    #REPOSITORY ROUTES

    map.connect('changeset_home', '/{repo_name:.*}/changeset/{revision}',

                controller='changeset', revision='tip',

                conditions=dict(function=check_repo))

    map.connect('raw_changeset_home', '/{repo_name:.*}/raw-changeset/{revision}',

                controller='changeset', action='raw_changeset', revision='tip',

                conditions=dict(function=check_repo))

    map.connect('summary_home', '/{repo_name:.*}/summary',

                controller='summary', conditions=dict(function=check_repo))

    map.connect('shortlog_home', '/{repo_name:.*}/shortlog',

                controller='shortlog', conditions=dict(function=check_repo))

    map.connect('branches_home', '/{repo_name:.*}/branches',

                controller='branches', conditions=dict(function=check_repo))

    map.connect('tags_home', '/{repo_name:.*}/tags',

                controller='tags', conditions=dict(function=check_repo))

    map.connect('changelog_home', '/{repo_name:.*}/changelog',

                controller='changelog', conditions=dict(function=check_repo))

    map.connect('files_home', '/{repo_name:.*}/files/{revision}/{f_path:.*}',

                controller='files', revision='tip', f_path='',

# This program is distributed in the hope that it will be useful,

# but WITHOUT ANY WARRANTY; without even the implied warranty of

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

# GNU General Public License for more details.

# 

# You should have received a copy of the GNU General Public License

# along with this program; if not, write to the Free Software

# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,

# MA  02110-1301, USA.

import logging

import traceback

from pylons import tmpl_context as c, request, url

from pylons.controllers.util import redirect

from pylons.i18n.translation import _

import rhodecode.lib.helpers as h

from rhodecode.lib.auth import LoginRequired, HasRepoPermissionAllDecorator, \

    HasRepoPermissionAnyDecorator, NotAnonymous

from rhodecode.lib.base import BaseController, render

from rhodecode.lib.utils import invalidate_cache, action_logger

from rhodecode.model.forms import RepoSettingsForm, RepoForkForm

from rhodecode.model.repo import RepoModel

                      ' in order to rescan repositories') % repo_name,

                      category='error')

            return redirect(url('home'))

        defaults = c.repo_info.get_dict()

        defaults.update({'user':c.repo_info.user.username})

        c.users_array = repo_model.get_users_js()

        for p in c.repo_info.repo_to_perm:

            defaults.update({'perm_%s' % p.user.username:

                             p.permission.permission_name})

            render('settings/repo_settings.html'),

            defaults=defaults,

            encoding="UTF-8",

            force_defaults=False

        )

    @HasRepoPermissionAllDecorator('repository.admin')

    def update(self, repo_name):

        repo_model = RepoModel()

        changed_name = repo_name

        _form = RepoSettingsForm(edit=True, old_data={'repo_name':repo_name})()

        try:

            form_result = _form.to_python(dict(request.POST))

            repo_model.update(repo_name, form_result)

            invalidate_cache('get_repo_cached_%s' % repo_name)

            h.flash(_('Repository %s updated successfully' % repo_name),

                    category='success')

            changed_name = form_result['repo_name']

            action_logger(self.rhodecode_user, 'user_updated_repo',

                              changed_name, '', self.sa)

        except formencode.Invalid, errors:

            c.repo_info = repo_model.get_by_repo_name(repo_name)

            c.users_array = repo_model.get_users_js()

            errors.value.update({'user':c.repo_info.user.username})

                render('settings/repo_settings.html'),

                defaults=errors.value,

                errors=errors.error_dict or {},

                prefix_error=False,

                encoding="UTF-8")

        except Exception:

            log.error(traceback.format_exc())

            h.flash(_('error occurred during update of repository %s') \

                    % repo_name, category='error')

        return redirect(url('repo_settings_home', repo_name=changed_name))

            form_result.update({'repo_name':repo_name})

            repo_model.create_fork(form_result, c.rhodecode_user)

            h.flash(_('forked %s repository as %s') \

                      % (repo_name, form_result['fork_name']),

                    category='success')

            action_logger(self.rhodecode_user,

                          'user_forked_repo:%s' % form_result['fork_name'],

                           repo_name, '', self.sa)

        except formencode.Invalid, errors:

            c.new_repo = errors.value['fork_name']

            r = render('settings/repo_fork.html')

                r,

                defaults=errors.value,

                errors=errors.error_dict or {},

                prefix_error=False,

                encoding="UTF-8")

        return redirect(url('home'))