Interface configuration [edit]
ZOPH_TITLE [edit]
| 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 [edit]
| MAX_CRUMBS |
Versions: All versions |
| Description: The maximum number of breadcrumbs to allow |
| Default: 100 |
| Options: |
| Example: define('MAX_CRUMBS', 100); |
MAX_DAYS_PAST [edit]
| 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 [edit]
| 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 [edit]
| 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 [edit]
| MAX_PEOPLE_SLOTS |
Versions: 0.5 to 0.8.3 |
| 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. This option was removed in Zoph 0.8.4. As of that version a new dropdown box appears automatically after a person has been selected. |
| Example: define('MAX_PEOPLE_SLOTS', 5); |
DEFAULT_TABLE_WIDTH [edit]
| DEFAULT_TABLE_WIDTH |
Versions: All versions |
| Description: Defines the width of the Zoph interface. |
| Default: 600px |
| Options: A number in pixels ("px") or percent ("%"), the latter is a percentage of the user's browser window width. |
| Example: define('DEFAULT_TABLE_WIDTH', "600px"); |
CSS_SHEET [edit]
| CSS_SHEET |
Versions: 0.4 and later |
| Description: Defines the stylesheet Zoph is using. |
| Default: css.php |
| Options: The filename of any CSS file. May be .css or .php, but make sure you send the right header if you are using php to generate the CSS file. |
| Example: define('CSS_SHEET', "mycss.css"); |
ICONSET [edit]
| ICONSET |
Versions: 0.7.2/0.8 and later |
| Description: Defines the iconset Zoph is using. |
| Default: default |
| Options: The name of a directory under the images/icons directory containing icons for Zoph. |
| Example: define('ICONSET', "myicons"); |
LANG_DIR [edit]
| LANG_DIR |
Versions: All versions |
| Description: Defines the directory where the translation files are stored. This is a directory under the base directory. In a new installation you usually have to copy the lang directory into the php directory |
| Default: lang |
| Options: Any directory name. |
| Example: define('LANG_DIR', "lang"); |
DEFAULT_LANG [edit]
| DEFAULT_LANG |
Versions: 0.7.2/0.8 |
| Description: Defines the default language Zoph uses. This is a last resort, after the users preferences and the browser's indication have been checked. |
| Default: en |
| Options: Any language as defined in the language files in the directory defined with LANG_DIR. |
| Example: define('DEFAULT_LANG', "nl"); |
DEFAULT_ORDER [edit]
| DEFAULT_ORDER |
Versions: All versions |
| Description: Defines the default sort order Zoph uses to sort the photos on the thumbnail screen, it can be overided by the "order by" drop down on the top left of that screen. |
| Default: date |
| Options: date, time, timestamp, name, path, title, view, description, width, height, size, aperture, camera_make, camera_model, compression, exposure, flash_used, focal_length, iso_equiv, metering_mode |
| Example: define('DEFAULT_ORDER', "name"); |
DEFAULT_DIRECTION [edit]
| DEFAULT_DIRECTION |
Versions: All versions |
| Description: Defines the default sort order direction Zoph uses to sort the photos on the thumbnail screen, it can be overided by the black and white arrows next to the "order by" drop down on the top left of that screen. |
| Default: asc |
| Options: asc: ascending or desc: descending |
| Example: define('DEFAULT_DIRECTION', "desc"); |
Authentication [edit]
$VALIDATOR [edit]
| $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 [edit]
| 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 [edit]
| 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); |
Debugging [edit]
| DEBUG |
Versions: v0.8 and before |
| Description: The DEBUG option was used to control debug output given by Zoph during execution. As of Zoph 0.8.1 this option has been replaced by LOG_ALWAYS and LOG_SUBJECT, which allow more granular control over what is displayed and what not. |
| Default: 0 |
| Options: 0: no debugging. 1 and up, show debugging information. |
| Example: define('DEBUG', 5); |
An extensive explanation of Zoph's logging system can be found in Logging in Zoph 0.8.1 and later.
LOG_ALWAYS [edit]
| LOG_ALWAYS |
Versions: v0.8.1 and later |
| Description: This option controls how much debug information is showed. Zoph will show you the severity you configure and everything worse than that. So if you configure log::ERROR, you will see ERROR and FATAL messages and if you configure log::DEBUG, you will see all messages. |
| Default: log::FATAL |
| Options: See log severity below. |
| Example: define('LOG_ALWAYS', log::ERROR); |
LOG_SUBJECT [edit]
| LOG_SUBJECT |
Versions: v0.8.1 and later |
| Description: This option, together with LOG_SEVERITY enables you to have granular control over which messages are displayed. With LOG_SUBJECT you configure on which subject you would like to see logging. |
| Default: log::NONE |
| Options: See log subjects below. You can combine subjects with | (or) and ~ (not). |
| Example:
Display all messages which indicate an error or a fatal error, regarding the translation of Zoph or images:
define('LOG_SEVERITY', log::ERROR);
define('LOG_SUBJECT', log::LANG | log::IMG);
Display all messages, except debug-level messages, except those regarding SQL queries:
define('LOG_SEVERITY', log::NOTIFY);
define('LOG_SUBJECT', log::ALL | ~log::SQL);
Display all messages, except those regarding redirects or the database connection:
define('LOG_SEVERITY', log::DEBUG);
define('LOG_SUBJECT', log::ALL ~(log::REDIRECT | log::DB));
|
LOG_SEVERITY [edit]
| LOG_SEVERITY |
Versions: v0.8.1 and later |
| Description: This option, together with LOG_SUBJECT enables you to have granular control over which messages are displayed. With LOG_SEVERITY you configure how much debug information is showed. The difference with LOG_ALWAYS is, that the messages are only shown for the subject you have configured in LOG_SUBJECT. Zoph will show you the severity you configure and everything worse than that. So if you configure log::ERROR, you will see ERROR and FATAL messages and if you configure log::DEBUG, you will see all messages. |
| Default: log::NONE |
| Options: See log severity below. |
| Example: define('LOG_SEVERITY', log::NOTIFY); |
Log Severity [edit]
Severity indications
| log::DEBUG |
Debugging messages, Zoph gives information about what it's doing. |
| log::NOTIFY |
Notification about something that is happening which is influencing Zoph's program flow |
| log::WARN |
Warning about something that is happening |
| log::ERROR |
Error condition, something has gone wrong, but Zoph can recover |
| log::FATAL |
Fatal error, something has gone wrong and Zoph needs to stop execution of the current script. |
| log::NONE |
Do not display any messages |
Log subjects [edit]
Message subjects
| log::ALL |
All messages |
| log::VARS |
Messages regarding setting of variables |
| log::LANG |
Messages regarding the translation of Zoph |
| log::LOGIN |
Messages regarding the Login procedure |
| log::REDIRECT |
Messages regarding redirection |
| log::DB |
Messages regarding the database connection |
| log::SQL |
Messages regarding SQL Queries |
| log::XML |
Messages regarding XML creation |
| log::IMG |
Messages regarding image creation |
| log::IMPORT |
Messages regarding the import functions |
| log::GENERAL |
Other messages |
| log::NONE |
No messages. |
Resized image generation [edit]
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 [edit]
| 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 [edit]
| MID_SIZE |
Versions: All versions |
| Description: Maximum width or height of 'mid' sized images |
| Default: 480 |
| Options: Maximum width/height in pixels |
| Example: define('MID_SIZE', 480); |
THUMB_PREFIX [edit]
| 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 [edit]
| 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 [edit]
| 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 [edit]
| 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'); |
Rotating images [edit]
ALLOW_ROTATIONS [edit]
| ALLOW_ROTATIONS |
Versions: 0.4 and later |
| Description: Images can be rotated from the webinterface. This option determines whether this feature is available. |
| Default: 1 |
| Options: 1: Allow rotations, 0: Rotating from webinterface disabled |
| Example: define('ALLOW_ROTATIONS', 0); |
ROTATE_CMD [edit]
| ROTATE_CMD |
Versions: 0.4 and later |
| Description: Images can be rotated from the webinterface. This is done using an external (shell) command. This option determines which program is used |
| Default: convert |
| Options: convert: use ImageMagick's convert command to rotate images. WARNING: this is a lossy rotate function, jpegtran: use jpegtran from the Independant JPEG group to perform a lossless rotate. This only works for JPEG images. |
| Example: define('ROTATE_CMD', 'jpegtran'); |
BACKUP_ORIGINAL [edit]
| BACKUP_ORIGINAL |
Versions: 0.4 and later |
| Description: Images can be rotated from the webinterface. This option determines whether Zoph keeps a copy of the original file. The backup filename is prepended with BACKUP_PREFIX. |
| Default: 1 |
| Options: 1: Keep original. 0: Do not keep original. |
| Example: define('BACKUP_ORIGINAL', 0); |
BACKUP_PREFIX [edit]
| BACKUP_PREFIX |
Versions: 0.4 and later |
| Description: Images can be rotated from the webinterface. BACKUP_ORIGINAL determines whether Zoph keeps a copy of the original file. If it does, the backup filename is prepended with the prefix set in this option. |
| Default: 'orig_' |
| Options: Any (short) prefix string. It is recommended to end it with an underscore. |
| Example: define('BACKUP_PREFIX', 'backup_'); |
Database configuration [edit]
Before 0.8.2, the database settings were set in config.inc.php (for the web interface) and .zophrc (CLI interface), as of Zoph 0.8.2, these settings are all made in zoph.ini.
DB_HOST [edit]
| DB_HOST |
Versions: 0.8.1 and before |
| Description: Your database host |
| Default: localhost |
| Options: Any hostname or IP address |
| Example: define('DB_HOST', 'localhost'); |
DB_NAME [edit]
| DB_NAME |
Versions: 0.8.1 and before |
| Description: Name of the database, as it was created during installation |
| Default: zoph |
| Options: |
| Example: define('DB_NAME', 'zoph'); |
DB_USER [edit]
| DB_USER |
Versions: 0.8.1 and before |
| 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 [edit]
| DB_PASS |
Versions: 0.8.1 and before |
| Description: MySQL password for the user defined with DB_USER. |
| Default: password |
| Options: |
| Example: define('DB_PASS', 'MySecretPassword'); |
DB_PREFIX [edit]
| DB_PREFIX |
Versions: 0.4 to 0.8.1 |
| Description: Prefix for MySQL table names. This prefix is added before all the table names in the MySQL database. With this option you could make Zoph share a database with another application or have 2 Zoph installations share one database. |
| Default: 'zoph_' |
| Options: |
| Example: define('DB_PREFIX', ); |
Image location [edit]
IMAGE_DIR [edit]
| 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 [edit]
| WEB_IMAGE_DIR |
Versions: DEPRECATED as of v0.8.1. Will be removed in v0.9 |
| Description: This setting is only needed when USE_IMAGE_SERVICE. 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 [edit]
| USE_IMAGE_SERVICE |
Versions: DEPRECATED as of v0.8.1. Will be removed in v0.9 |
| Description: This setting defines wheter photo's will be pulled directly from the filesystem by the webserver or to use image_service.php. |
| Default: 1 (0 in v0.5.1 and earlier) |
| 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. Image service is required to be on if you wish to use watermarking or annotated photos. For this reason the option has been deprecated as of v0.8.1, and should always be on. In v0.9 this option will be removed and it will not be possible to use Zoph without the image service.
|
| Example: define('IMAGE_SERVICE', '1'); |
CLI settings [edit]
CLI_USER [edit]
| CLI_USER |
Versions: 0.8.2 and later |
| Description: This is the Zoph user that is used when using the CLI interface when interacting with Zoph. You should set it to the user_id of a valid Zoph user. This user must be an admin user. You can also set it to '0', which means Zoph will lookup the name of the Unix user starting the CLI client and tries to find that user's name in the Zoph database. |
| Default: 1 |
| Options: 0: lookup Unix user by name >0: lookup Zoph user by user id. |
| Example: define('CLI_USER', '0'); |
Import settings (0.8.2 and later) [edit]
IMPORT [edit]
| IMPORT |
Versions: 0.8.2 and later |
| Description: Use this option to enable or disable importing using the webbrowser. With this option on (1) an admin user, or a user with import rights, can import files placed in the IMPORT_DIR into Zoph. If you want users to be able to upload as well, you need to enable UPLOAD. As of v0.8.2, Zoph requires Javascript for uploading and importing, so you need to enable JAVASCRIPT. |
| Default: 1 |
| Options: 0: disable, or 1: enable importing. |
| Example: define('IMPORT', '1'); |
UPLOAD [edit]
| UPLOAD |
Versions: 0.8.2 and later |
| Description: Use this option to enable or disable uploading files. With this option on (1) an admin user, or a user with import rights, can upload files to the server running Zoph, they will be placed in the directory defined by IMPORT_DIR. This option requires IMPORT to be enabled. |
| Default: 1 |
| Options: 0: disable, or 1: enable uploaded files. |
| Example: define('UPLOAD', '1'); |
IMPORT_DIR [edit]
| IMPORT_DIR |
Versions: 0.8.2 and later |
| Description: Directory where uploaded files are stored and from where files are imported in Zoph. This is a directory under IMAGE_DIR. |
| Default: upload |
| Options: Any directory under IMAGE_DIR. If IMAGE_DIR is set to /data/images/ and IMPORT_DIR is set to upload, Zoph will upload photos to /data/images/upload |
| Example: define('IMPORT_DIR', 'upload'); |
IMPORT_PARALLEL [edit]
| IMPORT_PARALLEL |
Versions: 0.8.2 and later |
| Description: Photos will be resized to thumbnail and midsize images during import, this setting determines how many resize actions run in parallel. |
| Default: 1 |
| Options: Any number. Don't change this, unless you have a fast server with multiple CPU's or cores. |
| Example: define('IMPORT_PARALLEL', 2); |
MAGIC_FILE [edit]
| MAGIC_FILE |
Versions: 0.8.2 and later |
| Description: Zoph needs a MIME Magic file to be able to determine the filetype of an uploaded file. This is an important security measure, since it prevents users from uploading files other than images and archives. If left empty, PHP will use the built-in Magic file, if for some reason this does not work, you can specify the location of the MIME magic file. |
| Default: <empty> |
| Options: Empty, to use PHP's built-in MIME Magic file or the full path to a MIME Magic file. Where this file is located, depends on your distribution, /usr/share/misc/magic.mgc, /usr/share/misc/file/magic.mgc, /usr/share/file/magic are often used. |
| Example: define('MAGIC_FILE', '/usr/share/file/magic.mime'); |
TAR_CMD [edit]
| TAR_CMD |
Versions: All versions |
| Description: The command to use to untar .tar files. |
| Default: 0 |
| Options: 0: Disable TAR uploading. tar xvf: Will work on most systems, modify if your system requires another command |
| Example: define('TAR_CMD', 'tar xvf'); |
UNZIP_CMD [edit]
| UNZIP_CMD |
Versions: All versions |
| Description: The command to use to unzip .zip files. |
| Default: 0 |
| Options: 0: Disable ZIP uploading. unzip: Will work on most systems, modify if your system requires another command |
| Example: define('UNZIP_CMD', 'unzip'); |
UNGZ_CMD [edit]
| UNGZ_CMD |
Versions: 0.8.2 and later |
| Description: The command to use to unzip gzip files. |
| Default: 0 |
| Options: 0: Disable GZ uploading. ungzip: Will work on most systems, modify if your system requires another command |
| Example: define('UNGZ_CMD', 'ungzip'); |
UNBZ_CMD [edit]
| UNBZ_CMD |
Versions: 0.8.2 and later |
| Description: The command to use to unzip bzip files. |
| Default: 0 |
| Options: 0: Disable BZIP uploading. unzip: Will work on most systems, modify if your system requires another command |
| Example: define('UNZIP_CMD', 'unzip'); |
MAX_UPLOAD [edit]
| MAX_UPLOAD |
Versions: 0.6 and later |
| Description: Maximum size of uploaded file in bytes. Prior to v0.6. this was hardcoded to 10000000 bytes (10MB). Make sure you also change upload_max_filesize, post_max_size and possibly max_execution_time and max_input_time in php.ini |
| Default: 10000000 |
| Options: |
| Example: define('MAX_UPLOAD', '10000000'); |
USE_DATED_DIRS [edit]
| 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 [edit]
| 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'); |
DIR_MODE [edit]
| DIR_MODE |
Versions: All versions |
| Description: Specifies the file permissions that are assigned to directories created by Zoph. |
| Default: 0755 |
| Options: Any valid chmod-mode, keep in mind that a directory needs to be executable, in order to use it. Warning: Do not place quotes around the value, or you will get strange results! |
| Example: define('DIR_MODE', 0750); |
FILE_MODE [edit]
| FILE_MODE |
Versions: 0.8.2 and later |
| Description: Specifies the file permissions that are assigned to files created by Zoph. This replaces the IMPORT_UMASK setting |
| Default: 0644 |
| Options: Any valid chmod-mode, keep in mind that an image should not be executable, but that it should be readable by Zoph. Warning: Do not place quotes around the value, or you will get strange results! |
| Example: define('FILE_MODE', 0640); |
Import settings (0.8.1 and before) [edit]
WEB_IMPORT (deprecated) [edit]
| WEB_IMPORT (deprecated) |
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'); |
CLIENT_WEB_IMPORT [edit]
| CLIENT_WEB_IMPORT |
Versions: 0.3.3 until 0.8.1 |
| Description: Use this option to enable or disable importing via the browser using a "browse" buton to upload files from the client. As of v0.8.2 this has been replaced by UPLOAD. |
| Default: 1 |
| Options: 0: disable, or 1: enable importing uploaded files. |
| Example: define(CLIENT_WEB_IMPORT, '1'); |
SERVER_WEB_IMPORT [edit]
| SERVER_WEB_IMPORT |
Versions: 0.3.3 until 0.8.1 |
| Description: Use this option to enable or disable importing via the browser using a file already stored on the server. As of v0.8.2 this has been replaced by IMPORT. |
| Default: 0 |
| Options: 0: disable, or 1: enable importing files stored on the server. |
| Example: define('SERVER_WEB_IMPORT', '1'); |
WEB_IMPORT (deprecated) [edit]
| WEB_IMPORT (deprecated) |
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'); |
DEFAULT_DESTINATION_PATH [edit]
| DEFAULT_DESTINATION_PATH |
Versions: 0.4 until 0.8.1 |
| Description: Sets the default path to which photos are imported when using the webinterface, the path is relative to IMAGE_DIR. You can have Zoph automatically add today's date to the path by using date(format), where format is a format string like PHP's date() function, without quotes. Please note that this is the date the import is being done, not the the date the photo was taken, use USE_DATED_DIRS if you want that. As of Zoph 0.8.2, this option is no longer used, as all files are initially placed in IMPORT_DIR |
| Default: uploads/date(Y.m.d) |
| Options: |
| Example: define('DEFAULT_DESTINATION_PATH', 'date(Y-M)'); |
SHOW_DESTINATION_PATH [edit]
| SHOW_DESTINATION_PATH |
Versions: 0.4 until 0.8.1 |
| Description: This determines whether or not the value configured by DEFAULT_DESTINATION_PATH is visible/editable by a user. Please note that this is a usability feature and not a security feature, a user who has import rights can easily edit the value when changing the HTML file, then again, you shouldn't give untrustable users import rights.
This option is ignored for admin users, there it is always shown
|
| Default: 0 |
| Options: 0: do not show, or 1: show the destination path field |
| Example: define('SHOW_DESTINATION_PATH', '1'); |
REMOVE_ARCHIVE [edit]
| REMOVE_ARCHIVE |
Versions: 0.5 until 0.8.1 |
| Description: Remove the .tar or .zip file after a successful import. |
| Default: 0 |
| Options: 0: leave the file, or 1: remove the file. As of v0.8.2, Zoph always removes the archive on a succesful extract of that archive. |
| Example: define('REMOVE_ARCHIVE', '0'); |
IMPORT_MOVE [edit]
| IMPORT_MOVE |
Versions: 0.7.1 until 0.8.1 |
| Description: Move, instead of copy the image from the default import location to the final location. In this way no duplicate files will be around. As of v0.8.2 this option is removed. |
| Default: 0 |
| Options: 0: copy the file, or 1: move the file |
| Example: define('IMPORT_MOVE', '0'); |
IMPORT_UMASK [edit]
| IMPORT_UMASK |
Versions: 0.8.1 and before |
| Description: Specifies the file permissions that are assigned to files created by Zoph. This value is subtracted from the default chmod-file permissions of 666, so a umask of 022 means that the file permissions will become 644 (rw for owner, r for group and others) . This option has been replaced with FILE_MODE |
| Default: 022 |
| Options: Any value that can be subtracted from the default 666 mode, keep in mind that an image should not be executable, but that it should be readable by Zoph. |
| Example: define('IMPORT_UMASK', '026'); |
See also: TAR_CMD, UNZIP_CMD, USE_DATED_DIRS, HIER_DATED_DIRS, MAX_UPLOAD and DIR_MODE
Features [edit]
JAVASCRIPT [edit]
| JAVASCRIPT |
Versions: 0.7 and later |
| Description: Use this parameter to turn on or off all Javascript usage. This will disable all features that need Javascript. |
| Default: 1 |
| Options: 0: no Javascript, 1: use Javascript |
| Example: define('JAVASCRIPT', '1'); |
EMAIL_PHOTOS [edit]
| EMAIL_PHOTOS |
Versions: All versions |
| Description: You can enable or disable the "mail this photo" feature" using this option. Since Zoph needs to convert the photo into Base64 encoding for mail, it requires quite a large amount of memory if you try to send full size images and you may need to adjust memory_limit in php.ini, you should give it at least about 4 times the size of your largest image. |
| Default: 0 |
| Options: 0: disable mail, 1: enable mail |
| Example: define('EMAIL_PHOTOS', '1'); |
WATERMARKING [edit]
| 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 [edit]
| 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'); |
WM_POSX [edit]
| WM_POSX |
Versions: 0.7.1 and later |
| Description: Define where the watermark will be placed horizontally. |
| Default: center |
| Options: left, center or centre, right |
| Example: define('WM_POSX', 'right'); |
WM_POSY [edit]
| WM_POSY |
Versions: 0.7.1 and later |
| Description: Define where the watermark will be placed vertically. |
| Default: center |
| Options: top, center or centre, bottom |
| Example: define('WM_POSY', 'bottom'); |
WM_TRANS [edit]
| WM_TRANS |
Versions: 0.7.1 and later |
| Description: Define the transparency of a watermark. |
| Default: 50 |
| Options: 0: fully tranparent (invisible, don't use this, it's pointless and eats up a lot of resources, better turn off the watermark feature altogether) to 100: no transparency. |
| Example: define('WM_TRANS', 25); |
| ALLOW_COMMENTS |
Versions: 0.6 and later |
| Description: Enable comments. Before a user can actually leave comments, you should also give the user these rights through the edit user screen. |
| Default: 0 |
| Options: 0: disable comments 1: enable comments |
| Example: define('ALLOW_COMMENTS', 1); |
AUTOCOMPLETE [edit]
| AUTOCOMPLETE |
Versions: 0.7 and later |
| Description: With this feature you can use "Web 2.0" autocompletion for select-boxes (Albums, Categories, Places, People) |
| Default: 1 |
| Options: 0: use standard HTML select-boxes; 1: Use autocompletion select-boxes. This feature needs JAVASCRIPT to be enabled. |
| Example: define('AUTOCOMPLETE', 1); |
DOWNLOAD [edit]
| DOWNLOAD |
Versions: 0.7.1 and later |
| Description: With this feature you can use download a set of photos (Albums, Categories, Places, People or a search result) in one or more ZIP files. Important the photos in the ZIP file will not be watermarked. |
| Default: 0 |
| Options: 0: disable this feature; 1: Enable this feature. You must also grant each non-admin user you want to give these rights permission by changing "can download zipfiles" in the user's profile. |
| Example: define('DOWNLOAD', 1); |
Mapping Support [edit]
| MAPS |
Versions: 0.7.3 and later |
| Description: With this setting you can enable mapping support for Zoph. Mapping is provided through the use of the Mapstraction abstraction layer, which enables support for many different mapping providers. You will need to enable Javascript throught the JAVASCRIPT setting. |
| Default: |
Options:
- empty: disable this feature;
- google: Use Google Maps, you need to define GOOGLE_KEY in order to be able to use Google Maps.,
- yahoo: use Yahoo mapping or
- openstreetmap: use openstreetmap maps. Because this setting displays OpenStreetMap map tiles via the Google javascript API, you will also need to define GOOGLE_KEY.
It should be possible to use the other mapping providers or javascript map libraries Mapstraction supports, but they have not been tested with Zoph and are therefore not supported.
|
| Example: define('MAPS', 'google'); |
GOOGLE_KEY [edit]
| GOOGLE_KEY |
Versions: 0.7.3 and later |
| Description: In order to use Googles Mapping API, you will need to request an API key with Google. You can do this at http://code.google.com/apis/maps, you will need to provide the URL to your Zoph installation, mapping will generate an error when the URL is wrong. |
| Default: 'Get yours at http://code.google.com/apis/maps' |
| Options: An API key provided by Google. It will look something like this the one in the example, which is an invalid key, don't bother trying to use it. |
| Example: define('GOOGLE_KEY', 'DDQIBBBBhW0vWZf8f0AAPt_86WXJrGGG9jpr3jOoJTHbWArKj23UyhEyLxRRtnOiOR-RSvuLRF1bguT8Nkh2jQ'); |
Timezone [edit]
The following features are only available if your are running PHP 5.1.0 or later and are automatically disabled if you are not.
CAMERA_TZ [edit]
| CAMERA_TZ |
Versions: 0.7.3 and later |
| Description: This setting determines the timezone to which your camera is set. Leave empty if you do not want to use this feature and always set your camera to the local timezone |
| Default: |
| Options: Any timezone from this list http://www.php.net/manual/en/timezones.php |
| Example: define('CAMERA_TZ', 'Europe/Amsterdam'); |
DATE_FORMAT [edit]
TIME_FORMAT [edit]
GUESS_TZ [edit]
| GUESS_TZ |
Versions: 0.7.3 and later |
| Description: If you have defined the precise location of a place (using the mapping feature), Zoph can 'guess' the timezone based on this location. It uses the Geonames project for this. This will, however, send information to their webserver, do not enable this feature if you're not comfortable with that. |
| Default: 0 |
| Options: 0: disable this feature, 1: enable this feature |
| Example: define('GUESS_TZ', 1); |
| SHARE |
Versions: 0.8.4 and later |
| Description: Sometimes, you may wish to share an image in Zoph without creating a user account for those who will be watching them. For example, in order to post a link to an image on a forum or website. When this option is enabled, you will see a 'share' tab next to a photo, where you will find a few ways to share a photo, such as a url and a HTML <img> tag. With this special url, it is possible to open a photo without logging in to Zoph. You can determine per user whether or not this user will see the tab and therefore the urls. If you use this function, you should set SHARE_SALT_FULL and SHARE_SALT_MID to different, long and secret values. |
| Default: 0 |
| Options: 0: disable this feature, 1: enable this feature |
| Example: define('SHARE', 1); |
SHARE_SALT_FULL [edit]
| SHARE_SALT_FULL |
Versions: 0.8.4 and later |
| Description: When using the SHARE feature, Zoph uses a hash to identify a photo. Because you do not want people who have access to you full size photos (via Zoph or otherwise) to be able to generate these hashes, you should give Zoph a secret salt so only authorized users of your Zoph installation can generate them. The salt for full size images (this one) must be different from the salt of mid size images (SHARE_SALT_MID), because this allows Zoph to distinguish between them. If a link to your Zoph installation is being abused (for example because someone whom you mailed a link has published it on a forum), you can modify the salt to make all hash-based links to your Zoph invalid. |
| Default: 'Set this to a long secret string' |
| Options: Any string. Longer is better. Should be 10 characters at the very least. You will only need to store it here and there is no need to remember it, so there really is no excuse for using a short, easy salt. |
| Example: define('SHARE_SALT_FULL', '25fa82997b2ca1b13219dd7199cfe5e1539c41c5'); |
SHARE_SALT_MID [edit]
| SHARE_SALT_MID |
Versions: 0.8.4 and later |
| Description: When using the SHARE feature, Zoph uses a hash to identify a photo. Because you do not want people who have access to you full size photos (via Zoph or otherwise) to be able to generate these hashes, you should give Zoph a secret salt so only authorized users of your Zoph installation can generate them. The salt for mid size images (this one) must be different from the salt of full size images (SHARE_SALT_FULL), because this allows Zoph to distinguish between them. If a link to your Zoph installation is being abused (for example because someone whom you mailed a link has published it on a forum), you can modify the salt to make all hash-based links to your Zoph invalid. |
| Default: 'Set this to a long, different secret string' |
| Options: Any string. Longer is better. Should be 10 characters at the very least. You will only need to store it here and there is no need to remember it, so there really is no excuse for using a short, easy salt. |
| Example: define('SHARE_SALT_FULL', '71baba5ad35e7f25e5dw1a65422121149a959e7c'); |