All text is available under the terms of the GNU Free Documentation License. For the latest version of this document, see Wikibooks.

Zoph/Configuration

Contents

Interface configuration

ZOPH_TITLE

ZOPH_TITLE Versions: All versions
Description: The title for the application. This is what appears on the home page and in the browser's title bar.
Default: Zoph
Options: You could set it to something like "My Photo Album".
Example: define('ZOPH_TITLE', 'My Photos');

MAX_CRUMBS

MAX_CRUMBS Versions: All versions
Description: The maximum number of breadcrumbs to allow
Default: 100
Options:
Example: define('MAX_CRUMBS', 100);

MAX_DAYS_PAST

MAX_DAYS_PAST Versions: All versions
Description: How many days appear in the dropdown on the search page for "photos taken/modified X days ago"
Default: 30
Options:
Example: define('MAX_DAYS_PAST', 40);

ZOPH_URL

ZOPH_URL Versions: 0.4 and later
Description: The URL where your Zoph installation can be reached. Make sure to include http:// and no html filename. This is used for sending e-mails and SSL login.
Default:
Options:
Example: define('ZOPH_URL', 'http://www.myserver.com/zoph');

ZOPH_SECURE_URL

ZOPH_SECURE_URL Versions: 0.5 and later
Description: The URL where your Zoph installation can be reached, when SSL or SSL Login is used. Make sure to include https:// and no html filename. This is used for SSL usage and login.
Default:
Options:
Example: define('ZOPH_SECURE_URL', 'https://www.myserver.com/zoph');

MAX_PEOPLE_SLOTS

MAX_PEOPLE_SLOTS Versions: 0.5 and later
Description: How many "add people" dropdowns can a user configure. This determines what the maximum value is that the user can configure via the prefs page. If it is set to 10 and a user changes his preferences to 6, the user can add 6 people at once on an edit photo page. (provided the user has edit rights).
Default: 1
Options: Any integer. 1 will make Zoph 0.5 behave like the older versions. Large numbers can have an impact on performance, 5-10 would be a reasonable maximum.
Example: define('MAX_PEOPLE_SLOTS', 5);

Authentication

$VALIDATOR

$VALIDATOR Versions: 0.4 and later
Description: Selects validation method. It needs to be a function in validator.inc.php.
Default: default_validate
Options: default_validate: validates agains zophs internal user database, htpasswd_validate: validates using htpasswd, php_validate: validates using PHP authentication
Example: $VALIDATOR = 'default_validate';

FORCE_SSL

FORCE_SSL Versions: 0.5 and later
Description: Force users to use https when using Zoph. ZOPH_SECURE_URL must be correctly defined when this is used.
Default: 0
Options: 0: Use http or 1: use https
Example: define('FORCE_SSL', 0);

FORCE_SSL_LOGIN

FORCE_SSL_LOGIN Versions: 0.5 and later
Description: Force users to use https when logging in to Zoph. After logging in, the user will be redirected to the http site. For this to work, both ZOPH_SECURE_URL and ZOPH_URL must be correctly defined.
Default: 0
Options: 0: Use http or 1: use https
Example: define('FORCE_SSL_LOGIN', 0);

Resized image generation

Zoph automatically creates thumbnails and medium sized ('mid') images during import. To influence this proces, you can edit the following parameters:

Important!

The options in this section have a matching setting in ZophImport.pl. These have to be set the same.

THUMB_SIZE

THUMB_SIZE Versions: All versions
Description: Maximum width or height of thumbnails
Default: 120
Options: Maximum width/height in pixels
Example: define('THUMB_SIZE', 120);

MID_SIZE

MID_SIZE Versions: All versions
Description: Maximum width or height of 'mid' sized images
Default: 480
Options: Maximum width/height in pixels
Example: define('THUMB_SIZE', 480);

THUMB_PREFIX

THUMB_PREFIX Versions: All versions
Description: Prefix of the filenames for the thumbnails.
Default: thumb
Options: Do not make this string empty!
Example: define('THUMB_PREFIX', 'thumb');

MID_PREFIX

MID_PREFIX Versions: All versions
Description: Prefix of the filenames for the 'mid' sized images.
Default: thumb
Options: Do not make this string empty!
Example: define('MID_PREFIX', 'mid');

MIXED_THUMBNAILS

MIXED_THUMBNAILS Versions: 0.3 and later
Description: Convert thumbnails to JPEGs. This setting should match what is in zophImporter.pl. If you are installing Zoph for the first time, it is recommend to set this to 0 and change zophImport.pl accordingly. If you are upgrading, see the Zoph/Upgrading#Zoph_0.2.1_-.3E_0.3_Upgrade for more information about this.
Default: 1
Options: 1: Behave like older Zoph versions. 0: Zoph will assume all thumbnails have the extension specified in THUMB_EXTENSION.
Example: define('MIXED_THUMBNAILS', '0');

THUMB_EXTENSION

THUMB_EXTENSION Versions: 0.3 and later
Description: Extension for thumbnail files
Default: JPG
Options: See . This setting is ignored if MIXED_THUMBNAILS is set to 1
Example: define('THUMB_EXTENSION', 'jpg');

Database configuration

Important!

The options in this section have a matching setting in ZophImport.pl. These have to be set the same.

DB_HOST

