Installation

From ResourceSpace Documentation Wiki
Revision as of 22:34, 15 September 2010 by Theorysavage (Talk | contribs)

Jump to: navigation, search

ResourceSpace is a fairly standard PHP/MySQL application and the process should be familiar if you've installed other PHP/MySQL applications before.

Most issues encountered relate to the default php.ini settings. As you may be handling large resource files the default values for memory, upload size etc. often need to be increased.

  • First check that your target system meets the requirements.
  • Tweak your PHP.INI settings as follows: you will probably want to increase the size of the "memory_limit", "post_max_size" and "upload_max_filesize" variables in your system's php.ini file if you will be handling large files. These are set quite low by default. "short_open_tag" should be set to Off (On is fine, but any problems with Off should be reported). You should also increase the max execution time to allow for the completion of larger file transfers. If you do not have access to the php.ini file (for example, because you are using an ISP) then you may be able to override the settings by creating a file named '.htaccess' in the root folder with the following contents:
SecFilterEngine Off
SecFilterScanPOST Off
php_value memory_limit 200M
php_value post_max_size 100M
php_value upload_max_filesize 100M
php_value short_open_tag Off
  • Unzip the web file to an appropriate folder off your web root. The application is capable of running both in the web root folder or several levels deep within an existing folder structure. SVN checkout is preferable to the zip file if you're familiar with SVN (whether you are a developer or not), as it permits simple upgrades of the software.
  • Create an empty database (ResourceSpace will automatically create database tables etc.)
  • The 'filestore' and 'include' folders must be writeable by the web server (either 'chmod 777 filestore' then 'chmod -R 777 include' or chown/chgrp the folders to your web server's user/group).
  • The system should now be up and running at the configured URL and the setup process will commence.
  • The default admin login is "admin" password "admin". Try 'Team Centre -> Installation Check' to make sure everything is configured correctly.

Important: When in the system is in full use (i.e. when you go live) the file 'cron_copy_hitcount.php' should be set to execute once each night so the relevance matching works correctly. You can do this using a cron job which runs 'wget' and fetches the file's URL. This script copies the resource usage information collected during the day from the temporary columns into the live columns, and doesn't happen in real time because the resource/keyword usage counts are used to order resources when searching (this is how the relevance matching works), and if the counters updated instantly the resources would appear to jump around in your result set as you accessed them, as your own activity would be immediately affecting the search order.

A lot of the configuration (fields, user groups, etc.) can be configured within the Setup area of the Team Centre. The Team Centre itself is the admin area for the resources team and that's where the user management, reporting, and so on takes place.

The GD library (which is a minimum requirement) will provide automatic thumbnail for JPEG, GIF and PNG files. To add many more image and video file formats you can install ImageMagick and FFmpeg and set the paths to the binaries in config.php.

If using Apache it is important to make sure that the Indexes option is not set. If this is set the 'filestore' folder will be browsable which means resources will be available to all as the scrambled resource paths will be clearly visible.

Check Team Centre->Installation Check to be sure that the filestore folder is not browsable.

Installing on Ubuntu Linux / Debian Linux

See main article Installing on Ubuntu Linux

Installing on Windows

ResourceSpace can be installed on 32-bit and 64-bit versions of Windows XP, Vista, Server 2003, Server 2008, Windows 7, and Server 2008 R2.

Installing on Windows XP 32-bit with IIS 5.1

Installing on Windows XP 64-bit with IIS 6.0

Installing on Windows Server 2003 32-bit with IIS 6.0

Installing on Windows Server 2003 64-bit with IIS 6.0

Installing on Windows Server 2008 32-bit with IIS 7.0

Installing on Windows Server 2008 64-bit with IIS 7.0

Installing on Windows 7 32-bit with IIS 7.5

Installing on Windows 7 64-bit with IIS 7.5

Installing on Windows Server 2008 R2 64-bit with IIS 7.5

Installing on Mac OS X

For 10.5, see Installing on Mac OS X Leopard (this is a similar process for 10.4)

For 10.6, see Installing on Mac OS X Snow Leopard.

Developers

If you are a PHP developer you may be comfortable installing the latest development edition directly from Subversion. See the Subversion section for more details.

This version has the latest hooks which is useful if you plan on creating plugins to extend functionality. You can also easily update the software using 'svn update'.

Troubleshooting

Make sure config.php hasn't been broken, perhaps by saving it in UTF-8 with a BOM header, which PHP doesn't like.

Also make sure you haven't accidentally added any extra blank lines before the opening PHP tag at the beginning of the file, or after the closing tag at the end of the file.

Always run "Installation Check" in the Team Centre after installing or if you encounter any issues.