source: server/other/virtuoso.xml@ 55d9118

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY virtuoso-download-http "&sourceforge-repo;/virtuoso/virtuoso-opensource-&virtuoso-version;.tar.gz">
  <!ENTITY virtuoso-download-ftp  " ">
  <!ENTITY virtuoso-md5sum        "88885e84e8f7b61e59516f696b1d3be5">
  <!ENTITY virtuoso-size          "111 MB">
  <!ENTITY virtuoso-buildsize     "761 MB (additional 2 GB to run the test suite)">
  <!ENTITY virtuoso-time          "3.9 SBU (additional 22 SBU to run the test suite)">
]>

<sect1 id="virtuoso" xreflabel="Virtuoso-&virtuoso-version;">
  <?dbhtml filename="virtuoso.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>Virtuoso-&virtuoso-version;</title>

  <indexterm zone="virtuoso">
    <primary sortas="a-Virtuoso">Virtuoso</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to Virtuoso</title>

    <para><application>Virtuoso</application> is a cross-platform server that
    implements multiple server-side protocols as part of a single-server product
    offering. There is one server product that offers WebDAV/HTTP, Application,
    and Database-server functionality alongside Native XML Storage, Universal
    Data-Access Middleware, Business Process Integration and a Web-Services
    Platform.</para>

    &lfs73_built;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>Download (HTTP): <ulink url="&virtuoso-download-http;"/></para>
      </listitem>
      <listitem>
        <para>Download (FTP): <ulink url="&virtuoso-download-ftp;"/></para>
      </listitem>
      <listitem>
        <para>Download MD5 sum: &virtuoso-md5sum;</para>
      </listitem>
      <listitem>
        <para>Download size: &virtuoso-size;</para>
      </listitem>
      <listitem>
        <para>Estimated disk space required: &virtuoso-buildsize;</para>
      </listitem>
      <listitem>
        <para>Estimated build time: &virtuoso-time;</para>
      </listitem>
    </itemizedlist>

<!--
    <bridgehead renderas="sect3">Additional Downloads</bridgehead>
    <itemizedlist spacing='compact'>
      <listitem>
        <para>Required patch: <ulink
        url="&patch-root;/virtuoso-&virtuoso-version;-fixes-1.patch"/></para>
      </listitem>
    </itemizedlist>
-->

    <bridgehead renderas="sect3">Virtuoso Dependencies</bridgehead>
<!-- No longer needed?
    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
    <xref linkend="net-tools"/>
    </para>
-->
    <bridgehead renderas="sect4">Recommended</bridgehead>
    <para role="recommended">
    <xref linkend="libiodbc"/>,
    <xref linkend="libxml2"/>,
    <xref linkend="openssl"/>, and
    <xref linkend="openldap"/>
   <!--<xref linkend="jdk"/>-->
    </para>

    <bridgehead renderas="sect4">Optional</bridgehead>
    <para role="optional">
    <xref linkend="imagemagick"/>,
    <xref linkend="python2"/>, and
    <xref linkend="mitkrb"/>
    <!-- Currently broken
    <xref linkend="php"/>
    <xref linkend="ruby"/>
    <ulink url="https://libwbxml.opensync.org/">libwbxml</ulink
    -->
    </para>

    <para condition="html" role="usernotes">User Notes:
    <ulink url="&blfs-wiki;/virtuoso"/></para>

  </sect2>

  <sect2 role="installation">
    <title>Installation of Virtuoso</title>

    <para>Install <application>virtuoso</application> by running the following
    commands:</para>

<screen><userinput>sed -i "s|virt_iodbc_dir/include|&amp;/iodbc|" configure  &amp;&amp;
./configure --prefix=/usr                             \
            --sysconfdir=/etc                         \
            --localstatedir=/var                      \
            --with-iodbc=/usr                         \
            --with-readline                           \
            --without-internal-zlib                   \
            --program-transform-name="s/isql/isql-v/" \
            --disable-all-vads                        \
            --disable-static                          &amp;&amp;
make</userinput></screen>

    <para>To test the results, issue <command>make -k check</command>.
    Some tests are known to fail.</para>

    <para>Now, as the <systemitem class="username">root</systemitem> user:</para>

