Your browser must have JavaScript enabled in order to view this page.
 >  >
 
Welcome Guest#1748 Login/register    Go to Bottom
Go to Top

Procedural File: dpserver-ini.php

SOURCE LOCATION:  /config/dpserver-ini.php

File Overview

Constants with global server settings

Change these constants to match your desired configuration. These constants define the settings and behavious of dpserver.php and dpclient.php, that is, the communication between the DutchPIPE server and the user's browser. See dpuniverse-ini.php for settings dealing with the "universe".

DutchPIPE version 0.4; PHP version 5

LICENSE: This source file is subject to version 1.0 of the DutchPIPE license. If you did not receive a copy of the DutchPIPE license, you can obtain one at http://dutchpipe.org/license/1_0.txt or by sending a note to license@dutchpipe.org, in which case you will be mailed a copy immediately.


SEE:  dpserver.php, dpclient.php, dpuniverse-ini.php
FILESOURCE:  Source Code for this file
LINK:  http://dutchpipe.org/manual/package/DutchPIPE
VERSION:  Subversion: $Id: dpserver-ini.php 308 2007-09-02 19:18:58Z ls $
COPYRIGHT:  2006, 2007 Lennert Stock
LICENSE:  DutchPIPE License
AUTHOR:  Lennert Stock <ls@dutchpipe.org>

Constants

DPSERVER_APACHE_GZIP_MIN  [line 491]
DPSERVER_APACHE_GZIP_MIN = FALSE

Apache minimal deflate/gzip size

If you are using Apache's mod_deflate (or mod_gzip), even small Ajax requests are compressed, which is not effective. You can set a minimal size in bytes here the content of the request should have (200 is a good size). The DutchPIPE client will use the following PHP function call for small requests: apache_setenv('no-gzip', '1'); Set to FALSE if you're not running Apache with output compression or if you don't want to use this feature.

DPSERVER_BASE64_CLIENT2SERVER  [line 437]
DPSERVER_BASE64_CLIENT2SERVER = TRUE

Use base64_encode/decode on dpclient -> dpserver communication?

If you are getting "unserialize" errors, set to TRUE. This has a small speed penalty.


DPSERVER_BASE64_SERVER2CLIENT  [line 446]
DPSERVER_BASE64_SERVER2CLIENT = TRUE

Use base64_encode/decode on dpserver -> dpclient communication?

This has a small speed penalty.


DPSERVER_CLIENTJS_URL  [line 73]
DPSERVER_CLIENTJS_URL = DPSERVER_CLIENT_DIR.'dpclient-js.php'

The rest of the URL for the client Javascript, /dpclient-js.php by default

DPSERVER_CLIENT_CHUNK  [line 456]
DPSERVER_CLIENT_CHUNK = 2048

Maximum number of bytes dpclient.php can read from dpserver.php per chunk

You should probably leave this untouched.


DPSERVER_CLIENT_DIR  [line 46]
DPSERVER_CLIENT_DIR = '/'

The rest of the URL for the directory to to the client PHP script, / by default

DPSERVER_CLIENT_FILENAME  [line 55]
DPSERVER_CLIENT_FILENAME = 'dpclient.php'

The rest of the URL for the client PHP script, dpclient.php by default

DPSERVER_CLIENT_URL  [line 64]
DPSERVER_CLIENT_URL = DPSERVER_CLIENT_DIR.DPSERVER_CLIENT_FILENAME

The rest of the URL for the client PHP script, /dpclient.php by default

DPSERVER_COOKIE_NAME  [line 78]
DPSERVER_COOKIE_NAME = 'dutchpipe'

The name of the cookie DutchPIPE uses to store user information
DPSERVER_DEBUG_TYPE  [line 427]
DPSERVER_DEBUG_TYPE = DPSERVER_DEBUG_TYPE_NONE

Debug information settings

What kind of debug information should the server echo to the CLI/shell when running? The DPSERVER_DEBUG_TYPE must be one of:


