<span class="since">(since 2.0)</span> the configure task is deprecated. Use the <a href="settings.html">setting</a> declaration<br/> The configure task is used to configure ivy with an xml settings file.<br/><br/> See <a href="../configuration.html">settings</a> for details about the settings file itself.<br/><br/> <i>Note for developers:<br/> After the call to this task, a reference to the configured ivy instance used by all subsequent ant tasks is put in the ant project, under the id "ivy.instance".</i> <span class="since">since 2.0</span> The file loaded used to be called configuration file in versions prior to 2.0. The name 'settings' and the use of the ivy.settings.file is new to 2.0. <table class="ant"> <thead> <tr><th class="ant-att">Attribute</th><th class="ant-desc">Description</th><th class="ant-req">Required</th></tr> </thead> <tbody> <tr><td>file</td><td>path to the settings file to use</td> <td rowspan="2">No. If a file is provided, url is ignored. If none are provided, then it attempts to find a file at ${ivy.settings.file}, and if this file does not exist, it uses a <a href="../samples/ivysettings-default.xml">default settings file</a></td></tr> <tr><td>url</td><td>url of the settings file to use</td></tr> <tr><td>host</td><td>http authentication host</td><td rowspan="4">No, unless authentication is required</td></tr> <tr><td>realm</td><td>http authentication realm</td></tr> <tr><td>username</td><td>http authentication user name</td></tr> <tr><td>passwd</td><td>http authentication password</td></tr> </tbody> </table> <h2>HTTP Authentication</h2> <i>Note: HTTP Authentication can be used only if <a href="http://jakarta.apache.org/commons/httpclient/">commons-httpclient.jar</a> is in your classpath</i> If any of the url you use in ivy (especially in dependency resolvers) need http authentication, then you have to provide the host, realm, username and passwd attributes of the configure task. These settings will then be used in any further call to ivy tasks.<br/><br/> <b>Since 1.4:</b> It's also possible to configure authentication settings for multiple urls. This can be done with the <credentials> subelements. See the examples for more details. <h2>Examples</h2> <h3>Simplest settings</h3> <code><ivy:configure /></code> Use either ${ivy.settings.file} if it exists, or the <a href="../samples/ivysettings-default.xml">default settings file</a> <h3>Configure with a file</h3> <code><ivy:configure file="myconffile.xml" /></code> <h3>Configure with an url</h3> <code><ivy:configure url="http://mysite.com/myconffile.xml" /></code> <h3>Configure multiple URLs which require autentication</h3> <code> <ivy:configure file="path/to/my/ivysettings.xml"> <credentials host="myhost.com" realm="My Realm" username="myuser" passwd="mypasswd" /> <credentials host="yourhost.com" realm="Your Realm" username="myuser" passwd="myotherpasswd" /> </ivy:configure> </code>