RhodeCode Tools Installation¶
As of RhodeCode Enterprise 3.4.1 RhodeCode Tools is installed automatically on the server with RhodeCode Enterprise. You
do not need to install RhodeCode Tools on the server, but you will need to install them
on machines that need remote access. The tools are linked to the instance
folder, for example
You can list the available tools using the following example, and the valid tools options are those which correspond with those in the RhodeCode Tools section.
$ ls ~/.rccontrol/enterprise-4/profile/bin/ gen_js_i18n rhodecode-cleanup-gists rhodecode-tools svnrdump gen_js_routes rhodecode-cleanup-repos supervisorctl svnserve git rhodecode-config supervisord svnsync gunicorn rhodecode-extensions svn svnversion hg rhodecode-gist svnadmin vcsserver paster rhodecode-index svndumpfilter rc-server rhodecode-list-instances svnlook rhodecode-api rhodecode-setup-config svnmucc
You can then use the tools as described in the RhodeCode Tools section using the following example:
# Running the indexer $ ~/.rccontrol/enterprise-1/profile/bin/rhodecode-index \ --instance-name=enterprise-1 # Cleaning up gists $ ~/.rccontrol/enterprise-4/profile/bin/rhodecode-cleanup-gists \ --instance-name=enterprise-4 Scanning for gists in /home/brian/repos/.rc_gist_store... preparing to remove  found gists
Installing RhodeCode Tools¶
RhodeCode Tools enable you to automate many of the most common RhodeCode Enterprise functions through the API. Installing them on a local machine lets you carry out maintenance on the server remotely. Once installed you can use them to index your repositories to setup full-text search, strip commits, or install RhodeCode Extensions for additional functionality.
For more detailed instructions about using RhodeCode Tools for indexing and full-text search, see Full-text Search
To install RhodeCode Tools, use the following steps:
- Set up a
virtualenvon your local machine, see virtualenv instructions here.
- Install RhodeCode Tools using pip. Full url with token is available at https://rhodecode.com/u/#rhodecode-tools
pip install -I https://dls.rhodecode.com/dls/<token>/rhodecode-tools/latest
Once RhodeCode Tools is installed using these steps there are a few extra configuration changes you can make. These are explained in more detail in the Full-text Search section, and the RhodeCode Tools section.
# Create a virtualenv brian@ubuntu:~$ virtualenv venv New python executable in venv/bin/python Installing setuptools, pip...done. # Activate the virtualenv brian@ubuntu:~$ . venv/bin/activate # Install RhodeCode Tools inside the virtualenv, full url with token is available at https://rhodecode.com/u/#rhodecode-tools $ pip install -I https://dls.rhodecode.com/dls/<token>/rhodecode-tools/latest # Check the installation $ rhodecode-tools --help