DPSERVER_DEBUG_TYPE_GETRUSAGE  [line 408]
DPSERVER_DEBUG_TYPE_GETRUSAGE = 3

Debug information modifier - show info based on *nix getrusage

*NIX only, doesn't work under Windows. Used by DPSERVER_DEBUG_TYPE. Don't change this.


DPSERVER_DEBUG_TYPE_MEMORY_GET_USAGE  [line 397]
DPSERVER_DEBUG_TYPE_MEMORY_GET_USAGE = 2

Debug information modifier - show info line with memory and object counters

*NIX only, doesn't work under Windows. Used by DPSERVER_DEBUG_TYPE. Don't change this.


DPSERVER_DEBUG_TYPE_NONE  [line 386]
DPSERVER_DEBUG_TYPE_NONE = 1

Debug information modifier - don't show debug information

Used by DPSERVER_DEBUG_TYPE. Don't change this.


DPSERVER_DPSERVERCLASS_PATH  [line 197]
DPSERVER_DPSERVERCLASS_PATH = DPSERVER_LIB_PATH.'dpserver.php'

Path to the file with the DutchPIPE Server class

Leave this untouched if the DutchPIPE directory structure wasn't changed.

DPSERVER_DPUNIVERSECLASS_PATH  [line 204]
DPSERVER_DPUNIVERSECLASS_PATH = DPSERVER_LIB_PATH.'dpuniverse.php'

Path to the file with the DutchPIPE Universe class

Leave this untouched if the DutchPIPE directory structure wasn't changed.

DPSERVER_DPUNIVERSE_CONFIG_PATH  [line 183]
DPSERVER_DPUNIVERSE_CONFIG_PATH = DPSERVER_ROOT_PATH.'config/'

Path to the directory with server and universe settings

Leave this untouched if the DutchPIPE directory structure wasn't changed.

DPSERVER_DPUNIVERSE_PATH  [line 176]
DPSERVER_DPUNIVERSE_PATH = DPSERVER_ROOT_PATH.'dpuniverse/'

Path to the root of the DutchPIPE universe

Leave this untouched if the DutchPIPE directory structure wasn't changed.

DPSERVER_ENABLE_MBSTRING  [line 331]
DPSERVER_ENABLE_MBSTRING = TRUE

Multibyte string handling enabled?

Enables your site to handle all UTF-8 chars, so people can communicate for example in East Asian languages. PHP must have the multibyte extension enabled if set to TRUE, otherwise this setting is ignored. Set to FALSE to disable.

See also: http://www.php.net/manual/en/ref.mbstring.php


DPSERVER_ERROR_REPORTING  [line 376]
DPSERVER_ERROR_REPORTING = E_ALL|E_STRICT

Error reporting level

Which PHP errors to report, according to http://www.php.net/manual/en/ref.errorfunc.php#errorfunc.constants

By default all messages including "strict" messages are shown.


DPSERVER_GETTEXT_DOMAIN  [line 282]
DPSERVER_GETTEXT_DOMAIN = 'messages'

Name of translation table (the "domain" in GNU gettext jargon)

Used when gettext is enabled.


DPSERVER_GETTEXT_ENABLED  [line 260]
DPSERVER_GETTEXT_ENABLED = FALSE

Enable internationalization/localization support with dynamic gettext?

This has a speed penalty. Set to TRUE to enable or FALSE to disable.

Different languages are supported using GNU gettext, see http://www.php.net/gettext. Because PHP is an interpreted language, gettext slows things down as calls are dynamic (although it's quite fast). There are some tools around to make static PHP translations, but this has not been explored yet. Also, it is not yet possible to have multiple users use different languages on one site. It's in one language.

Currently, standard English ("en") and Dutch ("nl_NL") are part of the standard distribution. Also, all texts to translate are in only one file called messages.po (this will change in the future).

