VOSUsageWindows Using Virtuoso Open-Source Edition on Windows Using Virtuoso Open-Source Edition on Windows Building Virtuoso on Windows requires some time and the user should be proficient with Windows software development. The build is not guaranteed to succeed out of the box. Unless you plan to actually modify the Virtuoso code, we recommend using the binary distribution. Getting Started with the VOS Binary Distribution for Windows Prerequisites Pre-built binaries of Virtuoso 6.1.4 to 7.1.0 for Windows require the Microsoft Visual C++ 2010 Redistributable Package be installed. This can be downloaded from the following locations: 32-bit Microsoft Visual C++ 2010 Redistributable Package (x86) 64-bit Microsoft Visual C++ 2010 Redistributable Package (x86_64) Pre-built binaries of Virtuoso 7.2.0 and later for Windows require the Microsoft Visual C++ 2012 Redistributable Package be installed. This can be downloaded from the following locations: 64-bit Microsoft Visual C++ 2012 Redistributable Package (x86_64) Appropriate environment variables should be set before any of the steps below -- Determine the root location for your Virtuoso installation. For best results, we recommend putting the ZIP (and/or the directory created upon its extraction) into the C:/Program Files/ (or C:/Program Files (x86)/, for a 32-bit Virtuoso on 64-bit Windows) directory. If you have installed other components from OpenLink Software, you may want to add the Virtuoso subdirectory to that directory (e.g., C:/Program Files/OpenLink Software/VOS7/). Start the System control panel (right-click My Computer and select Properties, or drill down through the Start menu -> Control Panels -> Administrative Tools -> System). Click to Advanced -> Environment Variables, and create a new system environment variable called VIRTUOSO_HOME, with this path (e.g., C:/Program Files/OpenLink Software/VOS7/virtuoso-opensource/) for its value. Locate the PATH system environment variable, and click to EDIT it. Add the string below to the end of the existing PATH value. IMPORTANT: Do not over-write the existing PATH value! Doing so will disrupt all use of your Windows environment. ;%VIRTUOSO_HOME%/bin;%VIRTUOSO_HOME%/lib Click OK or Exit buttons until you have fully exited the System control panel. The above environment variable changes will have immediate effect on any processes that start hereafter, but rebooting your Windows environment may be necessary in some situations. Basic Installation Simply unzip the binary distribution zip file to your chosen location (see Prerequisites, above). This will create a directory virtuoso-opensource, containing 6 subfolders: bin lib hosting database vad vsp Note: The current Windows binary package is missing a php.ini file, required for PHP run-time hosting support. Please download a copy of this file, and manually place it in the database directory. The default administrator username and password are both dba. We recommend immediately changing the password to secure your database. By default, the Virtuoso server will listen for HTTP connections at TCP port 8890, and for SQL data access (via iSQL, ODBC, JDBC, OLE DB, ADO.NET, etc.) at TCP port 1111. These ports may be changed by editing the virtuoso.ini file. Optional -- Create and Manage Virtuoso Windows Services Start a CMD/DOS session (Start menu -> Command Prompt, or run %SystemRoot%/system32/cmd.exe). Note: On Windows Vista and later (including Windows 7, Windows 8, Windows Server 2008, etc.), you MUST right-click on the "Command Prompt" icon and select the "Run as Administrator" option; else, the CMD session will not have the privileges necessary for the following steps to succeed, even if you are logged in as a Windows Administrator. Verify your Virtuoso binary by typing in the command: virtuoso-t -? Note: we also provide binaries with Java (virtuoso-javavm-t) and .NET CLR (virtuoso-clr-t) hosting support, which should be substituted for virtuoso-t throughout, if such hosting support is required. Run the following command: cd %VIRTUOSO_HOME%/database Create a new Windows Service with the following command -- virtuoso-t +service create +instance "New Instance Name" +configfile virtuoso.ini Note: If you have an existing Virtuoso service, the above will replace it. You can preserve the existing service and add a new one with the following command variant (changing the +service argument from "create" to "screate") -- virtuoso-t +service screate +instance "New Instance Name" +configfile virtuoso.ini Once created, you can manage the Virtuoso service through the standard Windows Services Manager (Start -> Control Panel -> Administrative Tools -> Services or Component Services). It will be listed as OpenLink Virtuoso Server [Instance Name]. You can also use the CMD/DOS commands in the table below. Note that the +instance and +service flags may be replaced by -I and -S, respectively. <tgroup><thead /><tbody> <row /> <row><entry> <emphasis>List all Virtuoso services</emphasis> </entry><entry> virtuoso-t +service list </entry></row> <row><entry> <emphasis>Start a Virtuoso service</emphasis> </entry><entry> virtuoso-t +instance "Instance Name" +service start </entry></row> <row><entry> <emphasis>Stop a Virtuoso service</emphasis> </entry><entry> virtuoso-t +instance "Instance Name" +service stop </entry></row> <row><entry> <emphasis>Delete a Virtuoso service</emphasis> </entry><entry> virtuoso-t +instance "Instance Name" +service delete </entry></row> </tbody></tgroup></table> </listitem> </orderedlist><para> </para> <bridgehead class="http://www.w3.org/1999/xhtml:h3"> Optional -- Register the VOS ODBC Driver</bridgehead> <para>For best results, we recommend that you download and install the appropriate commercial <ulink url="http://virtuoso.openlinksw.com/download/">Client Connectivity Kit</ulink>, which is <ulink url="http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSLicense#Client%20Protocol%20Driver%20exemptions%20from%20GPL">freely licensed for use with VOS</ulink>.</para> <orderedlist spacing="compact"><listitem>Start a CMD/DOS session (<emphasis>Start</emphasis> menu -> <emphasis>Command Prompt</emphasis>, or run %SystemRoot%/system32/cmd.exe). <emphasis><emphasis>Note:</emphasis> On Windows Vista and later (including Windows 7, Windows 8, Windows Server 2008, etc.), you <emphasis>MUST</emphasis> right-click on the "Command Prompt" icon and select the "Run as Administrator" option; else, the CMD session will not have the privileges necessary for the following steps to succeed, even if you are logged in as a Windows Administrator.</emphasis> </listitem> <listitem>Run the following commands: <programlisting>cd %VIRTUOSO_HOME%/lib regsvr32 virtodbc.dll </programlisting></listitem> <listitem>As a result, you should see this message: <programlisting>DLLRegisterServer in virtodbc.dll succeeded. </programlisting> </listitem> </orderedlist><bridgehead class="http://www.w3.org/1999/xhtml:h3"> Optional -- Create an ODBC DSN</bridgehead> <orderedlist spacing="compact"><listitem>Launch the ODBC Administrator (<emphasis>Start</emphasis> menu -> <emphasis>Control panels</emphasis> -> <emphasis>Administrative Tools</emphasis> -> <emphasis>Data Sources (ODBC)</emphasis>). </listitem> <listitem>For most purposes, click to the <emphasis>System DSN</emphasis> tab. <emphasis>User DSNs</emphasis> are not typically necessary. </listitem> <listitem>See <ulink url="http://docs.openlinksw.com/virtuoso/odbcimplementation.html">this document</ulink>.</listitem> </orderedlist><para> </para> <bridgehead class="http://www.w3.org/1999/xhtml:h2"> Virtuoso Conductor -- the HTTP Browser-based Virtuoso Administration Tool</bridgehead> <para>The Virtuoso Conductor is a HTTP-based administration tool, included by default in all Virtuoso instances. It can be accessed at the URL: </para> <programlisting>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/conductor </programlisting><para>For instance -- </para> <programlisting>http://localhost:8890/conductor </programlisting><para>-- or -- </para> <programlisting>http://my-virtuoso-host.example.com:8890/conductor </programlisting><para> The Conductor can then be used to install other Virtuoso VAD applications available by navigating to the "System Admin -> Packages" tab which presents you with a list of available Virtuoso VAD application packages to install, selecting those you require and install, at which point they will then become accessible as part of your Virtuoso server instance.</para> <bridgehead class="http://www.w3.org/1999/xhtml:h2"> iSQL -- the Virtuoso Interactive SQL tool</bridgehead> <para>To connect with the Virtuoso Interactive SQL tool (isql), run the following command from your DOS prompt: </para> <programlisting>isql 1111 dba dba </programlisting><para>You should get a response like this -- </para> <programlisting>Connected to OpenLink Virtuoso Driver: 05.00.3028 OpenLink Virtuoso ODBC Driver OpenLink Interactive SQL (Virtuoso), version 0.9849b. Type HELP; for help and EXIT; to exit. SQL> </programlisting><para> iSQL has a number of built in commands, like tables -- </para> <programlisting>SQL> tables; Showing SQLTables of tables like 'NULL.NULL.NULL', tabletype/colname like 'NULL' TABLE_QUALIFIER TABLE_OWNER TABLE_NAME TABLE_TYPE REMARKS VARCHAR VARCHAR VARCHAR VARCHAR VARCHAR _______________________________________________________________________________ DB DBA ADMIN_SESSION SYSTEM TABLE NULL DB DBA ADM_OPT_ARRAY_TO_RS_PVIEW SYSTEM TABLE NULL DB DBA ADM_XML_VIEWS SYSTEM TABLE NULL . . . SQL> </programlisting><bridgehead class="http://www.w3.org/1999/xhtml:h2"> Documentation, Tutorials, and More</bridgehead> <bridgehead class="http://www.w3.org/1999/xhtml:h3"> Overall Virtuoso Documentation</bridgehead> <para>Bundled documentation may be found at <emphasis>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/doc/html</emphasis>. More recent updates are available online, at <ulink url="http://docs.openlinksw.com/virtuoso">Virtuoso Product Manual</ulink> and <ulink url="http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSIndex">Open Source Edition Docs</ulink>.</para> <para>Bundled tutorials may be found at <emphasis>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/tutorial</emphasis>. These are also available online, at <ulink url="http://demo.openlinksw.com/tutorial">http://demo.openlinksw.com/tutorial</ulink>.</para> <bridgehead class="http://www.w3.org/1999/xhtml:h3"> SPARQL Demos</bridgehead> <para>A full SPARQL demo may be found <ulink url="http://demo.openlinksw.com/sparql_demo/">online</ulink>, or locally at <emphasis>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/sparql_demo</emphasis>.</para> <para>Virtuoso's built in SPARQL endpoint is at <emphasis>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/sparql</emphasis>.</para> <para>The iSPARQL Query-By-Example tool (if installed) will be at <emphasis>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/isparql</emphasis>.</para> <bridgehead class="http://www.w3.org/1999/xhtml:h3"> ODS Applications Suite</bridgehead> <para>The <ulink url="http://ods.openlinksw.com/wiki/ODS/">OpenLink Data Spaces (ODS)</ulink> applications suite includes a broad collection of distributed collaborative applications covering: blogs, wikis, shared bookmarks, file management, calendaring, email, photo galleries, discussion forums, polls, and more. Once installed, ODS applications will be available at <emphasis>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/ods</emphasis>.</para> <para>See <ulink url="http://ods.openlinksw.com/wiki/ODS/OdsConfig">Getting Started with ODS</ulink> for more on setting up ODS.</para> <para> </para> <bridgehead class="http://www.w3.org/1999/xhtml:h3">BPEL Process Manager</bridgehead> <para>To experiment with the BPEL Process Manager, visit <emphasis>http://<virtuoso-host-FQDN-or-IP-address>:<HTTP-port>/BPELGUI</emphasis>.</para> <para> </para> </section></docbook>