Skip to main content
Jump to: navigation, search


< Recommenders
Revision as of 13:15, 7 November 2011 by (Talk | contribs) (added important parameters to allow codesearch through a proxy)


  • Decent Linux/Win/Mac box with 2GHz, 2G RAM and Java 6 or better.
  • Apache CouchDB 2.0 or higher (not officially released)
  • Code Recommenders Team Server 0.4 or higher


Apache CouchDB

Code Recommenders Team Server

  • Download Code Recommenders latest team server ( from here. Note, the server platform is build-independent although the name suggests something different.
  • Unzip to any directory on your local disc. This directory is referred to as $SERVER_HOME from here on.
  • Start the server by executing $SERVER_HOME/ (you may set the x-flag to execute the script). The server now starts with a OSGI console.
  • In the console enter "initCouchdb". This creates and initializes all databases on the local Apache CouchDB instance.

You are done. The base system is up and running for/on localhost. To gracefully stop the server you should enter "close" in the OSGi console.

If you want to run the server as a background daemon, there are two convenience scripts to do that. It is neccessary to create a user named "recommenders" or to change the "user" parameter in these scripts accordingly. To start the server simply type

To stop it:

Server Configuration

Extdoc Platform

Database needs to be filled. Next, the generators have to be executed on the server's osgi console.

Calls Code Completion

Database needs to be filled. Next, the generators have to be executed on the server's osgi console.

Code Search

In $SERVER_HOME/configuration/config.ini, the code search server url has to be modified to point to your actual service that offers the source code files.


Next, a search index has to be created, summaries need to be published in CouchDB, and a source zip file has to be pushed on the server. This is yet not automated.

NOTE: baseurl MUST be fully qualified including the port number. Apache HTTPD proxy rewrites all incoming URLs and unescapes all slashes used for type names and thus results in 404 when using code search. (codesearch/source%2FLorg%2FMyclass --> codesearch/source/Lorg/Myclass --> 404 since this url identifies a non-existant reosurce).

TODO: this should be simplified. Every installation needs to change the baseurl. Is there a simple way to figure out under which IP/name the JAX-RS webservice was queried?

TODO: create an upload interface for code search to ease creating a code search database.

Client Configuration

Update your clients to use the new server instead of Code Recommenders' default server by changing the following urls in Preferences>>Code Recommenders:

See Recommenders/TeamServer#User Friendly URLs to see how to get rid of the port numbers.

Building Models

All data is stored in CouchDB or on local disk in $SERVER_HOME/recommenders/ (actually we use the working directory, i.e. $WORKING_DIR/recommenders, which should be the same in most cases).

To generate new models, enter the OSGI console of your server and enter "generateModels". That's it. After generation passed, your clients will automatically download the latest models.

TODO: Point to a crowd-sourcing page and explain that data needs to be uploaded by the clients into the team server.

TODO: explain how to set up a cron-job to generate new extdoc and calls models on a nightly basis.

Optional Configuration

User Friendly URLs

Code Recommenders server is per default started on port 29750. You may override this by editing $SERVER_HOME/configuration/configuration.ini or by using an existing Apache HTTPD server as proxy. How to use an existing Apache HTTPD as proxy is shown below:

In /etc/apache2/mods-enabled/proxy.conf add:

<IfModule mod_proxy.c>

       ProxyPass /udc http://localhost:29750/udc
       ProxyPassReverse /udc http://localhost:29750/udc

       ProxyPass /extdoc http://localhost:5984/extdoc
       ProxyPassReverse /extdoc http://localhost:5984/extdoc

       # it is important to use the keyword "nocanon" otherwise %2F from the URL
       # are unescaped and incorrectly interpreted as a path by the webservice
       ProxyPass /codesearch http://localhost:29750/codesearch nocanon
       ProxyPassReverse /codesearch http://localhost:29750/codesearch

Additionally it is important, that AllowEncodedSlashes is enabled in your virtual host:

<VirtualHost *:80>
       ServerAdmin webmaster@localhost
       DocumentRoot /var/www

       # to allow %2F in urls
       AllowEncodedSlashes On

Next, enable the required modules and restart the server:

root@host:# a2enmod proxy
root@host:# a2enmod proxy_http
root@host:# service apache2 restart

Back to the top