If you'd like to translate for DutchPIPE, base your translation on locale/en/LC_MESSAGES/messages.po and please mail your results to contributors@dutchpipe.org. As I did with the Dutch translation, you'll probably run into a couple of problems getting it exactly right, because of presumptions made by the English language system. Please let us know so this can be fixed.


DPSERVER_GETTEXT_ENCODING  [line 294]
DPSERVER_GETTEXT_ENCODING = 'UTF-8'

Gettext character encoding

Used when gettext is enabled. DutchPIPE uses UTF-8 but I'm not sure how this works for other languages


DPSERVER_GETTEXT_LOCALE_PATH  [line 271]
DPSERVER_GETTEXT_LOCALE_PATH = DPSERVER_ROOT_PATH.'locale/'

Path to the directory with translations

Used when gettext is enabled.


DPSERVER_HOST_URL  [line 36]
DPSERVER_HOST_URL = 'http://www.yourdomain.com'

Host on which DutchPIPE is running

The URL part minus the absolute path to dpclient.php (/dpclient.php by default, as defined in DPSERVER_CLIENT_URL).


DPSERVER_LIB_PATH  [line 190]
DPSERVER_LIB_PATH = DPSERVER_ROOT_PATH.'lib/'

Path to the library directory

Leave this untouched if the DutchPIPE directory structure wasn't changed.

DPSERVER_LOCALE  [line 313]
DPSERVER_LOCALE = '0'

Used when gettext is enabled, defines a "locale" supported by DutchPIPE

Different systems have different naming schemes for locales, see http://www.php.net/setlocale.

Use the '0' string to leave the locale settings untouched and use the default language (English in the standard distribution of DutchPIPE).

To use one of the translations included in the standard DutchPIPE distribution, outcomment the first define which sets DPSERVER_LOCALE to '0', and remove comment characters from the language in the list below.


DPSERVER_LOCALE_FULL  [line 340]
DPSERVER_LOCALE_FULL = DPSERVER_LOCALE=='0'?'0':DPSERVER_LOCALE.'.'.DPSERVER_GETTEXT_ENCODING

You probably don't need to touch this

DPSERVER_MAXUPTIME  [line 353]
DPSERVER_MAXUPTIME = 0

The maximum number of seconds the server can stay up, 0 for no limit
DPSERVER_MAX_SOCKET_BACKLOG  [line 161]
DPSERVER_MAX_SOCKET_BACKLOG = 5

The maximum of backlog incoming connections queued for processing

Used by socket_listen in dpserver.php. See http://www.php.net/socket_listen for more information.

You should probably leave this untouched.


DPSERVER_MEMORY_LIMIT  [line 478]
DPSERVER_MEMORY_LIMIT = '32M'

Maximum memory usage

Memory limit in bytes that the server may allocate. Use -1 for unlimited. When an integer is used, the value is measured in bytes. You may also use shorthand notation as described in this FAQ: http://www.php.net/manual/en/faq.using.php#faq.using.shorthandbytes

See also: http://www.php.net/manual/en/ini.core.php#ini.memory-limit

DPSERVER_OBJECT_IMAGE_CUSTOM_MAX_BROWSETIME  [line 531]
DPSERVER_OBJECT_IMAGE_CUSTOM_MAX_BROWSETIME = 60

Maximum time in seconds the user can browse for a file during AJAX upload

Browsing causes scripts to halt in a browser, and we don't want to throw people out. This should be a bigger number than DPUNIVERSE_LINKDEATH_KICKTIME.


DPSERVER_OBJECT_IMAGE_CUSTOM_MAX_SIZE  [line 520]
DPSERVER_OBJECT_IMAGE_CUSTOM_MAX_SIZE = 1048576

Maximum size in bytes of custom image uploads for avatars and other images

SEE:  DPSERVERE_OBJECT_IMAGE_VALID_TYPES
DPSERVER_OBJECT_IMAGE_MAX_HEIGHT  [line 506]
DPSERVER_OBJECT_IMAGE_MAX_HEIGHT = 100

Maximum height of object images in pixels

