<?xml version="1.0" encoding="UTF-8"?>
<chapter id="installation">
   <title>Installation</title>

   <para>Once you have downloaded the distribution you need to install it in a location of your choice.</para>

   <section id="installtargz">
     <title>Compressed Tape Archive (.tar.gz)</title>

     <para>Extract the distribution using</para>

     <programlisting>
tar xzf ironjacamar-1.2.0.Final.tar.gz
     </programlisting>

     <para>The distribution will be located in a directory named</para>

     <programlisting>
ironjacamar-1.2.0.Final
     </programlisting>

   </section>

   <section id="installzip">
     <title>Zip Archive (.zip)</title>

     <para>Extract the distribution using</para>

     <programlisting>
unzip ironjacamar-1.2.0.Final.zip
     </programlisting>

     <para>or any program capable of handling Zip archives such as WinZip and WinRar.</para>

     <para>The distribution will be located in a directory named</para>

     <programlisting>
ironjacamar-1.2.0.Final
     </programlisting>

   </section>

   <section id="directorystructure">
     <title>Directory structure</title>

     <para>The IronJacamar container has the following directory structure:</para>

    <itemizedlist spacing="compact">
      <listitem>
        bin: Contains the scripts that starts the container.
      </listitem>
      <listitem>
        config: Contains the configuration of the container.
      </listitem>
      <listitem>
        deploy: Contains user deployments.
      </listitem>
      <listitem>
        doc: Contains the documentation.
      </listitem>
      <listitem>
        lib: Contains all the libraries needed by the container.
      </listitem>
      <listitem>
        log: Contains the log files for the container.
      </listitem>
      <listitem>
        system: Contains system deployments.
      </listitem>
      <listitem>
        tmp: Contains temporary files.
      </listitem>
    </itemizedlist>

   </section>

   <section id="installas">
     <title>WildFly</title>

     <para>
       The IronJacamar provides the Java EE Connector Architecture (JCA) container
       for WildFly 8 and future versions.
     </para>

     <para>
       The container can be updated in WildFly by using the 
       <code>as-upgrader.sh</code> script in the <code>doc/as</code> directory.
       This will allow an easy installation of IronJacamar patch releases to fix bugs
       in the application server environment.
     </para>

     <para>
       The script can be used, like:
     </para>

     <programlisting>
./as-upgrader.sh 1.2.0.Final /path/to/wildfly/installation
     </programlisting>

     <para>
       where <code>1.2.0.Final</code> is the version identifier of the IronJacamar container
       and the path points to the top-level directory of the WildFly installation.
       You can also use <code>1.1.1-SNAPSHOT</code> in order to upgrade to a patch snapshot build.
     </para>

     <para>
       You can get an overview of all IronJacamar releases by searching our
       <ulink url="https://repository.jboss.org/nexus/">Nexus</ulink> repository.
     </para>

     <warning>
       Make sure that you understand the version policies specified in the developer guide before upgrading
     </warning>

   </section>

</chapter>
