Garfio in 5 minutes

Setup

1. Download the "Garfio Standalone" version (i.e.: garfio-server-dist-X.X.zip )
2. unzip garfio-server-dist-X.X.zip
3. cd garfio-server-dist-X.X
4. Start the server:
   • Windows users, run: startup.bat
   • Linux users, run: startup.sh
5. Access http://localhost:9090/ with your browser to see the server running

The standalone server provides

• An administration interface
• A SOAP interface that exposes the service that is accessed from your source control system hooks
• Two built-in users
  • User admin with password admin (has access permissions to the administration console)
  • User client with password client has only access to the webservices published in http://localhost:9090/services/

In this version all data is stored in a HSQL database located in memory. For advance database setup see GarfioEnConfigureOtherDatabase .

Quick start

1. Access http://localhost:9090/. You will see the login page

1. Login with the admin built-in user
   • User: admin
   • Password: admin
2. Now you are in the repositories administration page. A repository is the unit service of Garfio, and links a SCM repository to a tracker instance (follows up). Actions performed in a repository are executed in the issue tracker

1. First you must create a tracker instance, where you provide all the information for allowing Garfio accessing to the tracker. Click on the trackers menu link and then click Add a new mantis instance . After that, fill in the information for accessing that tracker. Take in account that the URL is the one from Mantis Connect, in case you use Mantis BT. Password is the one from GarfioEnActingAs
   • URL: http://mylyn-mantis.sourceforge.net/MantisTest/mc/mantisconnect.php
   • Password: developer
   • Description: mylyn Mantis BT

1. Now that you have created the tracker instance, you can create a repository. Click on the repositories menu link, then click Add a new repository instance
2. Select Mantis BT as tracker type and click Next

1. Select the tracker instance you have already created and type test as the repository name, then click Create

1. Now we are going to simulate a commit message against this new repository in a test mode provided by Garfio, and this will produce changes in the issue tracker you have already catalogued. Before that, you wish to log in into the issue tracker to see this changes afterwards
   • http://mylyn-mantis.sourceforge.net/MantisTest/login_page.php
   • Username: developer
   • Password: developer
2. Select an issue to work with. For example you can use
   • http://mylyn-mantis.sourceforge.net/MantisTest/view.php?id=45
3. Garfio provides a test mode that allows a user to perform a simulated commit message against a Garfio configured repository. You can access it clicking on the test menu link
4. Complete the requested fields, after that click Submit
   • Client username must be a valid user for the tracker, who can log in into the tracker using the password provided when you added the tracker into Garfio. He must be also capable of modifying the issue you want to impact (in this case, issue number 45), and this issue should not be resolved.
   • Repository: you can pick the repository where you want to simulate the commit.
   • Revision: the simulated revision number of the SCM.

1. If everything went fine, you will receive a success message.

1. You can verify that the action was performed on the tracker.

Where to go from here ?

• GarfioEnConfigureOtherDatabase