diff --git a/docs/setup.rst b/docs/setup.rst old mode 100644 new mode 100755 --- a/docs/setup.rst +++ b/docs/setup.rst @@ -5,16 +5,17 @@ Setup Setting up RhodeCode --------------------------- +-------------------- -First, you will need to create a RhodeCode configuration file. Run the following -command to do this:: +First, you will need to create a RhodeCode configuration file. Run the +following command to do this:: paster make-config RhodeCode production.ini - This will create the file `production.ini` in the current directory. This - configuration file contains the various settings for RhodeCode, e.g proxy port, - email settings, usage of static files, cache, celery settings and logging. + configuration file contains the various settings for RhodeCode, e.g proxy + port, email settings, usage of static files, cache, celery settings and + logging. Next, you need to create the databases used by RhodeCode. I recommend that you @@ -27,19 +28,19 @@ the following command:: 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. +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. - The ``setup-app`` command will create all of the needed tables and an admin - account. When choosing a root path you can either use a new empty location, or a - location which already contains existing repositories. If you choose a location - which contains existing repositories RhodeCode will simply add all of the - repositories at the chosen location to it's database. (Note: make sure you - specify the correct path to the root). + account. When choosing a root path you can either use a new empty location, + or a location which already contains existing repositories. If you choose a + location which contains existing repositories RhodeCode will simply add all + of the repositories at the chosen location to it's database. (Note: make + sure you specify the correct path to the root). - Note: the given path for mercurial_ repositories **must** be write accessible - for the application. It's very important since the RhodeCode web interface will - work without write access, but when trying to do a push it will eventually fail - with permission denied errors unless it has write access. + for the application. It's very important since the RhodeCode web interface + will work without write access, but when trying to do a push it will + eventually fail with permission denied errors unless it has write access. You are now ready to use RhodeCode, to run it simply execute:: @@ -48,7 +49,8 @@ You are now ready to use RhodeCode, to r - This command runs the RhodeCode server. The web 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 the admin account you created above when running ``setup-app`` to login to the web app. +- Use the admin account you created above when running ``setup-app`` to login + to the web app. - The default permissions on each repository is read, and the owner is admin. Remember to update these if needed. - In the admin panel you can toggle ldap, anonymous, permissions settings. As @@ -56,9 +58,9 @@ You are now ready to use RhodeCode, to r 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:: +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/ @@ -67,8 +69,8 @@ where *repository name* is replaced by t Using RhodeCode with SSH ------------------------ -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 +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_) @@ -77,10 +79,10 @@ RhodeCode repository structures are kept 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.) +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 @@ -95,35 +97,41 @@ Note: In an advanced setup, in order for 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. - - Setting up Whoosh full text search ---------------------------------- 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`). +file that stores the location of the index. You may specify the location of the +repositories (`--repo-location`). If not specified, this value is retrieved +from the RhodeCode database. This was required prior to 1.2. Starting from +version 1.2 it is also possible to specify a comma separated list of +repositories (`--index-only`) to build index only on chooses repositories +skipping any other found in repos 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= + paster make-index production.ini For a full index rebuild use:: - paster make-index production.ini -f --repo-location= + paster make-index production.ini -f + -- For full text search you can either put crontab entry for +building index just for chosen repositories is possible with such command:: + + paster make-index production.ini --index-only=vcs,rhodecode + 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= + /path/to/python/bin/paster make-index /path/to/rhodecode/production.ini 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 @@ -138,55 +146,221 @@ Setting up LDAP support ----------------------- 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 +to use LDAP, you have to install the python-ldap_ package. This package is +available via pypi, so you can install it by running -:: +using easy_install:: - easy_install python-ldap + easy_install python-ldap -:: +using pip:: - pip 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, +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 = #access for ldap server(if required) - Password = #password for ldap server(if required) - Base DN = uid=%(user)s,CN=users,DC=host,DC=domain,DC=org - + Connection settings + Enable LDAP = checked + Host = host.example.org + Port = 389 + Account = + Password = + Connection Security = LDAPS connection + Certificate Checks = DEMAND + + Search settings + Base DN = CN=users,DC=host,DC=example,DC=org + LDAP Filter = (&(objectClass=user)(!(objectClass=computer))) + LDAP Search Scope = SUBTREE + + Attribute mappings + Login Attribute = uid + First Name Attribute = firstName + Last Name Attribute = lastName + E-mail Attribute = mail + +.. _enable_ldap: + +Enable LDAP : required + Whether to use LDAP for authenticating users. + +.. _ldap_host: + +Host : required + LDAP server hostname or IP address. + +.. _Port: + +Port : required + 389 for un-encrypted LDAP, 636 for SSL-encrypted LDAP. + +.. _ldap_account: + +Account : optional + Only required if the LDAP server does not allow anonymous browsing of + records. This should be a special account for record browsing. This + will require `LDAP Password`_ below. + +.. _LDAP Password: + +Password : optional + Only required if the LDAP server does not allow anonymous browsing of + records. -`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. +.. _Enable LDAPS: + +Connection Security : required + Defines the connection to LDAP server + + No encryption + Plain non encrypted connection + + LDAPS connection + Enable ldaps connection. It will likely require `Port`_ to be set to + a different value (standard LDAPS port is 636). When LDAPS is enabled + then `Certificate Checks`_ is required. + + START_TLS on LDAP connection + START TLS connection + +.. _Certificate Checks: + +Certificate Checks : optional + How SSL certificates verification is handled - this is only useful when + `Enable LDAPS`_ is enabled. Only DEMAND or HARD offer full SSL security + while the other options are susceptible to man-in-the-middle attacks. SSL + certificates can be installed to /etc/openldap/cacerts so that the + DEMAND or HARD options can be used with self-signed certificates or + certificates that do not have traceable certificates of authority. + + NEVER + A serve certificate will never be requested or checked. + + ALLOW + A server certificate is requested. Failure to provide a + certificate or providing a bad certificate will not terminate the + session. + + TRY + A server certificate is requested. Failure to provide a + certificate does not halt the session; providing a bad certificate + halts the session. + + DEMAND + A server certificate is requested and must be provided and + authenticated for the session to proceed. + + HARD + The same as DEMAND. + +.. _Base DN: -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. +Base DN : required + The Distinguished Name (DN) where searches for users will be performed. + Searches can be controlled by `LDAP Filter`_ and `LDAP Search Scope`_. + +.. _LDAP Filter: + +LDAP Filter : optional + A LDAP filter defined by RFC 2254. This is more useful when `LDAP + Search Scope`_ is set to SUBTREE. The filter is useful for limiting + which LDAP objects are identified as representing Users for + authentication. The filter is augmented by `Login Attribute`_ below. + This can commonly be left blank. + +.. _LDAP Search Scope: + +LDAP Search Scope : required + This limits how far LDAP will search for a matching object. + + BASE + Only allows searching of `Base DN`_ and is usually not what you + want. + + ONELEVEL + Searches all entries under `Base DN`_, but not Base DN itself. + + SUBTREE + Searches all entries below `Base DN`_, but not Base DN itself. + When using SUBTREE `LDAP Filter`_ is useful to limit object + location. + +.. _Login Attribute: + +Login Attribute : required + The LDAP record attribute that will be matched as the USERNAME or + ACCOUNT used to connect to RhodeCode. This will be added to `LDAP + Filter`_ for locating the User object. If `LDAP Filter`_ is specified as + "LDAPFILTER", `Login Attribute`_ is specified as "uid" and the user has + connected as "jsmith" then the `LDAP Filter`_ will be augmented as below + :: + + (&(LDAPFILTER)(uid=jsmith)) + +.. _ldap_attr_firstname: + +First Name Attribute : required + The LDAP record attribute which represents the user's first name. + +.. _ldap_attr_lastname: -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. +Last Name Attribute : required + The LDAP record attribute which represents the user's last name. + +.. _ldap_attr_email: + +Email Attribute : required + The LDAP record attribute which represents the user's email address. + +If all data are entered correctly, and python-ldap_ is properly installed +users should be granted access to RhodeCode with ldap accounts. At this +time user information is copied from LDAP into the RhodeCode user database. +This means that updates of an LDAP user object may not be reflected as a +user update in RhodeCode. + +If You have problems with LDAP access and believe You entered correct +information check out the RhodeCode logs, any error messages sent from LDAP +will be saved there. + +Active Directory +'''''''''''''''' -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. +RhodeCode can use Microsoft Active Directory for user authentication. This +is done through an LDAP or LDAPS connection to Active Directory. The +following LDAP configuration settings are typical for using Active +Directory :: + + Base DN = OU=SBSUsers,OU=Users,OU=MyBusiness,DC=v3sys,DC=local + Login Attribute = sAMAccountName + First Name Attribute = givenName + Last Name Attribute = sn + E-mail Attribute = mail + +All other LDAP settings will likely be site-specific and should be +appropriately configured. +Hook management +--------------- + +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 +. and the second one with hook path. Example hooks +can be found at *rhodecode.lib.hooks*. + + Setting Up Celery ----------------- @@ -204,8 +378,8 @@ In order to start using celery run:: .. note:: - Make sure you run this command from the same virtualenv, and with the same user - that rhodecode runs. + Make sure you run this command from the same virtualenv, and with the same + user that rhodecode runs. HTTPS support ------------- @@ -214,8 +388,8 @@ 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, set `force_https = true` in the ini configuration to force using - https, no headers are needed than to enable https +- 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 @@ -251,13 +425,10 @@ pushes or large pushes:: 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; + 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:: @@ -315,7 +486,8 @@ Apache subdirectory part:: SetEnvIf X-Url-Scheme https HTTPS=1 -Besides the regular apache setup you will need to add the following to your .ini file:: +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 @@ -328,59 +500,24 @@ Add the following at the end of the .ini then change into your choosen prefix -Apache's example WSGI+SSL config --------------------------------- - -virtual host example:: - - - ServerName hg.domain.eu:443 - DocumentRoot /var/www - - SSLEngine on - SSLCertificateFile /etc/apache2/ssl/hg.domain.eu.cert - SSLCertificateKeyFile /etc/apache2/ssl/hg.domain.eu.key - SSLCertificateChainFile /etc/apache2/ssl/ca.cert - SetEnv HTTP_X_URL_SCHEME https - - Alias /css /home/web/virtualenvs/hg/lib/python2.6/site-packages/rhodecode/public/css - Alias /images /home/web/virtualenvs/hg/lib/python2.6/site-packages/rhodecode/public/images - Alias /js /home/web/virtualenvs/hg/lib/python2.6/site-packages/rhodecode/public/js - - WSGIDaemonProcess hg user=web group=web processes=1 threads=10 display-name=%{GROUP} python-path=/home/web/virtualenvs/hg/lib/python2.6/site-packages - - WSGIPassAuthorization On - WSGIProcessGroup hg - WSGIApplicationGroup hg - WSGIScriptAlias / /home/web/apache/conf/hg.wsgi - - - Order deny,allow - Allow from all - - - Order deny,allow - Allow from all - - - - - - ServerName hg.domain.eu - Redirect permanent / https://hg.domain.eu/ - +Apache's WSGI config +-------------------- -HG.WSGI:: +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/') from paste.deploy import loadapp from paste.script.util.logging_config import fileConfig - - fileConfig('/home/web/virtualenvs/hg/config/production.ini') - application = loadapp('config:/home/web/virtualenvs/hg/config/production.ini' + + fileConfig('/home/web/rhodecode/production.ini') + application = loadapp('config:/home/web/rhodecode/production.ini') Other configuration files @@ -421,7 +558,8 @@ Troubleshooting :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`_ +For further questions search the `Issues tracker`_, or post a message in the +`google group rhodecode`_ .. _virtualenv: http://pypi.python.org/pypi/virtualenv .. _python: http://www.python.org/