DB_HOST Versions: All versions
Description: Your database host
Default: localhost
Options: Any hostname or IP address
Example: define('DB_HOST', 'localhost');

DB_NAME

DB_NAME Versions: All versions
Description: Name of the database, as it was created during installation
Default: zoph
Options:
Example: define('DB_NAME', 'zoph');

DB_USER

DB_USER Versions: All versions
Description: Name of the user that is used to connect to the MySQL database
Default: zoph_rw
Options:
Example: define('DB_USER', 'zoph_rw');

DB_PASS

DB_PASS Versions: All versions
Description: MySQL password for the user defined with DB_USER.
Default: password
Options:
Example: define('DB_PASS', 'MySecretPassword');

Image location

IMAGE_DIR

IMAGE_DIR Versions: All versions
Description: Location of the images on the filesystem.
Default: /data/images/
Options: Any directory on the filesystem. Make sure it ends with a /!
Example: define('IMAGE_DIR', '/data/images/');

WEB_IMAGE_DIR

WEB_IMAGE_DIR Versions: All versions
Description: Location of the images relative to the webserver root.
Default: /data/images/
Options: This directory should point to the same location as IMAGE_DIR, but now seen from the webserver. Configure Apache so that this is correct. Make sure it ends with a /!
Example: define('WEB_IMAGE_DIR', '/images/');

USE_IMAGE_SERVICE

USE_IMAGE_SERVICE Versions: All versions
Description: This setting defines wheter photo's will be pulled directly from the filesystem by the webserver or to use image_service.php.
Default: 0
Options: 0: Take images from filesystem or 1: Use image_service.php.

The latter could be slightly lower in performance, but is highly recommended as it is more secure in combination with user access rights.

Example: define('IMAGE_SERVICE', '1');

Features

EMAIL_PHOTOS

EMAIL_PHOTOS Versions: All versions
Description: You can enable or disable the "mail this photo" feature" using this option.
Default: 0
Options: 0: disable mail, 1: enable mail
Example: define('EMAIL_PHOTOS', '1');

CLIENT_WEB_IMPORT

CLIENT_WEB_IMPORT Versions: 0.3.3. and later
Description: Use this option to enable or disable importing via the browser using a "browse" button to upload files from the client
Default: 1
Options: 0: disable, or 1: enable importing uploaded files
Example: define(CLIENT_WEB_IMPORT, '1');

SERVER_WEB_IMPORT

SERVER_WEB_IMPORT Versions: 0.3.3. and later
Description: Use this option to enable or disable importing via the browser using a file already stored on the server
Default: 0
Options: 0: disable, or 1: enable importing files stored on the server
Example: define(SERVER_WEB_IMPORT, '1');

WEB_IMPORT (depricated)

WEB_IMPORT (depricated) Versions: 0.3.2. and before
Description: Use this option to enable or disable importing via the browser
Default: 0
Options: 0: disable, or 1: enable importing files using the webinterface
Example: define('WEB_IMPORT', '1');

REMOVE_ARCHIVE

REMOVE_ARCHIVE Versions: 0.5 and later
Description: Remove the .tar or .zip file after a successful import.
Default: 0
Options: 0: leave the file, or 1: remove the file
Example: define('REMOVE_ARCHIVE, '0');

USE_DATED_DIRS

USE_DATED_DIRS Versions: 0.5 and later
Description: Put the files uploaded via the web import in dated directories, just like the --datedDirs option for zophImport.pl. For example, a photo taken on Dec 21, 2005, will be placed in a directory 2005.12.21, under your default path.
Default: 0
Options: 0: do not use dated dirs, or 1: use dated dirs.
Example: define('USE_DATED_DIRS', '0');

HIER_DATED_DIRS

HIER_DATED_DIRS Versions: 0.5 and later
Description: Put the files uploaded via the web import in hierarchical dated directories, just like the --hierarchical option for zophImport.pl. For example, a photo taken on Dec 21, 2005, will be placed in a directory tree 2005/12/21, under your default path.
Default: 0
Options: 0: do not use hierarchical dated dirs, or 1: use hierarchical dated dirs. This parameter will be ignored if USE_DATED_DIRS is not set.
Example: define('HIER_DATED_DIRS', '0');

WATERMARKING

WATERMARKING Versions: 0.5 and later
Description: Turn the watermarking feature on or off.
Default: 0
Options: 0: watermarking is disabled; 1: watermarking is enabled. Watermarking only works if IMAGE_SERVICE is enabled and WATERMARK is set to an existing GIF image. Please note that enabling this function uses a rather large amount of memory on the webserver. PHP by default allows a script to use a maximum of 8MB memory. You should probably increase this by changing memory_limit in php.ini. A rough estimation of how much memory it will use is 6 times the number of megapixels in your camera. For example, if you have a 5 megapixel camera, change the line in php.ini to memory_limit=30M
Example: define('WATERMARKING', '1');

WATERMARK

WATERMARK Versions: 0.5 and later
Description: If watermarking is used, this should be set to the name of the file that will be used as the watermark. It should be a GIF file, for best results, use contrasting colours and transparency. In the Contrib directory, 3 example files are included. The filename is relative to the IMAGE_DIR.
Default: watermark.gif
Options:
Example: define('WATERMARK', 'watermarks/topsecret.gif');