| 1 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|---|
| 2 | <html>
|
|---|
| 3 | <head>
|
|---|
| 4 | <title>Ant Installer</title>
|
|---|
| 5 | <link href="style.css" type="text/css" rel="stylesheet">
|
|---|
| 6 | <link href="css/nav.css" rel="stylesheet" type="text/css">
|
|---|
| 7 | <link rel="SHORTCUT ICON" type="image/png" href="images/antinstaller-icon.png">
|
|---|
| 8 | <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|---|
| 9 | <meta name="keywords"
|
|---|
| 10 | content="Ant, installer, AntInstall, gui, console, input, parameters, properties, swing, user interface, validation, configuration">
|
|---|
| 11 | <script type="text/javascript" src="js/menu.js"></script>
|
|---|
| 12 | <script type="text/javascript" src="js/sstree.js"></script>
|
|---|
| 13 | <script type="text/javascript" src="js/winfix.js"></script>
|
|---|
| 14 | </head>
|
|---|
| 15 | <body onload="collapseAll('contents-panel', ['ol']); "><div id="tpallcontent">
|
|---|
| 16 | <table cellspacing="0" width="100%">
|
|---|
| 17 | <tbody>
|
|---|
| 18 | <tr class="tpheader">
|
|---|
| 19 | <th class="tpleft">
|
|---|
| 20 | <a target="_top" href="index.html" title="home"><img src="images/ant-install-small.png" alt="AntInstaller" id="logo" width="76" height="50"/></a>
|
|---|
| 21 | <script type="text/javascript">winFix();</script>
|
|---|
| 22 | </th>
|
|---|
| 23 | <th class="tptop" valign="bottom">
|
|---|
| 24 | <img src="space.gif" height="1" width="440" alt="spacer"/><br/>
|
|---|
| 25 |
|
|---|
| 26 | <table>
|
|---|
| 27 | <tr>
|
|---|
| 28 | <td valign="top">
|
|---|
| 29 | <div class="tpheadertitle">AntInstaller</div>
|
|---|
| 30 | <!--img src="images/ant-install-title.png" alt="AntInstaller"/-->
|
|---|
| 31 | </td>
|
|---|
| 32 | <td width="100%" align="right" valign="bottom" nowrap="NOWRAP">
|
|---|
| 33 | <div class="tpraised">
|
|---|
| 34 | <a class="tpbutton" target="_top" href="index.html">home</a>
|
|---|
| 35 | <a class="tpbutton" target="_top" href="http://sourceforge.net/project/showfiles.php?group_id=123466&package_id=134917">download</a>
|
|---|
| 36 | <a class="tpbutton" target="_top" href="http://sf.net">sourceforge</a>
|
|---|
| 37 | <a class="tpbutton" target="_top" href="manual-ant.html">antmanual</a>
|
|---|
| 38 | <a class="tpbutton" target="_top" href="http://sourceforge.net/tracker/?group_id=123466&atid=696615">RFEs</a>
|
|---|
| 39 | <a class="tpbutton" target="_top" href="http://sourceforge.net/tracker/?group_id=123466&atid=696612">Bugs</a></div>
|
|---|
| 40 | </td>
|
|---|
| 41 | </tr>
|
|---|
| 42 | </table>
|
|---|
| 43 | </th>
|
|---|
| 44 | </tr>
|
|---|
| 45 | <tr class="tpbody">
|
|---|
| 46 | <td class="tpleft" valign="bottom">
|
|---|
| 47 | <br/>
|
|---|
| 48 | <div id="logoset">
|
|---|
| 49 | <a target="_top" href="http://sourceforge.net"><img src="http://sourceforge.net/sflogo.php?group_id=123466&type=2" alt="SourceForge.net Logo" border="0" height="37" width="125"></a>
|
|---|
| 50 | <br/><br/>
|
|---|
| 51 | <a target="_top" href="http://sourceforge.net/donate/index.php?group_id=123466">
|
|---|
| 52 | <img src="http://sourceforge.net/images/project-support.jpg" alt="donate to AntInstaller"/>
|
|---|
| 53 | </a>
|
|---|
| 54 | </div>
|
|---|
| 55 | </td>
|
|---|
| 56 | <td class="tpright" valign="top">
|
|---|
| 57 | <div class="tpcontent">
|
|---|
| 58 | <!--[segment-content] page content start -->
|
|---|
| 59 | <h2>Quick Start</h2>
|
|---|
| 60 | A quick start demo application is provided for those who don't like reading documentation <img src="images/smiley.png" align="top" alt="smiley"/> <br/><br/>
|
|---|
| 61 |
|
|---|
| 62 | The example application is in the demo directory and installs a "hello world" application to a user selected directory. Look at the <code>antinstall-config.xml</code> file to see how the installer UI is configured and the <code>build.xml</code> file should be familiar to users of Ant. <br/><br/>
|
|---|
| 63 |
|
|---|
| 64 | Run the installer with the start script and look at the <code>ant.install.properties</code> file to see how the properties have been collected from the user and look at the <code>ant.install.log</code> to see the results of the install. N.B. passwords do not appear in the properties file but are passed to Ant at runtime. If the properties cannot be written to the curent directory it will silently be ommited this is to facilitate installing from read-only media. To view the properties file for debug purposes ensure you have write permissions to the current directory. <br/><br/>
|
|---|
| 65 |
|
|---|
| 66 | You should then look at the <code>build-demo.xml</code> file to see how to create a self-extracting jar.<br/><br/>
|
|---|
| 67 |
|
|---|
| 68 | N.B. You could build the self extracting jar for your installer with any jar tool but using Ant is highly recommended. There is an Ant task to create your installer jar called
|
|---|
| 69 | <a href="installertask.html" title="installer Ant task" id="installer-task"><installer></a>.
|
|---|
| 70 | <br/><br/>
|
|---|
| 71 | There are three methods for running AntInstaller, the demo uses the SelfExtractor.
|
|---|
| 72 | <ol>
|
|---|
| 73 | <li><a href="manual.html#extractor" title="SelfExtractor">SelfExtractor</a> - a single Jar file that is extracted into a temporary directory before the UI is shown.</li>
|
|---|
| 74 | <li><a href="manual.html#non-extractor" title="NonExtractor">NonExtractor</a> - a single Jar file which runs the UI, during the Ant phase resoureces can be extracted from the Jar with the unjar Ant task.</li>
|
|---|
| 75 | <li><a href="manual.html#scripts" title="Scripted Installs">Scripted Installs</a> - a directory structure is delivered, for example a CD, the installer is launched with a script.</li>
|
|---|
| 76 | </ol>
|
|---|
| 77 | <br/>
|
|---|
| 78 |
|
|---|
| 79 | <h2>Order of events</h2>
|
|---|
| 80 | AntInstall takes the following steps to run an install.
|
|---|
| 81 | <ul>
|
|---|
| 82 | <li>If installing from the self-extracting jar, the first thing is to extract the whole Jar to a temporary directory. The NonExtractor mode runs straight from the Jar leaving extracting resources to the Ant stage.</li>
|
|---|
| 83 | <li>AntInstaller then checks to see if graphical user interface can be run or if it should use the text/console UI</li>
|
|---|
| 84 | <li>Either the Swing GUI or text UI is launched, the user fills in the required properties and/or selects from the options. Properties will be collected and a list of Ant targets to run will be made.</li>
|
|---|
| 85 | <li>AntInstaller writes out the properties selected in file in the current directory (or the temporary directory if loading from the self extracting jar)</li>
|
|---|
| 86 | <li>Ant is launched and looks for the build.xml file. The properties are passed to Ant. </li>
|
|---|
| 87 | <li>The Ant targets selected are then run in order, potentially re-running tasks if you have depends attributes in the build.xml script. (not recommended)</li>
|
|---|
| 88 | <li>The Progress page allows users in the GUI to view or ignore the Ant output. The text console will have all the ant output shown.</li>
|
|---|
| 89 | <li>Assuming no exceptions, the installer can then be exited.</li>
|
|---|
| 90 | </ul>
|
|---|
| 91 | <a name="wizard"></a>
|
|---|
| 92 | <h2>Project Wizard</h2>
|
|---|
| 93 | There is a wizard to help generate the files for your installer.
|
|---|
| 94 | The tool assumes you have a standard Java project structure with a root directory for your projects and a base directory for each project. For example, if you use Eclipse the projects root directory is your workspace and the project directory would be the module name in CVS. The directory structure is not imposed but it sets some defaults.<br/><br/>
|
|---|
| 95 |
|
|---|
| 96 | <b>Usage</b><br/>
|
|---|
| 97 | Run the wizard script and enter the projects root (workspace) and short name which is the name of the subdirectory under projects root where the resources for the project exist.<br/><br/>
|
|---|
| 98 | <img src="images/wizard/wizard_main.png" alt="Main directories window" width="472" height="400"/><br/><br/>
|
|---|
| 99 |
|
|---|
| 100 | If you don't have a specific license for your project leave the default.<br/><br/>
|
|---|
| 101 |
|
|---|
| 102 | Click next, and select the components for the installer. For each box checked you will be asked for a directory.<br/><br/>
|
|---|
| 103 | <img src="images/wizard/wizard_select.png" alt="Select components window" width="472" height="400"/><br/><br/>
|
|---|
| 104 |
|
|---|
| 105 | When you have selected the directories in the subsequent pages, click the Create Project button and the wizard creates the files listed below.<br/><br/>
|
|---|
| 106 | <img src="images/wizard/wizard_run.png" alt="Run wizard window" width="472" height="400"/><br/><br/>
|
|---|
| 107 |
|
|---|
| 108 | <ul>
|
|---|
| 109 | <li><b>antinstall-config.xml</b> - basic configuration for the UI</li>
|
|---|
| 110 | <li><b>build.xml</b> - the build file to be run during the installation</li>
|
|---|
| 111 | <li><b>create-installer.xml</b> - an Ant build script to build the installer</li>
|
|---|
| 112 | <li><b>[Project short name]-installer.jar</b> - the installer jar (if you selected the create installer box)</li>
|
|---|
| 113 | <li><b>build-self-extractor.sh</b> - linux build script in case you dont have Ant installed (nothing complex if you need to convert this to windows)</li>
|
|---|
| 114 | </ul>
|
|---|
| 115 | It is not expected that the installer created by this wizard will be the installer of your dreams
|
|---|
| 116 | <img src="images/smiley.png" align="top" alt="smiley"/><br/>
|
|---|
| 117 | Presumably you chose AntInstaller for its infinite flexibility, so now you customise and configure the installer to meet your needs.<br/><br/>
|
|---|
| 118 |
|
|---|
| 119 | The wizard gives you a starting point. From here you will probably want to copy sections of <code>create-installer.xml</code> into your own Ant build, add user properties and targets to <code>antinstall-config.xml</code> and develop the <code>build.xml</code> that is run during the install.<br/><br/>
|
|---|
| 120 |
|
|---|
| 121 | For a detailed guide to the features of AntInstaller the <a href="manual.html#config">manual</a> as a reference for the <code>antinstall-config.xml</code> file and the <a href="manual/manual/index.html">Ant documentation</a> for the <code>build.xml</code> file.
|
|---|
| 122 | <!-- content end [segment-end]-->
|
|---|
| 123 | </div>
|
|---|
| 124 | </td>
|
|---|
| 125 | </tr>
|
|---|
| 126 | </tbody>
|
|---|
| 127 | </table>
|
|---|
| 128 | <div id="contents-panel">
|
|---|
| 129 | <!--[segment-file://contents-include.html] menu start -->
|
|---|
| 130 | <div id="contents-menu">
|
|---|
| 131 | <ol class="sidebar" id="root">
|
|---|
| 132 | <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><b>Site map</b>
|
|---|
| 133 | <ol>
|
|---|
| 134 | <li class="sidebar"><a href="introduction.html">Introduction</a></li>
|
|---|
| 135 | <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><b>Developer References</b>
|
|---|
| 136 | <ol>
|
|---|
| 137 | <li class="sidebar"><a href="quickstart.html">Quick Start</a></li>
|
|---|
| 138 | <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><a href="manual.html">Manual</a>
|
|---|
| 139 | <ol class="init-hidden">
|
|---|
| 140 | <li class="sidebar"><a href="manual.html#config">antinstall-config.xml</a></li>
|
|---|
| 141 | <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><a href="manual.html#page">Pages</a>
|
|---|
| 142 | <ol class="init-hidden">
|
|---|
| 143 | <li class="sidebar"><a href="manual.html#pagesplash">Splash Page</a></li>
|
|---|
| 144 | <li class="sidebar"><a href="manual.html#pagetext">Text Page</a></li>
|
|---|
| 145 | <li class="sidebar"><a href="manual.html#pagelicense">License Page</a></li>
|
|---|
| 146 | <li class="sidebar"><a href="manual.html#pageinput">Input Page</a></li>
|
|---|
| 147 | <li class="sidebar"><a href="manual.html#pageprogress">Progress Page</a></li>
|
|---|
| 148 | </ol>
|
|---|
| 149 | </li>
|
|---|
| 150 | <li class="panel"><a href="#default" class="folder" onclick="toggle(this)"></a><a href="manual.html#inputtypes">Input types</a>
|
|---|
| 151 | <ol class="init-hidden">
|
|---|
| 152 | <li class="sidebar"><a href="manual.html#app-root">Application Root</a></li>
|
|---|
| 153 | <li class="sidebar"><a href="manual.html#checkbox">Checkbox</a></li>
|
|---|
| 154 | <li class="sidebar"><a href="manual.html#comment">Comment</a></li>
|
|---|
| 155 | <li class="sidebar"><a href="manual.html#date">Date</a></li>
|
|---|
| 156 | <li class="sidebar"><a href="manual.html#directory">Directory</a></li>
|
|---|
| 157 | <li class="sidebar"><a href="manual.html#file">File</a></li>
|
|---|
| 158 | <li class="sidebar"><a href="manual.html#large-select">Large Select</a></li>
|
|---|
| 159 | <li class="sidebar"><a href="manual.html#password">Password Text</a></li>
|
|---|
| 160 | <li class="sidebar"><a href="manual.html#password-confirm">Confirm Password</a></li>
|
|---|
| 161 | <li class="sidebar"><a href="manual.html#select">Select</a></li>
|
|---|
| 162 | <li class="sidebar"><a href="manual.html#target">Target</a></li>
|
|---|
| 163 | <li class="sidebar"><a href="manual.html#target-select">Target Select</a></li>
|
|---|
| 164 | <li class="sidebar"><a href="manual.html#text">Unvalidated Text</a></li>
|
|---|
| 165 | <li class="sidebar"><a href="manual.html#validated">Validated Text</a></li>
|
|---|
| 166 | <li class="sidebar"><a href="manual.html#extvalidated">Externally Validated Text</a></li>
|
|---|
| 167 | </ol>
|
|---|
| 168 | </li>
|
|---|
| 169 | <li class="sidebar"><a href="manual.html#extractor">Self Extractor</a></li>
|
|---|
| 170 | <li class="sidebar"><a href="manual.html#non-extractor">Non Extractor</a></li>
|
|---|
| 171 | <li class="sidebar"><a href="manual.html#scripts">Start Scripts</a></li>
|
|---|
| 172 | <li class="sidebar"><a href="manual.html#refs">Dynamic References</a></li>
|
|---|
| 173 | <li class="sidebar"><a href="manual.html#pagedisplay">Page Displaying</a></li>
|
|---|
| 174 | </ol>
|
|---|
| 175 | </li>
|
|---|
| 176 | <li class="sidebar"><a href="installertask.html">Installer Ant task</a></li>
|
|---|
| 177 | <li class="sidebar"><a href="validationofconfig.html">Validation of config</a></li>
|
|---|
| 178 | <li class="sidebar"><a href="lookandfeels.html">LookAndFeels</a> <br/>(inc screenshots)</li>
|
|---|
| 179 | <li class="sidebar"><a href="classpathresources.html">Resources/Classpath issues</a></li>
|
|---|
| 180 | <li class="sidebar"><a href="i18n.html">Internationalisation</a></li>
|
|---|
| 181 | <li class="sidebar"><a href="auto.html">Automated installs</a></li>
|
|---|
| 182 | <li class="sidebar"><a href="installtypes.html">Multiple install types</a></li>
|
|---|
| 183 | <li class="sidebar"><a href="posttargets.html">Post display targets</a></li>
|
|---|
| 184 | <li class="sidebar"><a href="icons.html">Button Icons</a></li>
|
|---|
| 185 | <li class="sidebar"><a href="antinstall-config-example.html">Example antinstall-config.xml</a></li>
|
|---|
| 186 | </ol>
|
|---|
| 187 | </li>
|
|---|
| 188 | <li class="sidebar"><a href="manual-ant.html">Ant Manual</a></li>
|
|---|
| 189 | <li class="sidebar"><a href="antlinks.html">Ant links</a></li>
|
|---|
| 190 | <li class="sidebar"><a href="userusage.html">User usage</a></li>
|
|---|
| 191 | <li class="sidebar"><a href="licenses.html">Licenses</a></li>
|
|---|
| 192 | <li class="sidebar"><a href="potentialuses.html">Potential uses</a></li>
|
|---|
| 193 | <li class="sidebar"><a href="roadmap.html">Road Map</a></li>
|
|---|
| 194 | <li class="sidebar"><a href="wanted.html">Wanted</a></li>
|
|---|
| 195 | <li class="sidebar"><a href="dtds.html">DTDs</a></li>
|
|---|
| 196 | <li class="sidebar"><a href="changelog.html">Changelog</a></li>
|
|---|
| 197 | <li class="sidebar"><a href="http://sourceforge.net/projects/antinstaller">Project page on SourceForge</a></li>
|
|---|
| 198 | <li class="sidebar"><a href="java2html/antinstaller/index.html">Java2HTML (main)</a></li>
|
|---|
| 199 | <li class="sidebar"><a href="java2html/ext/index.html">Java2HTML (extensions)</a></li>
|
|---|
| 200 | <li class="sidebar"><a href="http://antinstaller.cvs.sourceforge.net/antinstaller">Public CVS over HTTP</a></li>
|
|---|
| 201 | <li class="sidebar"><a href="http://sourceforge.net/sendmessage.php?touser=616485">Contact AntInstaller Admin</a></li>
|
|---|
| 202 | </ol>
|
|---|
| 203 | </li>
|
|---|
| 204 | </ol>
|
|---|
| 205 | <br/>
|
|---|
| 206 | <br/>
|
|---|
| 207 | </div>
|
|---|
| 208 |
|
|---|
| 209 |
|
|---|
| 210 | <!-- menu end [segment-end]-->
|
|---|
| 211 | </div>
|
|---|
| 212 | <div id="contents-options">
|
|---|
| 213 | <a id="toggle" href="#" onclick="toggleMenu(); return false;">show menu</a>
|
|---|
| 214 | </div>
|
|---|
| 215 |
|
|---|
| 216 | </div>
|
|---|
| 217 | </body>
|
|---|
| 218 | </html>
|
|---|
