Installing EPrints 3 on Win32: Difference between revisions

Latest revision as of 10:31, 29 May 2022

Download an appropriate EPrints Release

This feature requires EPrints version 3.2.1 or later

EPrints 3.4+ no longer supports installation on Windows. If you do not have a Linux server, you can always create a Linux virtual machine on a Windows PC, get one on a Cloud hosting service or use Docker.

This page contains notes concerning installing version EPrints 3.3 on Win32-based platforms. Windows is not a well-supported platform and these instructions are likely to go out of date, due to the complexity of getting a working Apache-Perl environment working. It is strongly recommended to install EPrints on Linux operating system such as RedHat or Ubuntu.

Requirements

Microsoft Windows XP or later
Apache 2.0 or later
MySQL 5 or later
ModPerl 2.0 or later

For indexing and thumbnailing you will also need:

ImageMagick
xpdf (for the pdftotext utility)
GNU Win32 tools

Download EPrints Windows Installation Package (MSI)

Download the latest Win32 build from the link at the top of this page - do not install this until ALL supporting software is in place and in the places outlined!

Supporting Software

MySQL

Download and install 64bit MySQL from http://dev.mysql.com/downloads/mysql/

During the MySQL configuration Wizard:

Change default character set to Best support For Multilingualism

Apache

Download and install the 64bit Apache 2.2 from http://www.apachelounge.com/download/ to C:\Apache2.

Add C:\Apache2\bin to the windows path environment variable. Failure to add this path will result with a missing libaprutil-1.dll error when you attempt to run EPrints.

Perl

Download and install the 64bit Strawberry Perl 5.16 from http://strawberryperl.com/ to C:\Strawberry

Nod_Perl

Download and install the 64bit mod_perl for Strawberry Perl 5.16 from http://people.apache.org/~stevehay/.

Perl Modules

At a command-prompt run:

> cpan install Win32-Daemon
> cpan install Win32-DriveInfo

Indexing and Thumbnailing Tools

To get indexing and thumbnailing working will require some configuration file changes.

When you have installed a tool you need to tell EPrints where to find it. Edit perl_lib\EPrints\SystemSettings.pm:

$EPrints::SystemSettings::conf = {
 ...,
 executables => {
  convert => '/ImageMagick/convert.exe',
  pdftotext => '/xpdf/pdftotext.exe',
 },
};

For a full list of tools look in lib\syscfg.d\executables.pl.

Configuration

Edit the Apache configuration file C:\Apache2\conf\httpd.conf and add below the last LoadModule line:

# LoadFile C:/perl/bin/perl510.dll # Not necessary?
LoadModule perl_module modules/mod_perl.so

And at the end of the file:

Include C:/eprints/cfg/apache.conf

Getting Started

To create the indexer service entries (EPrints 3.3+), as administrator run:

> perl C:\eprints\bin\indexer install

Before starting Apache configure a new repository, see Getting Started with EPrints 3.

You will need to manually restart the indexer if you change the repository configuration.

@@ Line 2: / Line 2: @@
 {{Version|since=3.2.1}}
-This page contains notes concerning installing version 3.2 on Win32-based platforms. There is still work to go on supporting EPrints on Win32.
+'''EPrints 3.4+ no longer supports installation on Windows.  If you do not have a Linux server, you can always create a Linux virtual machine on a Windows PC, get one on a Cloud hosting service or use [[Installing_EPrints_using_Docker|Docker]].'''
+This page contains notes concerning installing version EPrints 3.3 on Win32-based platforms. Windows is not a well-supported platform and these instructions are likely to go out of date, due to the complexity of getting a working Apache-Perl environment working.  It is strongly recommended to install EPrints on Linux operating system such as [[Installing EPrints on RHEL/Fedora/CentOS|RedHat]] or [[Installing EPrints on Debian/Ubuntu|Ubuntu]].
 ==Requirements==
@@ Line 10: / Line 12: @@
 * MySQL 5 or later
 * ModPerl 2.0 or later
