Veridian installation guide

Table of Contents

1. Veridian™ installation — Linux
1.1. System requirements
1.2. Installing the Veridian™ binaries from the CD-ROM or web download
1.3. Configuration and file permissions
1.3.1. The gsdlsite.cfg configuration file
1.3.2. The ingest.cfg and runtime.cfg configuration files
1.3.3. The ImageServerConfig.pm configuration file
1.3.4. File permissions
1.4. Web server configuration
1.5. Solr and Tomcat
1.6. Log files and troubleshooting
2. Veridian™ installation — Windows 7/Server 2008 R2 and IIS 7.5
2.1. System requirements
2.2. Installing the Veridian™ binaries from the CD-ROM or web download
2.3. Configuration and file permissions
2.3.1. The gsdlsite.cfg configuration file
2.3.2. The ingest.cfg and runtime.cfg configuration files
2.3.3. The ImageServerConfig.pm configuration file
2.4. Web server configuration — IIS 7.5
2.4.1. Creating the cgi-bin Virtual Directory
2.4.2. Creating the web Virtual Directory
2.4.3. Setting up IIS to execute Perl scripts
2.5. Solr and Tomcat
2.6. Log files and troubleshooting
3. Veridian™ installation — Windows Server 2003 and IIS 6
3.1. System requirements
3.2. Installing the Veridian™ binaries from the CD-ROM or web download
3.3. Configuration and file permissions
3.3.1. The gsdlsite.cfg configuration file
3.3.2. The ingest.cfg and runtime.cfg configuration files
3.3.3. The ImageServerConfig.pm configuration file
3.3.4. File permissions
3.4. Web server configuration — IIS 6
3.4.1. Creating a new Virtual Directory
3.4.2. Enabling CGI/Script execution
3.4.3. Setting IIS permissions
3.5. Solr and Tomcat
3.6. Log files and troubleshooting
4. Veridian™ installation — Windows and Apache
4.1. System requirements
4.2. Installing the Veridian™ binaries from the CD-ROM or web download
4.3. Configuration and file permissions
4.3.1. The gsdlsite.cfg configuration file
4.3.2. The ingest.cfg and runtime.cfg configuration files
4.3.3. The ImageServerConfig.pm configuration file
4.3.4. File permissions
4.4. Web server configuration — Apache
4.5. Solr and Tomcat
4.6. Log files and troubleshooting
5. Next steps
6. Multiple collections in one Veridian™ installation


1. Veridian™ installation — Linux

This section describes how to install the Veridian™ software on a Linux system with SELinux disabled.

1.1. System requirements

The binary Linux distribution of this version of Veridian™ has been tested under Redhat Enterprise Linux 5 and CentOS 5.8, on both 32-bit and 64-bit platforms.

Run yum list installed and ensure that all the following packages are installed. These packages must be installed before installing or running Veridian™:

  • httpd
  • netpbm-progs (version 10.35.50 or newer)
  • perl
  • expat-devel
  • perl-XML-Parser

If any of the above packages are not installed, run yum install <pkg> to install them (e.g. yum install netpbm-progs).

You must also install the Sun Java Runtime Environment, version 1.6.0 or newer. Download this from http://java.sun.com. Note that you may have to use the alternatives command to ensure you are using the correct Java (see the manual page for alternatives, ie. man alternatives).

Lastly, the Perl DBI, DBD::SQLite and Mail::Sendmail modules are required. Install these by running the Perl cpan program and entering install <pkg> (e.g. install DBI).

1.2. Installing the Veridian™ binaries from the CD-ROM or web download

Simply copy the folder named veridian from the top level of the Veridian™ CD-ROM or web download to the folder on the server in which you wish the software to be installed.

1.3. Configuration and file permissions

1.3.1. The gsdlsite.cfg configuration file

Copy the veridian/cgi-bin/gsdlsite.cfg.in configuration file to veridian/cgi-bin/gsdlsite.cfg

Edit the veridian/cgi-bin/gsdlsite.cfg configuration file and set the following configuration variables. See section 1.4 on web server configuration for more information on setting HTTP (web server) configuration variables:

veridianhome Set this to the full path of your veridian folder (e.g. /usr/local/veridian).
solrserverurl Set this to the HTTP (web server) path of the Solr service within Tomcat (installation instructions below). This should remain as the default value unless you have to install Tomcat on a port other than 8080.
smtpserver Set this to the domain name or IP address of the SMTP server that Veridian should use to send e-mails. This is only necessary for sites with user registration.
httpdomain Set this to the full HTTP address of the server (e.g. http://veridian.mydomain.com).
gwcgi Set this to the HTTP (web server) path of your veridian/cgi-bin/veridian CGI executable. This should remain as the default value if you follow the web server configuration instructions below.
httpimageserver Set this to the HTTP (web server) path of your veridian/cgi-bin/imageserver/imageserver.pl script. This should remain as the default value if you follow the web server configuration instructions below.
httpweb Set this to the HTTP (web server) path of your veridian/web folder. This should remain as the default value if you follow the web server configuration instructions below.
httpcustomweb This setting can be ignored.

1.3.2. The ingest.cfg and runtime.cfg configuration files

These files contain configuration options for tailoring how a Veridian™ installation looks and works (described in the Veridian™ Customisation Guide). One important configuration setting in this file is the Veridian™ license key, which is required for the Veridian™ software to run. Please contact DL Consulting for a license key for each Veridian™ installation, and enter this at the top of the veridian/etc/runtime.cfg file.

1.3.3. The ImageServerConfig.pm configuration file

Copy the veridian/cgi-bin/imageserver/ImageServerConfig.pm.in configuration file to veridian/cgi-bin/imagseserver/ImageServerConfig.pm

Configure the imageserver by setting the $veridian_home configuration variable in veridian/cgi-bin/imageserver/ImageServerConfig.pm

$veridian_home Set this to the same value as the veridianhome variable in gsdlsite.cfg (i.e. the full path of the veridian folder).

1.3.4. File permissions

Ensure that the veridian directory is readable by the web server. This is particularly important if Veridian is installed under /home, since home directories are often only readable by the one user.

Ensure that the veridian/etc and veridian/logs directories are writable by the web server. Runtime logs and databases are written to these directories.

Ensure that the veridian/cgi-bin/imageserver/cache and veridian/cgi-bin/imageserver/logs directories exist and are writeable by the web server. These directories are used by the Veridian™ image server for caching generated image files and logging progress information.

1.4. Web server configuration

Configure a new virtual host in your web server for the Veridian site. This needs to be configured so:

  • The document root is set to the veridian/web directory.
  • The veridian/cgi-bin directory is accessible at /cgi-bin, and is configured to be a CGI executable directory
  • The veridian/web directory is accessible at /web.
  • Navigating to the site URL will automatically take the user to the Veridian executable.

For Apache, you would do this by adding a block similar to the following to your Apache web server configuration file, then restarting the web server:

<VirtualHost *:80>
  ServerName <site-URL>
  DocumentRoot “<path>/veridian/web”
  DirectoryIndex “/cgi-bin/veridian”

  ScriptAlias /cgi-bin “<path>/veridian/cgi-bin”
  <Directory “<path>/veridian/cgi-bin”>
    Options ExecCGI FollowSymLinks
    Order allow,deny
    Allow from all
    Deny from none
  </Directory>

  Alias /web “<path>/veridian/web”
  <Directory “<path>/veridian/web”>
    AllowOverride All
    Options FollowSymLinks
    Order allow,deny
    Allow from all
    Deny from none
  </Directory>
</VirtualHost>

1.5. Solr and Tomcat

Veridian™ collections use Solr for searching, as Solr supports faceted searching and handles large collections very well.

Solr runs through Tomcat, and both these packages are included in Veridian. To start Tomcat running:

  1. Start Tomcat by running ./bin/shell/Start-Tomcat.sh from the veridian directory.
  2. Check Tomcat is running by visiting http://<server>:8080
  3. Check Solr is running by visiting http://<server>:8080/solr/admin

To ensure that Tomcat restarts automatically if the machine is rebooted, copy the veridian/packages/tomcat/veridian-tomcat-autostart file into /etc/init.d (as root), and edit it to set VERIDIAN_DIR to the full path of the veridian directory, and VERIDIAN_USER to the username used for installation. Then run sudo /sbin/chkconfig veridian-tomcat-autostart on to configure this to run at startup.

1.6. Log files and troubleshooting

Relevant log files for a Veridian™ installation are:

Log files for the Veridian™ delivery system:
veridian/logs/veridian.<DATE>.log
Log files for the imageserver:
veridian/cgi-bin/imageserver/logs/imageserver.<DATE>.log
The Apache access and error logs:
/var/log/httpd (or similar)

When troubleshooting run-time errors, start by looking in the Apache error log as most fatal errors will appear here.


2. Veridian™ installation — Windows 7/Server 2008 R2 and IIS 7.5

This section describes how to install the Veridian™ software on a Windows 7 or Server 2008 R2 system with Internet Information Service 7.5.

2.1. System requirements

The binary Windows distribution of this version of Veridian™ has been tested under Windows 7 and Windows Server 2008 R2 with Internet Information Service (IIS) 7.5.

If you are using Windows 7 then IIS 7.5 is possibly installed, but not enabled. To enable it, go to Control Panel > Programs > Programs and Features > Turn Windows Features on or off and check all the sub-features under Internet Information Services and Internet Information Services Hostable Web Core. Note that clicking on the checkbox once makes the box filled instead of being checked. To make the box checked click the + icon next to the checkbox, and attempt to make all the sub-features checked. Once the Internet Information Services box is checked click OK, and after a long wait IIS should be enabled.

Install the following applications:

After installation, ensure the PATH environment variable includes the path to the ActivePerl binaries. View the PATH variable at Control Panel > System > Advanced > Environment Variables > Path and check that it contains C:\Perl\site\bin;C:\Perl\bin

IMPORTANT: Reboot the machine after the installation to update the PATH variable for the “Network Service” user for IIS 7.5.

Lastly, the Perl DBI, DBD::SQLite and Mail::Sendmail modules are required. Install these by running the Perl cpan.exe program and entering install <pkg> (e.g. install DBI).

2.2. Installing the Veridian™ binaries from the CD-ROM or web download

Simply copy the folder named veridian from the top level of the Veridian™ CD-ROM or web download to the folder on the server in which you wish the software to be installed.

2.3. Configuration and file permissions

2.3.1. The gsdlsite.cfg configuration file

Copy the veridian\cgi-bin\gsdlsite.cfg.in configuration file to veridian\cgi-bin\gsdlsite.cfg

Edit the veridian\cgi-bin\gsdlsite.cfg configuration file and set the following configuration variables. See section 1.4 on web server configuration for more information on setting HTTP (web server) configuration variables:

veridianhome Set this to the full path of your veridian folder (e.g. C:\veridian).
solrserverurl Set this to the HTTP (web server) path of the Solr service within Tomcat (installation instructions below). This should remain as the default value unless you have to install Tomcat on a port other than 8080.
smtpserver Set this to the domain name or IP address of the SMTP server that Veridian should use to send e-mails. This is only necessary for sites with user registration.
httpdomain Set this to the full HTTP address of the server (e.g. http://veridian.mydomain.com).
gwcgi Set this to the HTTP (web server) path of your veridian\cgi-bin\veridian CGI executable. This should remain as the default value if you follow the web server configuration instructions below.
httpimageserver Set this to the HTTP (web server) path of your veridian\cgi-bin\imageserver\imageserver.pl script. This should remain as the default value if you follow the web server configuration instructions below.
httpweb Set this to the HTTP (web server) path of your veridian\web folder. This should remain as the default value if you follow the web server configuration instructions below.
httpcustomweb This setting can be ignored.

2.3.2. The ingest.cfg and runtime.cfg configuration files

These files contain configuration options for tailoring how a Veridian™ installation looks and works (described in the Veridian™ Customisation Guide). One important configuration setting in this file is the Veridian™ license key, which is required for the Veridian™ software to run. Please contact DL Consulting for a license key for each Veridian™ installation, and enter this at the top of the veridian\etc\runtime.cfg file.

2.3.3. The ImageServerConfig.pm configuration file

Copy the veridian\cgi-bin\imageserver\ImageServerConfig.pm.in configuration file to veridian\cgi-bin\ImageServerConfig.pm

Configure the imageserver by setting the following configuration variables in veridian\cgi-bin\imageserver\ImageServerConfig.pm:

$veridian_home Set this to the same value as the veridianhome variable in gsdlsite.cfg (i.e. the full path of the veridian folder, for example C:\\veridian).
$os Set this to windows-activestate
$netpbm_bin_path Set this to the full path of the veridian\cgi-bin\imagseserver\bin\windows\netpbm folder, (e.g. C:\\veridian\\cgi-bin\\imageserver\\bin\\windows\\netpbm).

2.4. Web server configuration — IIS 7.5

To configure IIS, enter the IIS configuration interface (Control Panel > Administrative Tools > Internet Information Services), then follow these instructions:

2.4.1. Creating the cgi-bin Virtual Directory

  1. Right-click on Default Web Site on the left panel of the IIS Interface, and choose Add Virtual Directory…
  2. Set the Alias to “cgi-bin”
  3. Set the Physical Path to the cgi-bin directory (eg. veridian\cgi-bin)

Next, enable the veridian.exe executable to be run by IIS:

  1. Click on the server (it should be two levels above Default Web Site) on the left panel
  2. In the middle panel, click ISAPI and CGI Restrictions
  3. On the right panel, click Add…
  4. Fill in the CGI path (eg. C:\veridian\cgi-bin\veridian.exe), and check “Allow extension path to execute”
  5. Click OK

2.4.2. Creating the web Virtual Directory

  1. Right-click on Default Web Site on the left panel of the IIS Interface, and choose Add Virtual Directory…
  2. Set the Alias to “web”
  3. Set the Physical Path to the web directory (eg. veridian\web)

2.4.3. Setting up IIS to execute Perl scripts

If you are running the 64-bit version of Windows 7 or Windows Server 2008 R2, note that you can either use the x86 (32-bit) or the 64-bit version of ActivePerl but your application pool must be configured to run at the corresponding-bitness. If you have installed 32-bit perl for example, you must ensure that your application pool is configured to run as 32-bit. Assuming that you are using 32-bit ActivePerl in the default application pool:

  1. In the left pane, click on the server. Click on “Application Pools” on the right pane
  2. In the Application Pools page, select “DefaultAppPool”
  3. In the right pane, under “Edit Application Pool”, click on “Advanced Settings…”
  4. In the Advanced Settings dialog, ensure that “Enable 32-bit Applications” is set to “True”

Note that on Windows 7 or Windows Server 2008 R2 (IIS 7.5) ActivePerl’s installer seems to be restricted by the operating system now to not be able to add appropriate configuration to IIS. So instead of creating handler mappings manually as described below, it is possible to have ActivePerl automatically create handler mappings by doing the following:

  1. Run Command Prompt as administrator.
  2. Change directory to C:\Perl (or C:\Perl64 for 64-bit ActivePerl)
  3. Run this command: ap-iis-config add all If the command does not work, try running it in the Perl bin directory.
  4. With 64-bit ActivePerl for example, this automatically adds a Script Map handler mapping to IIS 7.5 as follows:
    Request path: *.pl
    Executable: C:\Perl64\bin\perl.exe “%s” %s
    Name: (could be anything) Perl CGI for .pl


2.5. Solr and Tomcat

Veridian™ collections use Solr for searching, as Solr supports faceted searching and handles large collections very well.

Solr runs through Tomcat, and both these packages are included in Veridian. To start Tomcat running:

  1. Install Tomcat by running veridian\packages\tomcat\apache-tomcat-6.0.32.exe (accept all defaults)
  2. Copy the veridian\packages\solr\apache-solr-4.1.war file to <TOMCAT-DIR>\webapps\solr.war (note filename change)
  3. Edit the <TOMCAT-DIR>\conf\server.xml file and add URIEncoding=”UTF-8″ maxPostSize=”-1″ to the <Connector> element on line 69.
  4. (Optional, for optimal performance on production sites) Run the “Configure Tomcat” program, change Java -> Java Virtual Machine to specify bin\server\jvm.dll instead of bin\client\jvm.dll. You will need the Java SDK rather than the JRE for this.
  5. Run the “Configure Tomcat” program, change Startup -> Working Path to the veridian directory, then start Tomcat running
  6. Check Tomcat is running by visiting http://<server>:8080
  7. Check Solr is running by visiting http://<server>:8080/solr/admin

2.6. Log files and troubleshooting

Relevant log files for a Veridian™ installation are:

Log files for the Veridian™ delivery system:
veridian\logs\veridian.<DATE>.log
Log files for the imageserver:
veridian\cgi-bin\imageserver\logs\imageserver.<DATE>.log

If the installation steps have all been performed and veridian does not work, try restarting the computer as that has been known to sometimes fix problems related to IIS, although restarting the computer shouldn’t be required.


3. Veridian™ installation — Windows Server 2003 and IIS 6

This section describes how to install the Veridian™ software on a Windows Server 2003 system with Internet Information Service 6.

3.1. System requirements

The binary Windows distribution of this version of Veridian™ has been tested under Windows Server 2003 with Internet Information Service (IIS) 6.

Install the following applications:

After installation, ensure the PATH environment variable includes the path to the ActivePerl binaries. View the PATH variable at Control Panel > System > Advanced > Environment Variables > Path and check that it contains C:\Perl\site\bin;C:\Perl\bin

IMPORTANT: Reboot the machine after the installation to update the PATH variable for the “Network Service” user for IIS 6.

Lastly, the Perl DBI, DBD::SQLite and Mail::Sendmail modules are required. Install these by running the Perl cpan.exe program and entering install <pkg> (e.g. install DBI).

3.2. Installing the Veridian™ binaries from the CD-ROM or web download

Simply copy the folder named veridian from the top level of the Veridian™ CD-ROM or web download to the folder on the server in which you wish the software to be installed.

3.3. Configuration and file permissions

3.3.1. The gsdlsite.cfg configuration file

Copy the veridian\cgi-bin\gsdlsite.cfg.in configuration file to veridian\cgi-bin\gsdlsite.cfg

Edit the veridian\cgi-bin\gsdlsite.cfg configuration file and set the following configuration variables. See section 1.4 on web server configuration for more information on setting HTTP (web server) configuration variables:

veridianhome Set this to the full path of your veridian folder (e.g. C:\veridian).
solrserverurl Set this to the HTTP (web server) path of the Solr service within Tomcat (installation instructions below). This should remain as the default value unless you have to install Tomcat on a port other than 8080.
smtpserver Set this to the domain name or IP address of the SMTP server that Veridian should use to send e-mails. This is only necessary for sites with user registration.
httpdomain Set this to the full HTTP address of the server (e.g. http://veridian.mydomain.com).
gwcgi Set this to the HTTP (web server) path of your veridian\cgi-bin\veridian CGI executable. This should remain as the default value if you follow the web server configuration instructions below.
httpimageserver Set this to the HTTP (web server) path of your veridian\cgi-bin\imageserver\imageserver.pl script. This should remain as the default value if you follow the web server configuration instructions below.
httpweb Set this to the HTTP (web server) path of your veridian\web folder. This should remain as the default value if you follow the web server configuration instructions below.
httpcustomweb This setting can be ignored.

3.3.2. The ingest.cfg and runtime.cfg configuration files

These files contain configuration options for tailoring how a Veridian™ installation looks and works (described in the Veridian™ Customisation Guide). One important configuration setting in this file is the Veridian™ license key, which is required for the Veridian™ software to run. Please contact DL Consulting for a license key for each Veridian™ installation, and enter this at the top of the veridian\etc\runtime.cfg file.

3.3.3. The ImageServerConfig.pm configuration file

Copy the veridian\cgi-bin\imageserver\ImageServerConfig.pm.in configuration file to veridian\cgi-bin\ImageServerConfig.pm

Configure the imageserver by setting the following configuration variables in veridian\cgi-bin\imageserver\ImageServerConfig.pm

$veridian_home Set this to the same value as the veridianhome variable in gsdlsite.cfg (i.e. the full path of the veridian folder, for example C:\\veridian).
$os Set this to windows-activestate
$netpbm_bin_path Set this to the full path of the veridian\cgi-bin\imagseserver\bin\windows\netpbm folder, (e.g. C:\\veridian\\cgi-bin\\imageserver\\bin\\windows\\netpbm).

3.3.4. File permissions

Veridian requires some files and folders to be readable, writeable or executable by the IIS user. To find the name of the IIS user, run the IIS configuration interface (Control Panel > Administrative Tools > Internet Information Services), right click on local computer > Web Sites > Default Web Site, and select Properties. The name of the IIS user is displayed under Directory Security > Authentication and access control section > Edit…

Before setting file permissions, first enable the Security tab by opening My Computer, then choose Tools > Folder Options. Switch to the View tab and untick Use simple file sharing. Setting file permissions is then done by right clicking on the file and choosing Properties, then switching to the Security tab and selecting the correct permissions. To add the IIS user to the list, click Add and then Advanced…, then Find Now, and select the IIS user (identified above) from the list.

Minimal setup

The minimal file permission changes required for Veridian to work are:

File Permission Reason
C:\Windows\system32\cmd.exe [IIS User] – Read & Execute Required to run external binaries: Java (for searching) and Perl and the Netpbm binaries (for the imageserver)

Optimal setup

If security is a concern, the file permissions can be restricted further. We recommend in this case that the machine is used only for Veridian and not for running any other sites or applications. The general principles used here are:

  • Read and write permissions should only be granted where necessary, and only to the IIS user.
  • No folders should be both writable and executable.

The file permissions should be set as follows:

File Permission Reason
C:\ [Users] – Remove Not required
C:\Perl\bin [IIS User] – Read & Execute Required to run Perl (for the imageserver)
C:\Perl\lib [IIS User] – Read & Execute Required to run Perl (for the imageserver)
C:\Windows\system32\cmd.exe [IIS User] – Read & Execute Required to run external binaries: Java (for searching) and Perl and the Netpbm binaries (for the imageserver)
C:\veridian [IIS User] – Read & List folder contents Required to read Veridian configuration files
C:\veridian\cgi-bin\veridian.exe [IIS User] – Read & Execute Required to run the Veridian CGI executable
C:\veridian\cgi-bin\imageserver\bin [IIS User] – Read & Execute Required to run external binaries: the Netpbm binaries (for the imageserver)
C:\veridian\cgi-bin\imageserver\cache [IIS User] – Write Required to store image files generated by the imageserver
C:\veridian\cgi-bin\imageserver\logs [IIS User] – Write Required to store log files generated by the imageserver
C:\veridian\logs [IIS User] – Write Required to store log files generated by the Veridian runtime system

Note: The correct permissions should be set for Java by the Java installer.

3.4. Web server configuration — IIS 6

General security principles for the IIS configuration are:

  • Read (Get) permissions should only be enabled where necessary.
  • No directories should have write (Put) permission enabled.
  • No directories with Write permissions at the file system level (see Section 2.3.4) should have “Scripts and Executables” permissions enabled.

To configure IIS, enter the IIS configuration interface (Control Panel > Administrative Tools > Internet Information Services), then follow these instructions:

3.4.1. Creating cgi-bin Virtual Directory

  1. Right-click on local computer > Web Sites > Default Web Site and choose New > Virtual Directory
  2. Set the Alias to “cgi-bin” and press Next
  3. Set the Path to veridian\cgi-bin and press Next
  4. Enable “Run scripts (such as ASP)” and “Execute (such as ISAPI applications or CGI)” permissions
  5. Important: Enter “Properties” of local computer > Web Sites > Default Web Site > cgi-bin > imageserver > cache, and choose “None” for Execute Permissions
  6. Important: Enter “Properties” of local computer > Web Sites > Default Web Site > cgi-bin > imageserver > log, and choose “None” for Execute Permissions

3.4.2. Creating web Virtual Directory

  1. Right-click on local computer > Web Sites > Default Web Site and choose New > Virtual Directory
  2. Set the Alias to “web” and press Next
  3. Set the Path to veridian\web and press Next
  4. Enable “Read” permission only

3.4.3. Setting IIS Web Service Extension permissions

  1. Right click on local computer > Web Service Extensions and click Add a new Web Service extension…
  2. Set Extension name to “Veridian CGI” and tick “Set extension status to Allowed”
  3. Add veridian\cgi-bin\veridian.exe to Required files
  4. Set Perl CGI Extension to Allowed
  5. Set Perl ISAPI Extension to Allowed
  6. Set PerlEx ISAPI Extension to Allowed

3.5. Solr and Tomcat

Veridian™ collections use Solr for searching, as Solr supports faceted searching and handles large collections very well.

Solr runs through Tomcat, and both these packages are included in Veridian. To start Tomcat running:

  1. Install Tomcat by running veridian\packages\tomcat\apache-tomcat-6.0.32.exe (accept all defaults)
  2. Copy the veridian\packages\solr\apache-solr-4.1.war file to <TOMCAT-DIR>\webapps\solr.war (note filename change)
  3. Edit the <TOMCAT-DIR>\conf\server.xml file and add URIEncoding=”UTF-8″ maxPostSize=”-1″ to the <Connector> element on line 69.
  4. (Optional, for optimal performance on production sites) Run the “Configure Tomcat” program, change Java -> Java Virtual Machine to specify bin\server\jvm.dll instead of bin\client\jvm.dll. You will need the Java SDK rather than the JRE for this.
  5. Run the “Configure Tomcat” program, change Startup -> Working Path to the veridian directory, then start Tomcat running
  6. Check Tomcat is running by visiting http://<server>:8080
  7. Check Solr is running by visiting http://<server>:8080/solr/admin

3.6. Log files and troubleshooting

Relevant log files for a Veridian™ installation are:

Log files for the Veridian™ delivery system:
veridian\logs\veridian.<DATE>.log
Log files for the imageserver:
veridian\cgi-bin\imageserver\logs\imageserver.<DATE>.log


4. Veridian™ installation — Windows and Apache

This section describes how to install the Veridian™ software on a Windows 2000, Windows XP with Service Pack 3, Windows Server 2003, Windows Vista, Windows Server 2008 or Windows 7 system with the Apache webserver.

4.1. System requirements

The binary Windows distribution of this version of Veridian™ has been tested under Windows XP Professional with Service Pack 3.

Install the following applications:

After installation, ensure the PATH environment variable includes the path to the ActivePerl binaries. View the PATH variable at Control Panel > System > Advanced > Environment Variables > Path and check that it contains C:\Perl\site\bin;C:\Perl\bin

Lastly, the Perl DBI, DBD::SQLite and Mail::Sendmail modules are required. Install these by running the Perl cpan.exe program and entering install <pkg> (e.g. install DBI).

4.2. Installing the Veridian™ binaries from the CD-ROM or web download

Simply copy the folder named veridian from the top level of the Veridian™ CD-ROM or web download to the folder on the server in which you wish the software to be installed.

4.3. Configuration and file permissions

4.3.1. The gsdlsite.cfg configuration file

Copy the veridian\cgi-bin\gsdlsite.cfg.in configuration file to veridian\cgi-bin\gsdlsite.cfg

Edit the veridian\cgi-bin\gsdlsite.cfg configuration file and set the following configuration variables. See section 1.4 on web server configuration for more information on setting HTTP (web server) configuration variables:

veridianhome Set this to the full path of your veridian folder (e.g. C:\veridian).
solrserverurl Set this to the HTTP (web server) path of the Solr service within Tomcat (installation instructions below). This should remain as the default value unless you have to install Tomcat on a port other than 8080.
smtpserver Set this to the domain name or IP address of the SMTP server that Veridian should use to send e-mails. This is only necessary for sites with user registration.
httpdomain Set this to the full HTTP address of the server (e.g. http://veridian.mydomain.com).
gwcgi Set this to the HTTP (web server) path of your veridian\cgi-bin\veridian CGI executable. This should remain as the default value if you follow the web server configuration instructions below.
httpimageserver Set this to the HTTP (web server) path of your veridian\cgi-bin\imageserver\imageserver.pl script. This should remain as the default value if you follow the web server configuration instructions below.
httpweb Set this to the HTTP (web server) path of your veridian\web folder. This should remain as the default value if you follow the web server configuration instructions below.
httpcustomweb This setting can be ignored.

4.3.2. The ingest.cfg and runtime.cfg configuration files

These files contain configuration options for tailoring how a Veridian™ installation looks and works (described in the Veridian™ Customisation Guide). One important configuration setting in this file is the Veridian™ license key, which is required for the Veridian™ software to run. Please contact DL Consulting for a license key for each Veridian™ installation, and enter this at the top of the veridian\etc\runtime.cfg file.

4.3.3. The ImageServerConfig.pm configuration file

Copy the veridian\cgi-bin\imageserver\ImageServerConfig.pm.in configuration file to veridian\cgi-bin\ImageServerConfig.pm

Configure the imageserver by setting the following configuration variables in veridian\cgi-bin\imageserver\ImageServerConfig.pm

$veridian_home Set this to the full path of the veridian folder, but using forward slashes instead of back slashes (for example C:/veridian).
$os Set this to windows-activestate
$netpbm_bin_path Set this to the path of the veridian\cgi-bin\imageserver\bin\windows\netpbm folder, but using double backslashes (for example C:\\veridian\\cgi-bin\\imageserver\\bin\\windows\\netpbm).

Lastly, edit the veridian\cgi-bin\imageserver\imageserver.pl file and change the first line to #!C:\\Perl\\bin\\perl.exe -w

4.3.4. File permissions

Minimal setup

By default, Apache will run as the Windows system user (the “Local System” account). This user has read, write and execute permissions to all files and folders, meaning that no changes are required for Veridian™ to run.

Optimal setup

If security is a concern, the file permissions can be restricted further. We recommend in this case that the machine is used only for Veridian and not for running any other sites or applications. Create a separate user account for running the Apache service (as described here), then set up permissions as described in the “Optimal setup” part of the Windows and IIS File Permissions section (using the Apache user instead of the IIS user).

4.4. Web server configuration — Apache

Configure a new virtual host in Apache for the Veridian site. This needs to be configured so:

  • The document root is set to the veridian\web directory.
  • The veridian\cgi-bin directory is accessible at /cgi-bin, and is configured to be a CGI executable directory
  • The veridian\web directory is accessible at /web.
  • Navigating to the site URL will automatically take the user to the Veridian executable.

Do this by adding a block similar to the following to your Apache web server configuration file, then restarting the web server:

<VirtualHost *:80>
  ServerName <site-URL>
  DocumentRoot “C:/veridian/web”
  DirectoryIndex “/cgi-bin/veridian.exe”

  ScriptAlias /cgi-bin “C:/veridian/cgi-bin”
  <Directory “C:/veridian/cgi-bin”>
    Options ExecCGI FollowSymLinks
    Order allow,deny
    Allow from all
    Deny from none
  </Directory>

  Alias /web “C:/veridian/web”
  <Directory “C:/veridian/web”>
    AllowOverride All
    Options FollowSymLinks
    Order allow,deny
    Allow from all
    Deny from none
  </Directory>
</VirtualHost>

4.5. Solr and Tomcat

Veridian™ collections use Solr for searching, as Solr supports faceted searching and handles large collections very well.

Solr runs through Tomcat, and both these packages are included in Veridian. To start Tomcat running:

  1. Install Tomcat by running veridian\packages\tomcat\apache-tomcat-6.0.32.exe (accept all defaults)
  2. Copy the veridian\packages\solr\apache-solr-4.1.war file to <TOMCAT-DIR>\webapps\solr.war (note filename change)
  3. Edit the <TOMCAT-DIR>\conf\server.xml file and add URIEncoding=”UTF-8″ maxPostSize=”-1″ to the <Connector> element on line 69.
  4. (Optional, for optimal performance on production sites) Run the “Configure Tomcat” program, change Java -> Java Virtual Machine to specify bin\server\jvm.dll instead of bin\client\jvm.dll. You will need the Java SDK rather than the JRE for this.
  5. Run the “Configure Tomcat” program, change Startup -> Working Path to the veridian directory, then start Tomcat running
  6. Check Tomcat is running by visiting http://<server>:8080
  7. Check Solr is running by visiting http://<server>:8080/solr/admin

4.6. Log files and troubleshooting

Relevant log files for a Veridian™ installation are:

Log files for the Veridian™ delivery system:
veridian\logs\veridian.<DATE>.log
Log files for the imageserver:
veridian\cgi-bin\imageserver\logs\imageserver.<DATE>.log

5. Next steps

Access the veridian CGI executable from a web browser to ensure it is running correctly:

  • For Linux installations, the URL will be http://<server>/cgi-bin/veridian

  • For Windows installations, the URL will be http://<server>/cgi-bin/veridian.exe

See the Veridian™ Data Ingestion Guide for details of how to add METS/ALTO data to your new Veridian™ installation.

See the Veridian™ Customisation Guide for details of how to customise your new Veridian™ installation to best suit your needs.


6. Multiple collections in one Veridian™ installation

The preceding instructions assume that the Veridian™ installation will only contain one collection, with the internal name “veridian”. To have multiple collections in one installation:

  1. Copy the veridian directory to <COLLECTION>, where <COLLECTION> is a short code for the new collection.
  2. Configure the new collection by following the instructions in section 1 or 2, except use the path <COLLECTION> instead of the path veridian wherever it appears.
  3. Configure the web server (Apache or IIS) for each collection, and set the values in the <COLLECTION>/cgi-bin/gsdlsite.cfg file accordingly.
  4. Set the $veridian_home value in <COLLECTION>/cgi-bin/imageserver/ImageServerConfig.pm to the full path of <COLLECTION>
  5. Linux: Create a <COLLECTION>/cgi-bin/<COLLECTION> symlink to the <COLLECTION>/cgi-bin/veridian file.
  6. Windows: Rename the <COLLECTION>/cgi-bin/veridian.exe file to <COLLECTION>/cgi-bin/<COLLECTION>.exe
  7. Access the new collection at http://<server>/cgi-bin/<COLLECTION> (Linux) or http://<server>/cgi-bin/<COLLECTION>.exe (Windows).