<screen role="root"><userinput>make install &amp;&amp;
install -v -m755 -d /usr/share/doc/virtuoso-&virtuoso-version; &amp;&amp;
ln -s   -v          ../../virtuoso/doc \
                    /usr/share/doc/virtuoso-&virtuoso-version;</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <para><command>sed -i ...</command>: This command is used to modify the
    <envar>CPPFLAGS</envar> variable so that the <application>libiodbc</application>
    interface headers are found by the <command>configure</command> script.</para>

    <para><parameter>--with-iodbc=/usr</parameter>: This parameter is used so
    that the build will use the system <application>libiodbc</application> interface
    headers and not the headers in the source tree.</para>

    <para><parameter>--with-readline</parameter>: This parameter is used so that
    the system <application>Readline</application> library is used.</para>

    <para><parameter>--without-internal-zlib</parameter>: This parameter is set
    so that the installed <application>zlib</application> library is used and
    not the bundled one.</para>

    <para><parameter>--program-transform-name</parameter>: Both
    <application>Virtuoso</application> and <application>unixODBC</application>
    install a program named <command>isql</command>. Use this parameter to rename
    <application>virtuoso</application>s program to <command>isql-v</command>.</para>

    <para><parameter>--disable-all-vads</parameter>: This parameter disables
    building all the VAD packages (tutorials, demos, etc.).</para>

    <para><parameter>--disable-static</parameter>: This option disables building
    static libraries. However, the main <application>Virtuoso</application>
    libraries, <filename class="libraryfile">libvirtuoso-t</filename> and
    <filename class="libraryfile">libvirtuoso-iodbc-t</filename> are still
    built as static libraries.</para>

    <para><option>--enable-python</option>: Add this option if
    <application>Python</application> is installed to enable building
    <application>Python</application> bindings.</para>

<!-- broken with JDK-version7
    <para><option>-&#45;with-jdk4</option>: Add this option to specify the path
    to the <xref linkend="jdk"/> and to enable making use of Java.</para>
-->

    <para><option>--with-port</option>: Add this if you want the
    <application>Virtuoso</application> server to listen on a port other than
    1111.</para>

    <para><option>--enable-aio</option>: Add this if you want
    <application>Virtuoso</application> to perform asynchronous file I/O
    operations instead of synchronous file I/O.</para>

    <para><option>--enable-perl</option>: Do not use this option if you built
    Perl according to the LFS instructions. The build will fail with a note
    similar to <computeroutput>Your perl should be compiled w -Dusemultiplicity.
    Check the output of perl -V:usemultiplicity</computeroutput>.</para>

    <para>Note that passing the <option>with-jdk4=${JAVA_HOME}</option>,
    <option>--enable-php5=/usr</option>, <option>--enable-ruby</option>, and
    <option>--enable-wbxml2=/usr</option> options all will fail during the
    <command>configure</command> phase of the build. They will not break
    the build, but the desired support will not be included in the build.</para>
  </sect2>

  <sect2 role="configuration">
    <title>Configuration</title>

    <note><para>If <application>Virtuoso</application> is only to be used
    for <application>KDE</application>, there is no need to start the
    <application>Virtuoso</application> server at boot time.</para></note>

    <sect3 id="virtuoso-init">
      <title>Boot Script</title>

      <para>If you want the <application>Virtuoso</application> server to
      start automatically when the system is booted, install the
      <filename>/etc/rc.d/init.d/virtuoso</filename> init script included
      in the <xref linkend="bootscripts"/> package.</para>

      <indexterm zone="virtuoso virtuoso-init">
        <primary sortas="f-virtuoso">virtuoso</primary>
      </indexterm>

<screen role="root"><userinput>make install-virtuoso</userinput></screen>

    </sect3>

    <sect3 id="virtuoso-users">
      <title>User accounts</title>

      <para>When the server is started using the start script, there is a web
      interface to <application>Virtuoso</application> at
      <ulink url="http://localhost:8890/"/>. Several links are pointing to
      the OpenLink site, but the <application>Conductor</application> at
      <ulink url="http://localhost:8890/conductor/"/>. This is a full featured
      configuration site for <application>Virtuoso</application>. Login as
      <systemitem class="username">dba</systemitem> with the predefined
      password <literal>dba</literal>.</para>

      <warning>
        <title>Change password</title>

        <para>Remember to immediatly change the password of user
        <systemitem class="username">dba</systemitem> as well as of all other
        predefined users. Click on <literal>[System Admin]</literal> and
        than on <literal>[User Accounts]</literal>.</para>

      </warning>
    </sect3>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>inifile, isql-v, isql-vw, virt_maili, and virtuoso-t</seg>
        <seg>libvirtuoso-t.a, virtodbc.so, virtodbc_r.so, virtodbcu.so, 
             and virtodbcu_r.so</seg>
        <seg>/var/lib/virtuoso, 
             /usr/lib/{hibernate,jdbc-{2,3,4}.0,jena,sesame,virtuoso}, and
             /usr/share/virtuoso</seg>
      </seglistitem>
    </segmentedlist>

    <variablelist>
      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
      <?dbfo list-presentation="list"?>
      <?dbhtml list-presentation="table"?>

      <varlistentry id="isql-v">
        <term><command>isql-v</command></term>
        <listitem>
          <para>is an interactive SQL utility.</para>
          <indexterm zone="virtuoso isql-v">
            <primary sortas="b-isql-v">isql-v</primary>
          </indexterm>
        </listitem>
      </varlistentry>

      <varlistentry id="virtuoso-t">
        <term><command>virtuoso-t</command></term>
        <listitem>
          <para>is the Universial Server daemon.</para>
          <indexterm zone="virtuoso virtuoso-t">
            <primary sortas="b-virtuoso-t">virtuoso-t</primary>
          </indexterm>
        </listitem>
      </varlistentry>

    </variablelist>

  </sect2>

</sect1>