%VOSWARNING%

%META:TOPICPARENT{name="VOSIndex"}%
%VOSNAV%

---+ Using Virtuoso Open-Source Edition on Windows

[[VOSMakeWindows][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 [[VOSDownload][binary distribution]].

%TOC%


---++ 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 <b>Microsoft Visual C++ 
2010 Redistributable Package</b> be installed.  This can be downloaded from the following locations:
      * [[http://www.microsoft.com/download/en/details.aspx?id=5555][32-bit Microsoft Visual C++ 2010 Redistributable Package (x86)]]
      * [[http://www.microsoft.com/download/en/details.aspx?id=14632][64-bit Microsoft Visual C++ 2010 Redistributable Package (x86_64)]]

   * Pre-built binaries of Virtuoso 7.2.0 and later for Windows require the <b>Microsoft Visual C++ 
2012 Redistributable Package</b> be installed.  This can be downloaded from the following locations:
      * [[http://www.microsoft.com/en-us/download/details.aspx?id=30679#][64-bit Microsoft Visual C++ 2012 Redistributable Package (x86_64)]]

   * Appropriate environment variables should be set before any of the steps below --
      1 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 <b><code>C:/Program Files/</code></b> (or
 <b><code>C:/Program Files (x86)/</code></b>, for a 32-bit Virtuoso on 64-bit Windows) directory.  If you have 
installed other components from <nop>OpenLink Software, you may want to add the Virtuoso subdirectory to that 
directory (e.g., <b><code>C:/Program Files/<nop>OpenLink Software/VOS7/</code></b>).
      1. Start the System control panel (right-click <b>My Computer</b> and select <b>Properties</b>, or drill 
down through the <b>Start</b> menu -> <b>Control Panels</b> -> <b>Administrative Tools</b> -> <b>System</b>).  
      1. Click to <b>Advanced</b> -> <b>Environment Variables</b>, and create a new system environment variable 
called <b><code>VIRTUOSO_HOME</code></b>, with this path (e.g., 
<b><code>C:/Program Files/<nop>OpenLink Software/VOS7/virtuoso-opensource/</code></b>) for its value.
      1. Locate the PATH system environment variable, and click to EDIT it.  
      1. Add the string below to the end of the existing PATH value.  %BR%%BR%<i><b>IMPORTANT:</b> Do not 
over-write the existing PATH value! Doing so will disrupt all use of your Windows environment.</i>
<verbatim>
;%VIRTUOSO_HOME%/bin;%VIRTUOSO_HOME%/lib
</verbatim>      
      1 Click <b>OK</b> or <b>Exit</b> buttons until you have fully exited the System control panel.
      1 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 [[VOSDownload][binary distribution zip file]] to your chosen location (see [[#Prerequisites][Prerequisites]], 
above).  This will create a directory <b><code>virtuoso-opensource</code></b>, containing 6 subfolders: 
<verbatim>
bin
lib
hosting
database
vad
vsp
</verbatim> 

<i>*Note*: The current Windows binary package is missing a <code>php.ini</code> file, required for PHP run-time 
hosting support.  Please [[ftp://download.openlinksw.com/support/vos/php.ini][download a copy of this file]],
and manually place it in the <b><code>database</code></b> directory.</i>

The default administrator username and password are both <b><code>dba</code></b>. We recommend 
immediately changing the password to secure your database. 

By default, the Virtuoso server will listen for HTTP connections at TCP port <b><code>8890</code></b>, 
and for SQL data access (via iSQL, ODBC, JDBC, OLE DB, ADO.NET, etc.) at TCP port <b><code>1111</code></b>. 
These ports may be changed by editing the <code>virtuoso.ini</code> file.


----+++ Optional -- Create and Manage Virtuoso Windows Services

   1 Start a CMD/DOS session (<b>Start</b> menu -> <b>Command Prompt</b>, or run <code><nowiki>%SystemRoot%/system32/cmd.exe</nowiki></code>).
%BR%%BR% <i><b>Note:</b> 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.</i>%BR%%BR%
   1 Verify your Virtuoso binary by typing in the command: 
<verbatim>
virtuoso-t -? 
</verbatim>
<i><b>Note:</b> we also provide binaries with Java (<code>virtuoso-javavm-t</code>) and .NET CLR (<code>virtuoso-clr-t</code>) hosting support, 
which should be substituted for <code>virtuoso-t</code> throughout, if such hosting support is required.</i>
   3. Run the following command:
<verbatim>
cd %VIRTUOSO_HOME%/database
</verbatim>
   5. Create a new Windows Service with the following command --
<verbatim>
virtuoso-t +service create +instance "New Instance Name" +configfile virtuoso.ini 
</verbatim>
<i><b>Note:</b> 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 <b><code>+service</code></b> argument from 
"<b><code>create</code></b>" to "<b><code>screate</code></b>") --</i>
<verbatim>
virtuoso-t +service screate +instance "New Instance Name" +configfile virtuoso.ini 
</verbatim>
   10. Once created, you can manage the Virtuoso service through the standard Windows Services Manager (<b>Start</b> -> <b>Control Panel</b> -> <b>Administrative Tools</b> -> <b>Services</b> or <b>Component Services</b>).  It will be listed as <b><nop>OpenLink Virtuoso Server [Instance Name]</b>.  You can also use the CMD/DOS commands in the table below.  Note that the <b><code>+instance</code></b> and <b><code>+service</code></b> flags may be replaced by <b><code>-I</code></b> and <b><code>-S</code></b>, respectively.
|   *Action*   |   *Command*   |
| *List all Virtuoso services*   | <code>virtuoso-t +service list</code>   |
| *Start a Virtuoso service*   | <code>virtuoso-t +instance "Instance Name" +service start</code>   |
| *Stop a Virtuoso service*    | <code>virtuoso-t +instance "Instance Name" +service stop</code>    |
| *Delete a Virtuoso service*  | <code>virtuoso-t +instance "Instance Name" +service delete</code>  |


---+++ Optional -- Register the VOS ODBC Driver

For best results, we recommend that you download and install the appropriate commercial [[http://virtuoso.openlinksw.com/download/][Client Connectivity Kit]], which is [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSLicense#Client%20Protocol%20Driver%20exemptions%20from%20GPL][freely licensed for use with VOS]].

   1 Start a CMD/DOS session (<b>Start</b> menu -> <b>Command Prompt</b>, or run <code><nowiki>%SystemRoot%/system32/cmd.exe</nowiki></code>).
%BR%%BR% <i><b>Note:</b> 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.</i>%BR%%BR%
   3. Run the following commands:
<verbatim>
cd %VIRTUOSO_HOME%/lib
regsvr32 virtodbc.dll  
</verbatim>
   4. As a result, you should see this message:
<verbatim>
DLLRegisterServer in virtodbc.dll succeeded.
</verbatim>

---+++ Optional -- Create an ODBC DSN

   1. Launch the ODBC Administrator (<b>Start</b> menu -> <b>Control panels</b> -> <b>Administrative Tools</b> -> <b>Data Sources (ODBC)</b>).
   1 For most purposes, click to the <b>System DSN</b> tab.  <b>User DSNs</b> are not typically necessary.
   2. See [[http://docs.openlinksw.com/virtuoso/odbcimplementation.html][this document]].


---++ Virtuoso Conductor -- the HTTP Browser-based Virtuoso Administration Tool

The Virtuoso Conductor is a HTTP-based administration tool, included by default in all Virtuoso instances.  It can be accessed at the URL:
<verbatim>
http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/conductor
</verbatim>
For instance --
<verbatim>
http://localhost:8890/conductor
</verbatim>
-- or --
<verbatim>
http://my-virtuoso-host.example.com:8890/conductor
</verbatim>

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.

---++ iSQL -- the Virtuoso Interactive SQL tool

To connect with the Virtuoso Interactive SQL tool (isql), run the following command from your DOS prompt:
<verbatim>
isql 1111 dba dba
</verbatim>
You should get a response like this --
<verbatim>
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> 
</verbatim>

iSQL has a number of built in commands, like <code>tables</code> --
<verbatim>
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>
</verbatim>


---++ Documentation, Tutorials, and More

---+++ Overall Virtuoso Documentation

Bundled documentation may be found at <b><code><nowiki>http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/doc/html</nowiki></code></b>.  More recent updates are available online, at [[http://docs.openlinksw.com/virtuoso][Virtuoso Product Manual]] and [[http://virtuoso.openlinksw.com/dataspace/dav/wiki/Main/VOSIndex][Open Source Edition Docs]].

Bundled tutorials may be found at <b><code><nowiki>http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/tutorial</nowiki></code></b>.  These are also available online, at [[http://demo.openlinksw.com/tutorial][http://demo.openlinksw.com/tutorial]].

---+++ SPARQL Demos

A full SPARQL demo may be found [[http://demo.openlinksw.com/sparql_demo/][online]], or locally at <b><code><nowiki>http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/sparql_demo</nowiki></code></b>.

Virtuoso's built in SPARQL endpoint is at <b><code><nowiki>http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/sparql</nowiki></code></b>.

The iSPARQL Query-By-Example tool (if installed) will be at <b><code><nowiki>http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/isparql</nowiki></code></b>.

---+++ ODS Applications Suite

The [[http://ods.openlinksw.com/wiki/ODS/][OpenLink Data Spaces (ODS)]] 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 <b><code><nowiki>http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/ods</nowiki></code></b>.

See [[http://ods.openlinksw.com/wiki/ODS/OdsConfig][Getting Started with ODS]] for more on setting up ODS.


---+++BPEL Process Manager

To experiment with the BPEL Process Manager, visit <b><code><nowiki>http://&lt;virtuoso-host-FQDN-or-IP-address&gt;:&lt;HTTP-port&gt;/BPELGUI</nowiki></code></b>.



%VOSCOPY%