+For indexing and thumbnailing you will also need:
+* [http://www.imagemagick.org/ ImageMagick]
+* [http://www.foolabs.com/xpdf/ xpdf] (for the pdftotext utility)
+* [http://gnuwin32.sourceforge.net/ GNU Win32 tools]
 ==Download EPrints Windows Installation Package (MSI)==
-Do not install this until ALL supporting software is in place and in the places outlined.
+Download the latest Win32 build from the link at the top of this page - do not install this until ALL supporting software is in place and in the places outlined!
-http://files.eprints.org/517/3/EPrints%2D3.2.1%2Drc%2D2.msi
+==Supporting Software==
-==Supporting Software==
+===MySQL===
-===Apache===
+Download and install 64bit MySQL from http://dev.mysql.com/downloads/mysql/
-Download and install Apache 2.2 + OpenSSL (if needed) from http://httpd.apache.org/download.cgi#apache22.
+During the MySQL configuration Wizard:
-* Change the installation directory to '''C:\Apache'''
+* Change default character set to '''Best support For Multilingualism'''
-* After install manually add '''C:\Apache\bin''' to the windows path enviroment variable.
-===MySQL===
+===Apache===
-Download and install MySQL from http://dev.mysql.com/downloads/mysql/
+Download and install the 64bit Apache '''2.2''' from http://www.apachelounge.com/download/ to C:\Apache2.
-* Change default character set to '''Best support For Multilingualism'''
+* Add '''C:\Apache2\bin''' to the windows path environment variable. Failure to add this path will result with a missing libaprutil-1.dll error when you attempt to run EPrints.
 ===Perl===
-Download and install ActiveState Perl from http://www.activestate.com/activeperl/downloads/
+Download and install the 64bit Strawberry Perl 5.16 from http://strawberryperl.com/ to C:\Strawberry
-===ModPerl===
+==Nod_Perl==
-Install mod_perl from the command prompt:
+Download and install the 64bit mod_perl for Strawberry Perl 5.16 from http://people.apache.org/~stevehay/.
-* ppm install http://cpan.uwinnipeg.ca/PPMPackages/10xx/mod_perl.ppd
+===Perl Modules===
-* When asked, set the Apache modules directory to '''C:/Apache/modules'''
-===Other Modules===
+At a command-prompt run:
-From the command-prompt execute:
+ > cpan install Win32-Daemon
-> ppm area list
+ > cpan install Win32-DriveInfo
- ┌────────────┬──────┬──────────────────────┐
- │ name       │ pkgs │ lib                  │
- ├────────────┼──────┼──────────────────────┤
- │ (perl_lib) │  n/a │ C:/eprints//perl_lib │
- │ (site)     │    2 │ C:/Perl/site/lib     │
- │ (perl)     │  206 │ C:/Perl/lib          │
- └────────────┴──────┴──────────────────────┘
-If the "site" name is in brackets (as shown) you need to fix the permissions on C:/Perl/site so that your user can write to it (TODO: why can't Administrator users write using ppm???).
+===Indexing and Thumbnailing Tools===
-Add the uwinnipeg repository to PPM:
+To get indexing and thumbnailing working will require some configuration file changes.
-* Start the "Perl Package Manager" (ActiveState Perl start menu)
+When you have installed a tool you need to tell EPrints where to find it. Edit perl_lib\EPrints\SystemSettings.pm:
-* Edit --> Preferences
-* Under the Repositories tab add the University of Winnipeg repository from the suggested list.
-* Click Ok then close PPM
-Install DBD::mysql from the command prompt:
+ $EPrints::SystemSettings::conf = {
+  ...,
+  executables => {
+   convert => '/ImageMagick/convert.exe',
+   pdftotext => '/xpdf/pdftotext.exe',
+  },
+ };
-* ppm install DBD-mysql
+For a full list of tools look in lib\syscfg.d\executables.pl.
-Install XML::LibXML from the command prompt:
-* ppm install XML-LibXML
 ==Configuration==
-Edit the Apache configuration file '''C:\Apache\conf\httpd.conf''' and add below the last LoadModule line:
+Edit the Apache configuration file '''C:\Apache2\conf\httpd.conf''' and add below the last LoadModule line:
-  LoadFile C:/perl/bin/perl510.dll
+  # LoadFile C:/perl/bin/perl510.dll # Not necessary?
   LoadModule perl_module modules/mod_perl.so
@@ Line 82: / Line 80: @@
   Include C:/eprints/cfg/apache.conf
+==Getting Started==
+To create the indexer service entries (EPrints 3.3+), as administrator run:
+ > perl C:\eprints\bin\indexer install
+Before starting Apache configure a new repository, see [[Getting Started with EPrints 3]].
+You will need to manually restart the indexer if you change the repository configuration.