HeadsUp Development
Agile Quickstart
1 - Requirements and Limitations
Requirements
The HeadsUp Agile system currently requires:
- Sun JDK (Java Development Kit) version 1.5 or later
- subversion, git or mercurial (with command line tools)
- [optional] MySQL if you do not want to use the embedded database
- [optional] Maven if you want to build maven projects
- [optional] Ant if you want to build ant projects
- [optional] Eclipse if you want to build eclipse projects
- [optional] XCode if you want to build iPhone / iPad / MacOSX projects
There is currently only one limitation of the HeadsUp Agile distribution:
- It only runs on Unix based operating systems: Linux, Mac OSX, Solaris etc (no Windows support at this time)
Keep reading for the steps to install HeadsUp Agile.
2 - Installing
If you have all the required software installed then you are ready to install HeadsUp Agile!
Go to http://headsupdev.com/agile/releases/beta/ and download the latest version available.
Next open a terminal / console and unpack the download:
# tar zxvf headsup-1.0-beta-11.tar.gz
Then execute the included binary:
# ./headsup-1.0-beta-11/bin/headsup.sh
Lastly go to your web browser and enter the following url to load the software:
http://localhost:8069/
Once you have loaded the application follow the setup steps which are outlined on the next page.
3 - Setup
The setup steps are pretty simple, but they are outlined here for clarity:
EULA (License Agreement)
You are presented with the basic agreement for the beta testing, if you agree then click the "I accept the terms..." checkbox and click "Continue".
Configure Database
The default database should be suitable for most peope testing the software - if you are not sure just click "Save"
If you would like to use your own MySQL database then you will need to create the database and allocate all permissions to a user account. Then click on the "h2" drop down choice and choose "mysql". You will need to enter your database details to the other fields of the database configuration panel and click "Save" - the installation will then restart using your database.
If you use your own database please ensure that these details are correct before clicking "Save"!
Software Updates
For beta testing you should click "Check for Pre-Release Updates" checkbox and enter the username and password that you used to download the software. Entering your details here will mean that future updates will be found automatically and you will be informed when the update should be performed. You can leave this area blank but you will need to go back to the HeadsUp Development site to download new versions.
Note that this beta software expires periodically which will require an update to be downloaded. This software update option will handle the upgrades for you.
Create Admin
The last step is to create an administrator. The first user in the system will be the system administrator who will be able to add projects, create users and configure the installation. We recommend that you do not use a regular users details for this account as it should only be used for administration.
Future user accounts should be created with a username that matches the subversion accounts for optimal integration and traceability.
Once you have created an administrator you will be asked to log in and your setup will be complete! Before we add a project to the system it is a good idea to check that the system configuration is suitable for your installation.
4 - Configuration
Before adding a project to HeadsUp Agile we will check the configuration options. Click on the "system configuration" link or log in and go to the "admin" application, choose "configuration" and then "system".
Here you should check the values for baseUrl, dataDir and smtp.host. These are used throughout the system so should be setup correctly. The baseUrl is used in notifications to provide a link back to the system, the smtp.host value is used to send notification emails and the dataDir specifies where data should be stored. Changing dataDir at this point is simple but if you wish to change it later you will need to move the data to the new location before restarting the software.
Once you are happy with the configuration we can add a project!
5 - Add a Project
Before HeadsUp Agile is usable for project management or as a developer support tool you will need to add a project.
Ideally we would recommend installing your own project but we have provided our own demo projects to help in your testing.
To add your own project simply click "import a project" on the setup pages and login or, if you have already logged in, go to the "admin" application and click on the "add-project" link in the menu bar and enter the URL to your project in subversion.
To use one of our demo projects please read the relevant pages listed below. We recommend reading the relevant demo pages for any information on your specific project environment.
If your environment is not listed below then you can still add the project and manage it's development but the build server will not be able to build your project without further configuration and possibly the installation of supporting tools.
5.1 - Add a Maven Demo
Before installing a Maven project please ensure you have maven installed. You should be able to execute the command "mvn" on your terminal or console. If not please follow the instructions at maven.apache.org.
To add your own project simply go to the "admin" application and click on the "add-project" link in the menu bar. Then enter the following url into the scm url field:
http://svn.headsupdev.org/demo/projects/trunk/demo-maven
Leave the username and password fields blank and click on "Add Project". Once it has downloaded the files it will confirm the projects you are loading - just click "Confirm" and the project will be loaded.
You now have a Maven project loaded in your HeadsUp Agile installation go to the "history" application and you will see it's change log.
5.2 - Add an Ant Demo
Before installing an Ant project please ensure you have ant installed. You should be able to execute the command "ant" on your terminal or console. If not please follow the instructions at ant.apache.org.
To add your own project simply go to the "admin" application and click on the "add-project" link in the menu bar. Then enter the following url into the scm url field:
http://svn.headsupdev.org/demo/projects/trunk/demo-ant
Leave the username and password fields blank and click on "Add Project". Once it has downloaded the files it will confirm the projects you are loading - just click "Confirm" and the project will be loaded.
You now have an Ant project loaded in your HeadsUp Agile installation go to the "history" application and you will see it's change log.
5.3 - Add an Eclipse Demo
Before installing an Eclipse project please ensure you have eclipse installed. If not please follow the instructions at eclipse.org.
To add your own project simply go to the "admin" application and click on the "add-project" link in the menu bar. Then enter the following url into the scm url field:
http://svn.headsupdev.org/demo/projects/trunk/demo-eclipse
Leave the username and password fields blank and click on "Add Project". Once it has downloaded the files it will confirm the projects you are loading - just click "Confirm" and the project will be loaded.
You now have an Eclipse project loaded in your HeadsUp Agile installation go to the "history" application and you will see it's change log.
5.4 - Add an XCode Demo
Before installing an XCode project please ensure you have XCode or the MacOSX developer tools installed. If not please follow the instructions at apple.com (note that you will need a MacOSX computer with an Intel CPU).
To add your own project simply go to the "admin" application and click on the "add-project" link in the menu bar. Then enter the following url into the scm url field:
http://svn.headsupdev.org/demo/projects/trunk/demo-iphone
Leave the username and password fields blank and click on "Add Project". Once it has downloaded the files it will confirm the projects you are loading - just click "Confirm" and the project will be loaded.
You now have an XCode project loaded in your HeadsUp Agile installation go to the "history" application and you will see it's change log.
