Download the latest version of the JIRA connector here.
This is the README for the Krugle reference implementation of a JIRA Source Control Management Interface
(SCMI).
Requirements:
* Windows, *nix or OS X
* Java 1.5 or greater
* 100 megabytes of free RAM, for most regular sized repositories. The SCMI may use as much as 512
megabytes on larger repositories. If an 'out of memory' condition occurs, the maximum java memory
argument (-Xmx) can be adjusted in scmi-env.bat (windows) and run.sh (*nix).
WINDOWS INSTALLATION
1. Prepare the windows host
* It is recommended that you create a new user specifically for this SCMI application. "jirascmi"
is a good choice. This is not necessary, especially if this is not a long term install.
* Verify you have java 1.5 or greater.
2. Decompress the contents of the JIRA SCMI distribution. The path "C:\SCMI\jira-scmi\"
is suggested.
3. Edit the settings in <installed location>\jira.properties
* It is likely that this file will have unix newlines, so use an editor more advanced than notepad.
Wordpad is sufficient. You must be sure to use "\\" when a "\" character is needed, because java
will assume these strings use character escapes.
* By default, all state files (including checked out working copies) will be placed in the
stateDir subdirectory of the SCMI install path. This can be changed by setting:
scmi.stateDir=C:\\path\\to\\custom\\stateDir
You might want to change this if you're running out of space where the SCMI is installed,
or if the stateDir directory structure is creating filepaths with too many characters for
Windows to support.
4. Edit the settings in <installed location>\run.bat
* Set JAVA to a command which will invoke java 1.5 or greater. "java" will probably work, and you can
test this by running "java -version" from the command line.
* Set SCMI_HOME to the <installed location> where you unzipped the scripts. If you followed the
suggestion from (2) above, this would be "C:\\SCMI\\jira-scmi\\"
5. Execute run.bat as the appropriate user.
6. Validate that the SCMI is running correctly by pointing your browser to the following URL:
http://<hostname of SCMI>:<port of SCMI>/status
The port usually is 8765 (or what you set in jira.properties).
If this doesn't return a status page the SCMI didn't start up properly. Check the activity log for
details in this case: logs/scmi-activity.log
7. Continue to USAGE instructions below.
*NIX INSTALLATION
1. Prepare the *nix server where the client will be installed
* Verify you have java 1.5 or greater.
* Create a user (e.g. "jirascmi") that will be used to run the client. Not necessary but suggested.
2. Copy and unpack the contents of the JIRA SCMI distribution on your server.
Ideally these files should go into /home/<user>, where <user> is the user you created in step 1 above.
For example, if the SCMI archive name is jira-scmi-1.0.0-release.zip
and you wanted to have the resulting files located at /home/jirascmi/, you would execute:
unzip jira-scmi-1.0.0-release.zip
mv jira-scmi-1.0.0 /home/jirascmi/
3. Change settings in the jira.properties file according to your needs.
* By default, all state files (including checked out working copies) will be placed in the
stateDir subdirectory of the SCMI install path. This can be changed by setting:
scmi.stateDir=/path/to/custom/stateDir
You might want to change this if you're running out of space on the mount where the
SCMI is installed.
4. Change settings in the <installed location>/init.d/jirascmi.sh file to match your server setup.
* Note that you can start right away by executing bin/run.sh from the scmi folder, but to kill that process
you will need to kill its PID by hand. It is suggested you follow the steps below to properly
install the SCMI application.
* Uncomment and set the USER= parameter at the top of /init.d/jirascmi.sh. For the example above, the value
for USER should be set to jirascmi.
* Edit the SCMIDIR= parameter, also at the top of the file. This must match the location where
you unpacked the files, for example /home/jirascmi/jira-scmi-1.0.0
* Make sure MYNAME is unique for every scmi script you may have installed. This will be used
by jirascmi.sh to store the pid of the running process.
5. Set the owner for all the installed files to be the user specified above. For example
chown -R jirascmi /home/jirascmi/jira-scmi-1.0.0
6. Create a symlink from /etc/init.d/jirascmi to <installed location>/init.d/jirascmi.sh
cd /etc/init.d
ln -s /home/jirascmi/jira-scmi-1.0.0/init.d/jirascmi.sh jirascmi
Then set this script to be started at the correct runlevels. The exact method for this will depend on your
flavor of *nix. If your system supports chkconfig (try 'which chkconfig' to test this):
chkconfig --levels 35 jirascmi on
If you have an Ubuntu system you will need to use update-rc.d:
update-rc.d jirascmi defaults
If you do not have chkconfig of update-rc.d commands available, you will need to determine the appropriate
substitute for your OS in order to enable automatic startup.
7. Start the JIRA SCMI by running the service after installation, for example
service jirascmi start
If you experience problems with 'service':
a) Run as root, and if you su to root, make sure you run 'su -' so that paths are setup correctly.
b) If you cannot get the 'service' command to work as intended, you can directly execute 'run.sh'
but this must be done as the SCMI user, and not as root. The process will have to be killed with
the 'kill' command.
Then you should watch the log file located at <installed location>/logs/scmi-activity.log to
ensure the service has started up properly.
8. Validate that the SCMI is running correctly by pointing your browser to the following URL:
http://<hostname of SCMI>:<port of SCMI>/status
The port usually is 8765 (or what you set in jira.properties).
If this doesn't return a status page the SCMI didn't start up properly. Check the activity log for
details in this case: logs/scmi-activity.log
USAGE
1. Once the SCMI script is setup correctly, navigate to your Krugle Enterprise Search
Appliance (KE) admin page. Typically this is http://<hostname>:8080/projects/project_listing.html
2. Create a new SCM repository of the SCMI type.
* The hostname should be set the hostname or IP address of the machine hosting this SCMI.
* The scm name can be anything, "JIRA scmi" is a good start.
* The username and password are blank.
* The port should be set to 8765 (or what you set in jira.properties), and the protocol set
to HTTP.
* The path should be set to /repository
* The project source box should be unchecked for most cases. It should only be set if you are sure
this SCMI is source of project definitions.
3. Create a new project or edit an existing one.
* Add a SCM location for the SCM repository you just created in step 2.
* The location should be set to the base URL to the JIRA system, of the form:
http(s)://<hostname for JIRA system>/jira/
* Fill in the parameters as needed. These are URL-encoded, of the form <key1>=<value1>&<key2>=<value2>
To derive parameter values, use the JIRA Issue Navigator to find the set of desired issues, then
inspect parameters in the URL for the "XML" link in the top section of the JIRA page. You can ignore
the sorter and tempMax parameters.
* Common parameters are:
- pid=xxx : restrict to just issues from the JIRA project with the specified project id. You can
include multiple of these to select a set of project issues.
- resolution=xxx : restrict to just issues with the specified resolution. For example,
resolution=-1 would select only issues that are unresolved.
- fixfor=xxx : restrict to just issues with the specified fix version ID.
- status=xxx : restrict to just issues with the specified status. For example
status=-1 would select only issues that are open.
For more information on setting up Krugle Enterprise with these SCMI clients, please see
the Krugle Enterprise Administration Guide and the SCMI SDK documentation.
PLUGINS
Plugins allow functionality of the SCMI application to be added or modified. A plugin is installed
if it is placed in the /plugins directory. Every plugin has a properties file in the /plugins directory
as well, and this properties file controls various configuration values as well as whether or not the
plugin is enabled.
All SCMIs which crawl source code should include the file-filter plugin. It will be enabled by default
but it will only filter out known binary file types. To modify the list of files and directories filtered
out, edit /plugins/filter.properties
LOGGING
If you wish you may change log settings by editing the log4j.properties file. The first line currently looks like:
log4j.rootLogger = info, ActivityRFA, ErrorRFA
You can increase the amount of information being logged by changing "info" to "debug". Note that this
change must be made before the SCMI client is started.