DPSERVER_OBJECT_IMAGE_MAX_WIDTH  [line 499]
DPSERVER_OBJECT_IMAGE_MAX_WIDTH = 95

Maximum width of object images in pixels

DPSERVER_OBJECT_IMAGE_VALID_TYPES  [line 513]
DPSERVER_OBJECT_IMAGE_VALID_TYPES = 'gif,jpg,png'

Comma separated list of file extensions allowed for custom avatars and images

DPSERVER_ROOT_PATH  [line 169]
DPSERVER_ROOT_PATH = realpath(dirname(__FILE__).'/..').'/'

Path to the root of the DutchPIPE installation

Defaults to the mother directory of the directory this file is in. Leave this untouched if the DutchPIPE directory structure wasn't changed.

DPSERVER_SERVER_CHUNK  [line 466]
DPSERVER_SERVER_CHUNK = 2048

Maximum number of bytes dpserver.php can read from dpclient.php per chunk

You should probably leave this untouched.


DPSERVER_SOCKERR_MSG  [line 364]
DPSERVER_SOCKERR_MSG = dp_text('The DutchPIPE server is down')

The message shown in case of a socket error

This usually means the server is down.


DPSERVER_SOCKET_ADDRESS  [line 127]
DPSERVER_SOCKET_ADDRESS = '127.0.0.1'

IP address for AF_INET type

If you run DutchPIPE on Windows, this value will always be used in combination with DPSERVER_SOCKET_PORT. The DutchPIPE server will run on your machine using the address and port number provided.


DPSERVER_SOCKET_PATH  [line 114]
DPSERVER_SOCKET_PATH = '/tmp/dutchpipe.sock'

Path to the file used for socket connections

This file socket is used beween dpserver.php and dpclient.php for AF_UNIX type. Reads and writes to this open file to communicate.


DPSERVER_SOCKET_PORT  [line 141]
DPSERVER_SOCKET_PORT = '3333'

Port number for AF_INET type

If you run DutchPIPE on Windows, this value will always be used in combination with DPSERVER_SOCKET_ADDRESS. The DutchPIPE server will run on your machine using the address and port number provided. You should check if the port number is not in use by another application.


DPSERVER_SOCKET_TYPE  [line 101]
DPSERVER_SOCKET_TYPE = AF_INET

Type of socket dpserver.php and dpclient.php use to communicate

See http://www.php.net/socket_create for more information. For *NIX, use AF_UNIX, for Windows, use AF_INET. AF_UNIX is a file based socket, AF_INET uses a local connection (can be remote but that is untested). AF_UNIX is much faster but isn't supported on Windows.


DPSERVER_TEMPLATE_DOWN_FILE  [line 231]
DPSERVER_TEMPLATE_DOWN_FILE = 'dpdown.tpl'

Filename of the template in the DPSERVER_TEMPLATE_PATH directory used when the DutchPIPE server is down.

DPSERVER_TEMPLATE_FILE  [line 222]
DPSERVER_TEMPLATE_FILE = 'dpdefault.tpl'

Filename of the default template in the DPSERVER_TEMPLATE_PATH directory

DPSERVER_TEMPLATE_PATH  [line 213]
DPSERVER_TEMPLATE_PATH = DPSERVER_ROOT_PATH.'template/'

Path to the directory with HTML templates

Leave this untouched if the DutchPIPE directory structure wasn't changed.


DPSERVER_TIMEZONE  [line 86]
DPSERVER_TIMEZONE = 'Europe/Amsterdam'

The timezone for the DutchPIPE site

Use an identifier as definied by http://www.php.net/manual/en/timezones.php.


Documentation generated on Mon, 03 Sep 2007 22:20:34 +0200 by phpDocumentor 1.3.0RC6

Click me!
Guest#1748
 
 
 
  Go to Top
 
 
Input Field OptionsClose Input Field Go to Top
 
Legal Notices | Copyright © 2006, 2007 Lennert Stock. All rights reserved. Last update: Mon Sep 03 2007, 21:50 CET.