First, you will need to create a RhodeCode configuration file. Run the following command to do this:
paster make-config RhodeCode production.ini
Next, you need to create the databases used by RhodeCode. I recommend that you use sqlite (default) or postgresql. If you choose a database other than the default ensure you properly adjust the db url in your production.ini configuration file to use this other database. Create the databases by running the following command:
paster setup-app production.ini
This will prompt you for a “root” path. This “root” path is the location where RhodeCode will store all of its repositories on the current machine. After entering this “root” path setup-app will also prompt you for a username and password for the initial admin account which setup-app sets up for you.
You are now ready to use RhodeCode, to run it simply execute:
paster serve production.ini
Try copying your own mercurial repository into the “root” directory you are using, then from within the RhodeCode web application choose Admin > repositories. Then choose Add New Repository. Add the repository you copied into the root. Test that you can browse your repository from within RhodeCode and then try cloning your repository from RhodeCode with:
hg clone http://127.0.0.1:5000/<repository name>
where repository name is replaced by the name of your repository.
RhodeCode currently only hosts repositories using http and https. (The addition of ssh hosting is a planned future feature.) However you can easily use ssh in parallel with RhodeCode. (Repository access via ssh is a standard “out of the box” feature of mercurial and you can use this to access any of the repositories that RhodeCode is hosting. See PublishingRepositories)
RhodeCode repository structures are kept in directories with the same name as the project. When using repository groups, each group is a subdirectory. This allows you to easily use ssh for accessing repositories.
In order to use ssh you need to make sure that your web-server and the users login accounts have the correct permissions set on the appropriate directories. (Note that these permissions are independent of any permissions you have set up using the RhodeCode web interface.)
If your main directory (the same as set in RhodeCode settings) is for example set to /home/hg and the repository you are using is named rhodecode, then to clone via ssh you should run:
hg clone ssh://user@server.com/home/hg/rhodecode
Using other external tools such as mercurial-server or using ssh key based authentication is fully supported.
Note: In an advanced setup, in order for your ssh access to use the same permissions as set up via the RhodeCode web interface, you can create an authentication hook to connect to the rhodecode db and runs check functions for permissions against that.
Starting from version 1.1 the whoosh index can be build by using the paster command make-index. To use make-index you must specify the configuration file that stores the location of the index, and the location of the repositories (–repo-location).
You may optionally pass the option -f to enable a full index rebuild. Without the -f option, indexing will run always in “incremental” mode.
For an incremental index build use:
paster make-index production.ini --repo-location=<location for repos>
For a full index rebuild use:
paster make-index production.ini -f --repo-location=<location for repos>
In order to do periodical index builds and keep your index always up to date. It’s recommended to do a crontab entry for incremental indexing. An example entry might look like this:
/path/to/python/bin/paster /path/to/rhodecode/production.ini --repo-location=<location for repos>
When using incremental mode (the default) whoosh will check the last modification date of each file and add it to be reindexed if a newer file is available. The indexing daemon checks for any removed files and removes them from index.
If you want to rebuild index from scratch, you can use the -f flag as above, or in the admin panel you can check build from scratch flag.
RhodeCode starting from version 1.1 supports ldap authentication. In order to use LDAP, you have to install the python-ldap package. This package is available 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 it check that you have at least openldap, and sasl libraries.
ldap settings are located in admin->ldap section,
Here’s a typical ldap setup:
Enable ldap = checked #controls if ldap access is enabled
Host = host.domain.org #actual ldap server to connect
Port = 389 or 689 for ldaps #ldap server ports
Enable LDAPS = unchecked #enable disable ldaps
Account = <account> #access for ldap server(if required)
Password = <password> #password for ldap server(if required)
Base DN = uid=%(user)s,CN=users,DC=host,DC=domain,DC=org
Account and Password are optional, and used for two-phase ldap authentication so those are credentials to access your ldap, if it doesn’t support anonymous search/user lookups.
Base DN must have the %(user)s template inside, it’s a place holder where your uid used to login would go. It allows admins to specify non-standard schema for the uid variable.
If all of the data is correctly entered, and python-ldap is properly installed, then users should be granted access to RhodeCode with ldap accounts. When logging in the first time a special ldap account is created inside RhodeCode, so you can control the permissions even on ldap users. If such users already exist in the RhodeCode database, then the ldap user with the same username would be not be able to access RhodeCode.
If you have problems with ldap access and believe you have correctly entered the required information then proceed by investigating the RhodeCode logs. Any error messages sent from ldap will be saved there.
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.
There are two ways to enable https:
Sample config for nginx using proxy:
server {
listen 80;
server_name hg.myserver.com;
access_log /var/log/nginx/rhodecode.access.log;
error_log /var/log/nginx/rhodecode.error.log;
location / {
root /var/www/rhodecode/rhodecode/public/;
if (!-f $request_filename){
proxy_pass http://127.0.0.1:5000;
}
#this is important if you want to use https !!!
proxy_set_header X-Url-Scheme $scheme;
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-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_buffer_size 16k;
proxy_buffers 4 16k;
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 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.
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 subdirectory part:
<Location /rhodecode>
ProxyPass http://127.0.0.1:59542/rhodecode
ProxyPassReverse http://127.0.0.1:59542/rhodecode
SetEnvIf X-Url-Scheme https HTTPS=1
</Location>
Besides the regular apache setup you will need to add the following to 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>
TODO !
Some example init.d scripts can be found here, for debian and gentoo:
Q: | Missing static files? |
---|---|
A: | Make sure either to set the static_files = true in the .ini file or double check the root path for your http setup. It should point to for example: /home/my-virtual-python/lib/python2.6/site-packages/rhodecode/public |
Q: | Can’t install celery/rabbitmq |
---|---|
A: | Don’t worry RhodeCode works without them too. No extra setup is required. |
Q: | Long lasting push timeouts? |
---|---|
A: | Make sure you set a longer timeouts in your proxy/fcgi settings, timeouts are caused by https server and not RhodeCode. |
Q: | Large pushes timeouts? |
---|---|
A: | Make sure you set a proper max_body_size for the http server. |
Q: | Apache doesn’t pass basicAuth on pull/push? |
---|---|
A: | Make sure you added WSGIPassAuthorization true. |
For further questions search the Issues tracker, or post a message in the google group rhodecode