Loading...
Collabnet Team Forge Connector

Collabnet Team Forge Connector

Download the latest version of the Collabnet Team Forge connector here.


This is the README for the Krugle reference implementation of Collabnet TeamForge (CTF) Source Control Management Interface(SCMI).

System requirements:

* Windows, *nix or OS X
* Java 1.5 or higher
* 100 MB free RAM, for most regular sized repositories. The SCMI might utilize as much as 512
MB for large repositories. If an 'out of memory' exception is thrown, please set the maximum java memory
argument (-Xmx) via scmi-env.bat (windows) and run.sh (*nix).
* Sufficient disk space for SVN working copies which SCMI will crawl. Additional space will be required
depending on the size of the largest project to be indexed. If several large (multiple-gigabyte) projects
is scheduled to be crawled in parallel, the amount of working space required will increase.
* "stateDir" refers to temporary directory containing projects crawled from SCM, which can be configured in
property file.


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

INSTALLATION GUIDE (WINDOWS)

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

1. Pre-requisites:

* A new user for this SCMI application is recommended (not a requirement). e.g: "ctfscmi"
* Make sure you have java 1.5 or higher.
 
2. Uncompress the archive of the CTF SCMI distribution. The path "C:\SCMI\ctf-scmi\"
is recommended.

3. Modify <install location>\scmi.properties

* The file was originally created on *nix OS, therefore an editor supports Unix line feed is required.
(Ultra-Edit is recommended).
* Please make sure using "\\" instead of "\" character in case of Java string
escaping.
* By default, all state files (including checked out working copies) will be stored in the
stateDir sub-directory of the SCMI install path. The path can be customized by setting:
scmi.stateDir=C:\\path\\to\\custom\\stateDir
Change this if disk space runs low, or the stateDir refers to a path which exceeds character limit.
Note: Must be an absolute path.

4. Modify <install location>\run.bat

* Test java command by running "java -version" in command line mode. If the command is not found,
please set system environment variable "JAVA_HOME" and "JRE_HOME" to a proper path.
* Set SCMI_HOME to the <installed location> where you uncompressed SCMI scripts. e.g: "C:\\SCMI\\ctf-scmi\\"

5. Execute run.bat.

6. Validate that the SCMI is running correctly by navigating to:
http://<hostname of SCMI>:<port of SCMI>/status

* The port usually is 8765 (unless modified in scmi.properties).
If the status page of SCMI did not appear, the SCMI didn't start up properly. Please check the activity log
which locates in <install location>\logs\scmi-activity.log

7. Continue to USAGE GUIDE below.

===================================================================================================
INSTALLATION GUIDE (*Nix)
===================================================================================================

1. Pre-requisites:

* A new user for this SCMI application is recommended (not a requirement). e.g: "ctfscmi"
* Make sure you have java 1.5 or higher.

2. Uncompress the archive of the CTF SCMI distribution. The path "/home/<user>/ctf-scmi"
is recommended

3. Modify <install location>\scmi.properties

* By default, all state files (including checked out working copies) will be stored in the
stateDir sub-directory of the SCMI install path. This can be customized by setting:
scmi.stateDir=/path/to/custom/stateDir
Change this if disk space runs low, or the stateDir refers to a path which exceeds character limit.
Note: Must be an absolute path.

4. Modify <install location>/init.d/ctfscmi.sh

* You can execute bin/run.sh from the scmi folder to start installation right away. However, the process has
to be terminated manually. We recommend you to follow the steps below to properly install the SCMI application.
* Uncomment and set the USER variable which locates to the beginning of /init.d/ctfscmi.sh.
E.g: USER=ctfscmi.
* Set the SCMIDIR variable to the install location. E.g: /home/ctfscmi/ctf-scmi
* Make sure MYNAME is unique for every scmi installation. The variable is utilized by ctfscmi.sh to store the
pid of running process.

5. File permissions: change the owner for the entire installation directory

chown -R ctfscmi /home/ctfscmi/ctf-scmi

6. Create a symbol link from /etc/init.d/ctfscmi to <install location>/init.d/ctfscmi.sh

cd /etc/init.d
ln -s /home/ctfcmi/ctf-scmi/init.d/ctfscmi.sh ctfscmi

* Set this script run level. The command depends on your distribution of *nix OS.

If the operating system supports chkconfig (try 'which chkconfig'):

chkconfig --levels 35 ctfscmi on

If your installation runs under Ubuntu Linux:

update-rc.d ctfscmi defaults

If both commands are not available, please refer to OS manual for application run level settings.

7. Start the CTF SCMI:

service ctfscmi start

If service did not start successfully:

a) Switch to root (make sure you run 'su -' so that environment variables are loaded correctly)
and restart the service.
b) Directly execute 'run.sh' using SCMI user, note that the process will have to be killed manually.
c) Check the log file located at <install location>/logs/ctf-activity.log for further infomation.

