Remote site configuration

Following parameters can be updated to adapt script create_listing_file.php to user needs or server configuration.

Some parameters needs more technical experience. Use forum to ask for advice.

Gallery parameters

$conf['gallery'] = 'http://www.mon.domaine/ma/galerie';

It's url of your main gallery. It's used to display back links and buttons.

$conf['prefix_thumbnail'] = 'TN-';

It's prefix used for thumbnail's name.

It MUST be the same than in main gallery.

PhpWebGallery default value is TN-.

$conf['file_ext'] = array('jpg','JPG','jpeg','JPEG','png','PNG','gif','GIF','mpg','zip', 'avi','mp3','ogg');

It's the extension list supported by PhpWebGallery.

Lower-case/Upper-case letters MUST be respected. You can not list files with 'pDf' extension by adding 'pdf' or 'PDF' in list.

$conf['picture_ext'] = array('jpg','JPG','jpeg','JPEG','png','PNG','gif','GIF');

It's list of image files' extension supported by PhpWebGallery.

This list SHOULD NOT be modified without asking for advice.

Time limitation parameters

A well configured web server limits execution time for scripts. It's max_execution_time PHP parameter (More information) fixed to 30 seconds by default.

If this server is really well configure, SAFE mode is on. It's safe_mode PHP parameter (More information) fixed to 1 (true).

In this context, a PHP scrip has 30 seconds to generate listing.xml file before crashing. That's what happend with very huge galleries with a PhpWebGallery release less than 1.7.0.

Release 1.7.0 of PhpWebGallery turn off this restriction displaying an intermediate page before fateful max_execution_time. This page will be reloaded (after many seconds) until file listing.xml is complete.

$conf['max_execution_time'] = (5*ini_get('max_execution_time'))/6;

It's maximum time between the script start and the intermediate page display.

Default value is 5/6 of server max execution time.

It SHOULD NOT be modified without assking for advice.
It SHOULD be part of server time.
It MUST NOT be equal to 0.

$conf['refresh_delay'] = 0;

It's time between intermediate page display and refresh.

Default value is 0 seconds;

EXIF parameters

For more information about EXIF : Wikipedia :: EXIF

$conf['use_exif'] = false;

This parameter defines if script has to extract EXIF metadatas from images listed (true) or not (false).

It MUST be equal to 'true' or 'false'.

Default value is equal to false.

$conf['use_exif_mapping'] = array(
  'date_creation' => 'DateTimeOriginal'
  );

This parameter gives the list of EXIF metadatas to extract from images.

FIXME Give the list of standard EXIF metadatas, do th link with main gallery configuration.

IPTC parameters

For more information about IPTC : Wikipedia :: IPTC

$conf['use_iptc'] = false;

This parameter defines if script has to extrcat IPTC metadatas from images listed (true) or not (false).

It MUST be equal to 'true' or 'false'.

Default value is equal to false.

$conf['use_iptc_mapping'] = array(
  'keywords'        => '2#025',
  'date_creation'   => '2#055',
  'author'          => '2#122',
  'name'            => '2#005',
  'comment'         => '2#120');

This parameter gives the list of IPTC metadatas to extract from images.

FIXME Give the list of standard IPTC metadatas, do th link with main gallery configuration.

Directory protect parameters

$conf['protect'] = false;

This parameter define if listed directories have to be automatically protected (true) or not (false).

It MUST be equal to 'true' or 'false'.

Default value is false.

$conf['protect_content'] = '<?php header("Location: '.$conf['gallery'].'") ?>';

It's the content of file index.php created in each listed directory to protect.

Default content automatically redirect visitors at the url configured in gallery parameters.

$conf['protect_warnings'] = true;

This parameter define if script displays warning message (true) or not (false) when a directory is already protected.

It MUST be equla to'true' or 'false'.

Default value is false.

Thumbnail generation parameters

$conf['thumbnail'] = false;

This parameter define if thumbnail has to be automatically generated (true) or not (false) when it does not exist.

It MUST be equal to 'true' or 'false'. Thumbnail generation is auomatically deactivated if web server does not support image generation or if others parameters are incorect.

Default value is false.

$conf['thumbnail_method'] = 'ratio';

It's the method used to calculate the thumbnail size:

  • 'fixed' : thumbnail size is fixed with parameters thumbnail_width and thumbnail_height.
  • 'width' : thumbnail width is fixed with parameter thumbnail_width. The height will keep the original ratio width/height.
  • 'height' : thumbnail height is fixed with parameter thumbnail_height. The width will keep the original ratio width/height
  • 'ratio' : thumbnail width/height will be equal to original width/height multiplied by thumbnail_ratio.
  • 'exif' : thumbnail is extracted from EXIF matadatas.
  • All other values switch off the automatic thumbnail generation.

Default value is equal to ratio.

$conf['thumbnail_height'] = 128;

Thumbnail height in pixels.

If used, it MUST be numerical and greater than 0. In all other cases, automatic thumbnail generation is deactivated.
It's MANDATORY when generation method is 'fixed' or 'height.

Default value is 128 pixels, it's the default height size on the main gallery.

$conf['thumbnail_width'] = 128;

Thumbnail width in pixels.

If used, it MUST be numerical and greater than 0. In all other cases, automatic thumbnail generation is deactivated.
It's MANDATORY when generation method is 'fixed' or 'width.

Default value is 128 pixels, it's the default width size on the main gallery.

$conf['thumbnail_ratio'] = 0.2;

It's the ratio between original and thumbnail size.

If used, it MUST be numerical and strictly between 0 and 1. In all other cases, automatic thumbnail generation is deactivated.
It's MANDATORY when generation method is 'ratio'.

Default value is 0.2 (20%).

$conf['thumbnail_format'] = 'jpeg';

It's both image format of thumbnail and its name extension.

It CAN be equal to 'jpeg', 'gif' or 'png'. All aother values deactivate tha automatic thumbnail generation.
It MUST be supported by web server. In otehr case, thumbnail generation is deactevated.

Default value is equal to jpeg.

 
Back to top
user_documentation/oldies/remote_site_configuration.txt · Last modified: 2013/03/08 14:20 by flop25
 
 
github twitter facebook google+ newsletter Donate Piwigo.org © 2002-2019 · Contact