Minimum requirements

From Qubit Toolkit

Jump to: navigation, search

[edit] PHP version

Qubit requires PHP 5.3 or higher.

[edit] PHP configuration

The default PHP configuration is sufficient for many simple websites, but due to the multimedia aspects and potential for very large datasets in Qubit, some modifications will probably need to be made to this default configuration.

See PHP script execution limits for details on PHP configuration settings that may need to be increased for Qubit to run smoothly.

Qubit functionality that is especially resource intensive and therefore most likely to exceed the default configuration limits include:

[edit] Database

Qubit is developed and tested using MySQL 5.

Qubit is built on the Symfony framework and uses the Propel object-relation mapping (ORM) framework. This should theoretically allow the use of a wide range of SQL databases (including MSSQL Server, PostgreSQL, SQLite and Oracle [1]). However, we have limited development & support resources and offer no support for DBMS' other than MySQL.

[edit] Dependencies (required)

[edit] PDO

Required for
PDO is required for all data access in Qubit, and therefore is a requirement for running Qubit.
Installation
Installing MySQL PDO
Notes
  • Qubit uses the PDO extension, via the Symfony framework and the Propel ORM (v1.2), to abstract calls to the DBMS layer. This abstraction allows Qubit to (theoretically) use any of a wide range of SQL databases - including MySQL, PostgreSQL, Oracle, MSSQL, and others.
  • Although PDO communicates with many DBMSs, it uses database specific extensions to translate SQL statements. The installation instructions above are specifically for PDO-MySQL.

[edit] Multibyte string

Required for
Qubit is a multi-lingual, multi-script application; therefore it requires the PHP Multibyte String extension.
Installation
Installing mbstring
Notes
The Qubit search engine will not initialize without the mbstring extension

[edit] Propel

Required for
Qubit via Symfony uses Propel to easily manage ‘externals’ database connections Propel features.
Installation
Install the php-pear-propel_runtime package using your Operating System package manager (such as yum or rpm) or Download Propel and follow installation instructions.
Notes
The Qubit System Check installation step may fail if you do not have this package installed

[edit] Other dependencies (not required)

[edit] GD PHP extension

Required for
The GD or ImageMagick extension are required for creating image derivatives (e.g. reference, thumbnail).
Installation
Installing GD
Notes
No additional notes

[edit] ImageMagick software suite

Required for
  • The GD or ImageMagick extension are required for creating image derivatives (e.g. reference, thumbnail).
  • ImageMagick additionally allows creating derivatives images from multi-page TIFFs.
  • ImageMagick and Ghostscript are required for creating single page and multi-page PDF derivative images.
Installation
Installing ImageMagick
Notes
If the ImageMagick suite is available it will be used preferentially over the GD library for creating image derivatives.

[edit] Ghostscript

Required for
ImageMagick and Ghostscript are required for creating single page and multi-page PDF derivative images.
Installation
Installing Ghostscript
Notes
No additional notes

[edit] FFmpeg

Required for
Creating video derivatives - including creating a flash reference video derivative for in-browser viewing.
Installation
Installing FFmpeg
Notes
The FFmpeg library allows converting a wide range of video and audio formats to the flash video format required for in-browser viewing in Qubit. It also supports creating image derivatives from the first frame of the video.

[edit] XSL PHP extension

Required for
Qubit uses the PHP XSL extension for some XML import and export functions. We recommend installing XSL to enable this functionality and allow migrating data to and from Qubit.
Installation
In Ubuntu, run "sudo aptitude install php5-xsl". See also these generic instructions from PHP.net.
Notes
No additional notes