8. Validate that the SCMI is running correctly by navigating to:
http://<hostname of SCMI>:<port of SCMI>/status

* The port usually is 8765 (unless modified in scmi.properties).
If the status page of SCMI did not appear, the SCMI didn't start up properly. Please check the activity log
which locates in <install location>\logs\scmi-activity.log


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

USAGE GUIDE

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

1. Once the SCMI has been successfully start up, navigate to Krugle Enterprise Search
Appliance (KE) admin page. E.g: http://<hostname>:8080/projects/project_listing.html

2. Create a new SCM repository of the SCMI type.

* Set hostname according to hostname or IP address of the machine hosting this SCMI.
* The scm name can be anything. E.g: "CTF scmi".
* Leave the username and password blank.
* Set port to 8765 (unless modified in scmi.properties)
* Set protocol to HTTP.
* Set path to /repository
* Check project definition check box(for most situation). The CTF-SCMI is able to automatically return project
definitions to hub for further management. If you need to specify a project manually, please refer to the
instructions below.

3. Manually create new project.

* Add a SCM location for the SCM repository which has been created in step 2.

* The location field should be a valid svn url. E.g:

http://svn.apache.org/repos/asf/commons/proper/io/trunk
svn://gcc.gnu.org/svn/gcc/trunk
 
* The parameters field takes URL encoded parameters. Currently supports 'username' and 'password'. E.g:

username=bob&password=secretpassword1
username=anonymous    

NOTE:
a) A blank password will be used if omitting password parameter.
b) The values for username and password must be URL encoded, so any characters which
are not 0-9 a-z A-Z ._-* must be encoded.
See: http://www.w3schools.com/TAGS/ref_urlencode.asp

* Once the project is being crawled, the activities will be logged to <install location>/logs/scmi-activity.log
for further usage.
 

For more information on setting up Krugle Enterprise with these SCMI clients, please refer to
Krugle Enterprise Administration Guide and the SCMI SDK documentation.


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

PLUG-INs

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

Plug-in feature provides an extensible and flexible architecture for SCMI application. Plug-Ins will
be automatically installed after extracting into /plugins directory. Every plug-in holds a properties file which
provides configurations and controls if plug-in is enabled.

All SCMIs include the file-filter plug-in. It will be enabled by default, filtering out known binary file types.
To modify the list of files and directories which should be filtered, edit /plugins/filter.properties


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

KAS PLUG-IN

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

* KAS Plug-in is shipped with CTF-SCMI as default. To enable/disable KAS module, simply change the value
in ctf-kas.propertys. E.g:

enabled=true

* Integration KAS with Krugle Hub module
a) Navigate to any available hub instance previously installed.
b) Navigate to "Configuration" tab from navigating bar and select "Authentication" from the list on left.
c) Click on "Edit" Button.
d) Set "Authentication method" to Krugle Authentication Service(KAS)
Set "Url" to any valid KAS service url. E.g: http://kas.krugle.org:8765/kas
Set "Username" and "password" to the user name and password specified by KAS installation.
Click "Save".

The Krugle Hub module will automatically validate the settings and return to previous page if configuration
is successful.


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

INTEGRATE KRUGLE INTO COLLABNET TEAMFORGE

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

* Krugle can be easily integrated into Collabnet Teamforge site. To apply this, following operations are required.
a) Navigate to any available Teamforge site and log in as site administrator.
b) Select Admin tab from navigating bar and go to "Integrations" menu, then select "Side-wide linked applications" tab.
c) Click "Create" button.
d) Set "Application Name" to any name you prefer. Krugle is recommended.
Set "Url" to http://<your krugle server ip or domain name>/perl/signin.pl. E.g: http://192.168.20.201/perl/signin.pl
Set "Open Link In" radio box to "IFrame".
Check the "Single Sign on Enabled".
e) Log out and re-log in using any of the users who owns proper permissions, you will see "Krugle" appears in navigating bar.



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

LOGGING

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

Log settings can be customized by editing the log4j.properties file.

You can customize the logging level, appender properties, logging format and output pipe. Note that this
change must be made before the SCMI client is started.


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

UPDATE CYCLE

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

The interleave between two scheduled crawling (length of update cycle) can be customized in
<install location>/teamforge-server.properties
E.g:server.crawling.interleave=DAILY
supported options list: TWICE_AN_HOUR, HOURLY, TWICE_A_DAY, DAILY, TWICE_A_WEEK, WEEKLY, TWICE_A_MONTH, MONTHLY, ONCE;



Request Form - Free Download of Krugle Basic

Fill out the form to download Krugle Basic V5.



Fields marked with * are required.


×