Difference between revisions of "Gallery2:Installation Requirements" - Gallery Codex
Personal tools

Difference between revisions of "Gallery2:Installation Requirements"

From Gallery Codex

(Database)
m (Text replacement - "codex.gallery2.org" to "codex.galleryproject.org")
 
(46 intermediate revisions by 20 users not shown)
Line 2: Line 2:
 
==Web Server==
 
==Web Server==
 
===Apache===
 
===Apache===
 +
 
'''Apache''' ([http://httpd.apache.org/docs/ Apache 1], [http://httpd.apache.org/docs-2.0/ Apache 2]) is the most popular web server in the world, and is the one recommended by the Gallery Team for use with Gallery 2.   
 
'''Apache''' ([http://httpd.apache.org/docs/ Apache 1], [http://httpd.apache.org/docs-2.0/ Apache 2]) is the most popular web server in the world, and is the one recommended by the Gallery Team for use with Gallery 2.   
 
It can be downloaded from the [http://httpd.apache.org Apache HTTPD Project's site]
 
It can be downloaded from the [http://httpd.apache.org Apache HTTPD Project's site]
 
===IIS===
 
===IIS===
Microsoft's '''[http://www.microsoft.com/WindowsServer2003/iis/default.mspx IIS]''' (Internet Information Services) web server has also been known to work. Short URLs / G1 redirects (URL rewrite module) are not yet supported for IIS. Also take a look at our [[Gallery2:Installation_on_Windows_Server_2003_and_IIS6|Windows Server 2003 and IIS 6 Howto]].
+
Microsoft's '''[http://www.microsoft.com/WindowsServer2003/iis/default.mspx IIS]''' (Internet Information Services) web server has also been known to work. But there are some limitations. See [[Gallery2:Known_Issues|Known Issues]] for details. Short URLs work, but G1 redirects are not yet supported for IIS. Also take a look at our [[Gallery2:Installation_on_Windows_Server_2003_and_IIS6|Windows Server 2003 and IIS 6 Howto]].
  
 
===Zeus, ...===
 
===Zeus, ...===
Line 13: Line 14:
 
Gallery is written in '''PHP''' (recursive acronym for '''PHP: Hypertext Preprocessor''').  It is one of the most popular, free web-based languages in the world today.  It can also be downloaded gratis from the [http://www.php.net PHP Project's site].
 
Gallery is written in '''PHP''' (recursive acronym for '''PHP: Hypertext Preprocessor''').  It is one of the most popular, free web-based languages in the world today.  It can also be downloaded gratis from the [http://www.php.net PHP Project's site].
  
Gallery requires at least version 4.x (4.1.0 or more recent) or 5.x (5.0.4 or more recent) to function properly. Note: Gallery 2 has [http://codex.gallery2.org/index.php/Gallery2:FAQ#install.2Findex.php_is_blank_or_shows_an_error._What.27s_wrong.3F problems with PHP 5.0.5 due to a bug in PHP ].
+
=== PHP Version Compatibility ===
 +
Gallery requires at least version 4.x (4.3.0 or more recent) or 5.x (5.0.4 or more recent) to function properly. Note: Gallery 2 has [http://codex.galleryproject.org/index.php/Gallery2:FAQ#install.2Findex.php_is_blank_or_shows_an_error._What.27s_wrong.3F problems with PHP 5.0.5 due to a bug in PHP ].
 +
 
 +
:'''Notes:'''
 +
* '''PHP 5 is highly recommended''' - [http://php.net/ PHP] will not release any security updates for PHP 4 after 2008/08/08. If your webhost is still running PHP 4, please ask them to switch to PHP 5 as soon as possible for security reasons (not just for Gallery, but for all PHP applications).
 +
* Only Gallery 2.3.1 supports PHP 5.3. PHP 5.3 is incompatible with Gallery 2.0 - 2.3.
 +
* PHP 6 is incompatible with Gallery 2.0 - 2.3; not yet tested with Gallery 2.3.1
 +
 
 
===PHP Settings===
 
===PHP Settings===
 
In addition to a basic PHP installation, Gallery requires certain PHP settings to be setup correctly in order to function optimally.
 
In addition to a basic PHP installation, Gallery requires certain PHP settings to be setup correctly in order to function optimally.
Line 19: Line 27:
 
PHP settings can be changed in php.ini, as described in the [http://www.php.net/configuration.changes PHP documentation]
 
PHP settings can be changed in php.ini, as described in the [http://www.php.net/configuration.changes PHP documentation]
 
*'''[http://www.php.net/features.safe-mode safe_mode]''' safe_mode '''must be disabled''' in order for Gallery to work correctly
 
*'''[http://www.php.net/features.safe-mode safe_mode]''' safe_mode '''must be disabled''' in order for Gallery to work correctly
*'''[http://www.php.net/features.safe-mode#ini.disable-functions disable_functions]''' The disable_functions directive must not include the functions '''exec''' and '''set_time_limit'''
+
** for a in depth discussion on safe mode please read this [http://galleryproject.org/node/3017 forum thread].
 +
*'''[http://www.php.net/features.safe-mode#ini.disable-functions disable_functions]''' The disable_functions directive must not include the function '''set_time_limit'''.
 
*'''[http://www.php.net/features.file-upload file_uploads]''' file_uploads must be set to '''On''' if Gallery is to be able to upload files from your computer
 
*'''[http://www.php.net/features.file-upload file_uploads]''' file_uploads must be set to '''On''' if Gallery is to be able to upload files from your computer
 +
*'''[http://www.php.net/manual/en/ini.core.php#ini.upload-max-filesize upload_max_filesize]''' and '''[http://www.php.net/manual/en/ini.core.php#ini.post-max-size post_max_size]'''  These configuration parameters control the maximum file size that can be uploaded.  Adjust these from the default '''2M''' setting to something larger if you have problems uploading pictures from higher resolution cameras.
 +
*If you want to use the localization feature then PHP should be configured with the '''[http://www.php.net/manual/en/ref.gettext.php gettext]''' option enabled.
  
 
[[User:alindeman|alindeman]] has created a script to check your Gallery for potential problems due to PHP settings.  [[Downloads:GHCC|Download]] the script and upload it to your host. Open the script in your browser ({{exampleurl|/ghcc.php}}).  If any tests fail, you may need to adjust your settings before trying to install Gallery.
 
[[User:alindeman|alindeman]] has created a script to check your Gallery for potential problems due to PHP settings.  [[Downloads:GHCC|Download]] the script and upload it to your host. Open the script in your browser ({{exampleurl|/ghcc.php}}).  If any tests fail, you may need to adjust your settings before trying to install Gallery.
  
 
==Database==
 
==Database==
Gallery 2 requires one of the following database management systems (DBMS): '''[http://mysql.com/ MySQL]''' 3.x or 4.x, '''[http://www.postgresql.org/ PostgreSQL]''' 7.x, 8.x, '''[http://www.oracle.com/ Oracle]''' 9i or 10g, '''[http://www.ibm.com/software/data/db2/ DB2]''' 8.2
+
Gallery 2 requires one of the following database management systems (DBMS): '''[http://mysql.com/ MySQL]''' 3.x or 4.x, 5.x, '''[http://www.postgresql.org/ PostgreSQL]''' 7.x, 8.x, '''[http://www.oracle.com/ Oracle]''' 9i or 10g, '''[http://www.ibm.com/software/data/db2/ IBM DB2]''' 8.2, '''[http://www.microsoft.com/sql/ Microsoft SQL Server]'''
 +
 
 +
:'''Note:''' MS SQL Server has only limited support for international characters (unicode). Read more at [[Gallery2:MSSQL|Limitations of Microsoft SQL Server]]
 +
 
 +
Additional RDBMS specific notes:
 +
* [[Gallery2:DB2]]
 +
* [[Gallery2:MSSQL]]
 +
* [[Gallery2:MySQL]]
 +
* [[Gallery2:Oracle]]
 +
* [[Gallery2:PostgreSQL]]
  
 
==Image Processing Library==
 
==Image Processing Library==
Line 43: Line 63:
  
 
===ffmpeg===
 
===ffmpeg===
If the Ffmpeg module is activated, it will automatically create thumbnails for movies. The ffmpeg module requires the [http://ffmpeg.sourceforge.net/ ffmpeg] binary. If you have shell access to the server, you can install ffmpeg with the packaging system of your linux distribution. For MS Windows, we offer a pre-compiled binary on [http://sourceforge.net/project/showfiles.php?group_id=7130&package_id=14464 our sf.net download page].<br>You can try http://langleycom.com/gallery_download/ffmpeg for one for freebsdIt has some issues ( some formats not supported) but it might help.<br> 
+
If the Ffmpeg module is activated, it will automatically create thumbnails for movies. The ffmpeg module requires the [http://ffmpeg.mplayerhq.hu/ ffmpeg] binary. If you have shell access to the server, you can install ffmpeg with the packaging system of your linux distribution.
If you have a "Unix DAV/1.0.3" server try this thread: http://gallery.menalto.com/node/36596#comment-141996 it is from Dream Host.<br>
+
* [http://wiki.dreamhost.com/index.php/FFmpeg Dreamhost] directions (should be similar to most hosts.
I will remove these when one better comes along.....
+
Windows:
 +
* For MS Windows, we offer a pre-compiled binary on [http://sourceforge.net/project/showfiles.php?group_id=7130&package_id=14464 our sf.net download page].
 +
Other OSs:
 +
* Pre-compiled linux ffmpeg binary with Ogg support [http://video-conversion-blog.com/downloads/category/3-p ffmpeg version 0.5.1 linux binary]. Tested on Gallery 2 on Dreamhost.
 +
* Try http://www.flashyourweb.com/filemgmt/visit.php?lid=11 for another precompiled version for linux Compiled on 06/16/2007.  (14B)
 +
* If you have a "Unix DAV/1.0.3" server try this thread: http://galleryproject.org/node/36596#comment-141996 it is from Dream Host.
 +
* [http://wiki.dreamhost.com/index.php/FFmpeg Dreamhost] directions (should be similar to most hosts.
 +
* If you get a error about; ''while loadingshared libraries'' see: [http://lists.mplayerhq.hu/pipermail/ffmpeg-user/2006-December/005644.html ffmpeg list]
 +
Mac OS:
 +
If you are using Gallery2 on Mac OS X, then you need to [[Gallery2:Modules:ffmpeg#Usage|read the steps on this wiki page]] to get/install ffmpeg and configure the ffmpeg Gallery2 module.
  
 
===dcraw===
 
===dcraw===
Line 59: Line 88:
 
zip is required for the zip download module and unzip for the archive upload module. Most linux / unix based platforms already have these binaries. For MS Windows, the zip.exe / unzip.exe binaries from [http://www.cygwin.com/ cygwin] are also an alternative, make sure you select the zip tool under archive during the install (it will not install by default), it is located in /bin/.
 
zip is required for the zip download module and unzip for the archive upload module. Most linux / unix based platforms already have these binaries. For MS Windows, the zip.exe / unzip.exe binaries from [http://www.cygwin.com/ cygwin] are also an alternative, make sure you select the zip tool under archive during the install (it will not install by default), it is located in /bin/.
  
[[Category:Gallery2:Installation|Requirements]]
+
[[Category:Gallery 2:Installation|Requirements]]

Latest revision as of 15:23, 1 July 2013

Gallery has certain technical requirements that must be met (i.e. installed and/or configured) on your server before you attempt to install it.

Web Server

Apache

Apache (Apache 1, Apache 2) is the most popular web server in the world, and is the one recommended by the Gallery Team for use with Gallery 2. It can be downloaded from the Apache HTTPD Project's site

IIS

Microsoft's IIS (Internet Information Services) web server has also been known to work. But there are some limitations. See Known Issues for details. Short URLs work, but G1 redirects are not yet supported for IIS. Also take a look at our Windows Server 2003 and IIS 6 Howto.

Zeus, ...

There are a lot of alternative web servers. G2 should work on any web server that can run PHP. But short URLs / G1 redirects (URL rewrite module) probably do not work with all of them.

PHP

Gallery is written in PHP (recursive acronym for PHP: Hypertext Preprocessor). It is one of the most popular, free web-based languages in the world today. It can also be downloaded gratis from the PHP Project's site.

PHP Version Compatibility

Gallery requires at least version 4.x (4.3.0 or more recent) or 5.x (5.0.4 or more recent) to function properly. Note: Gallery 2 has problems with PHP 5.0.5 due to a bug in PHP .

Notes:
  • PHP 5 is highly recommended - PHP will not release any security updates for PHP 4 after 2008/08/08. If your webhost is still running PHP 4, please ask them to switch to PHP 5 as soon as possible for security reasons (not just for Gallery, but for all PHP applications).
  • Only Gallery 2.3.1 supports PHP 5.3. PHP 5.3 is incompatible with Gallery 2.0 - 2.3.
  • PHP 6 is incompatible with Gallery 2.0 - 2.3; not yet tested with Gallery 2.3.1

PHP Settings

In addition to a basic PHP installation, Gallery requires certain PHP settings to be setup correctly in order to function optimally.

PHP settings can be changed in php.ini, as described in the PHP documentation

  • safe_mode safe_mode must be disabled in order for Gallery to work correctly
    • for a in depth discussion on safe mode please read this forum thread.
  • disable_functions The disable_functions directive must not include the function set_time_limit.
  • file_uploads file_uploads must be set to On if Gallery is to be able to upload files from your computer
  • upload_max_filesize and post_max_size These configuration parameters control the maximum file size that can be uploaded. Adjust these from the default 2M setting to something larger if you have problems uploading pictures from higher resolution cameras.
  • If you want to use the localization feature then PHP should be configured with the gettext option enabled.

alindeman has created a script to check your Gallery for potential problems due to PHP settings. Download the script and upload it to your host. Open the script in your browser (http://www.example.com/gallery/ghcc.php). If any tests fail, you may need to adjust your settings before trying to install Gallery.

Database

Gallery 2 requires one of the following database management systems (DBMS): MySQL 3.x or 4.x, 5.x, PostgreSQL 7.x, 8.x, Oracle 9i or 10g, IBM DB2 8.2, Microsoft SQL Server

Note: MS SQL Server has only limited support for international characters (unicode). Read more at Limitations of Microsoft SQL Server

Additional RDBMS specific notes:

Image Processing Library

Gallery 2 requires either NetPBM 9.x or newer, ImageMagick 4.x or newer, GD 2.x or newer, or GraphicsMagick 1.x or newer in order to operate (e.g. generate thumbnails) on your images and photographs.

More information on how to install an image processing library is explained on Installing an Image Processing Library

Optional Items

mod_rewrite

mod_rewrite is an Apache server extension that enables your Gallery 2 to use "short URLs." That is, instead of

 http://www.example.com/gallery/main.php?g2_view=core.ShowItem&g2_itemId=17&g2_serialId=2

the URL would be reduced to

 http://www.example.com/gallery/v/albumName

Gallery 2 will attempt to automatically check for the presence of mod_rewrite during the installation process if you select the URL rewrite module.

ffmpeg

If the Ffmpeg module is activated, it will automatically create thumbnails for movies. The ffmpeg module requires the ffmpeg binary. If you have shell access to the server, you can install ffmpeg with the packaging system of your linux distribution.

  • Dreamhost directions (should be similar to most hosts.

Windows:

Other OSs:

Mac OS: If you are using Gallery2 on Mac OS X, then you need to read the steps on this wiki page to get/install ffmpeg and configure the ffmpeg Gallery2 module.

dcraw

Dcraw is a graphics toolkit that can be used to process RAW images produced by high end digital cameras. You must install the dcraw binary to activate the dcraw module in G2.

jhead

jhead is a free tool that can be used to extract EXIF data from images, which most digital cameras now add to photos. If enabled, EXIF data will be preserved when operating with the netpbm toolkit on your original photos in G2. You don't need jhead for the EXIF features in G2, a library written in PHP is used to extract the EXIF data from images. Imagemagick and GD don't need jhead to preserve the exif data when manipulating images.

infozip

infozip is a free tool that allows Gallery to unzip ZIP archives so that you can easily upload multiple photos. If enabled, you will be able to upload a ZIP archive as you would any other single picture, and Gallery will add all the images in the archive.

zip / unzip

zip is required for the zip download module and unzip for the archive upload module. Most linux / unix based platforms already have these binaries. For MS Windows, the zip.exe / unzip.exe binaries from cygwin are also an alternative, make sure you select the zip tool under archive during the install (it will not install by default), it is located in /bin/.

advertisements