PSP Help Doc Indexer System

1. Introduction
2. License
3. History
4. Compilation & Hosting
5. Configuration File
6. Modules:
   1. Base64Enc
   2. FileShare
   3. GZIP
   4. Hostname
   5. HTTP
   6. MD5Crypt
   7. RegExp
   8. SDS
   9. SMTP
   10. Substrings
   11. URLEnc
   12. Web
7. FAQ
8. Links
9. Credits

Configuring PSP applications

1. In current directory
2. In parent directory
3. In system directory. On Windows it is Windows directory, on UNIX it is /etc folder.

The PSP Configuration File Layout:

General Notes:

The config parser ignores empty lines and lines that begin with '#'. Configuration variables are defined as name=value pairs, where spaces between 'name', '=' and 'value' are ignored. If a value contains spaces it must be quoted like this:

config_name = "value with spaces"

Please make sure this file is accessible from your PSP applications. PSP looks for it in current program directory, then in parent directory and then in system-wide path. On Windows it is your Windows directory, on UNIX-like systems it is /etc directory.

Headers

Some default headers configuration.

header_charset

Example:

header_charset = iso-8859-1

Output

This section configures program output.

error_reporting

This option configures error reporting option. Error reporting outputs error message when some problem is encountered. It is recommended to keep it on for your program to be more verbose but you can switch it off when you're sure that everything is clear and you don't want users to see those messages on your site.

Example:

error_reporting = on

error_halt

This option defines whether program should be halted just after some problem occurred.

Example:

error_halt = off

output_buffering

Output buffering allows you to modify both header and body parts of your program output any time you wish. GZIP output compression also can be used only if output buffering is on. But it slows down your programs a bit.

Example:

output_buffering = on

output_compression

GZIP output compression saves bandwidth but slows down your program. It will work only output_buffering is enabled.

Example:

output_compression = on

format_auto_filter

Automatically replaces all HTML-specific characters with HTML macros, protects from Cross Site Scripting in user variables while formatting strings and templates

Example:

format_auto_filter = on

Sessions

This section controls session behavior.

session_path

Sessions are stored in single SDS table. You must specify full path for your session table here. The file will be created automatically, you just have to ensure that it: 1) can be created, 2) can be read, 3) can be written - by your PSP apps. Otherwise PSP will attempt to create it in your system temp directory (%WINDIR%\Temp\pspsess.sds on Windows and /tmp/pspsess.sds on UNIX).

Example:

session_path = "c:\temp\sessions\pspsess.sds"

session_life_time

Here you should specify maximal session life time. On each operation session time is updated. But when session idleness exceeds this limit, session is removed by garbage collector. Time is specified in minutes.

Example:

session_life_time = 10

Uploads

This section sets incoming data parameters.

upload_max_size

This parameter specifies the sum size of data (i.e. uploaded files and form fields) program will receive with POST method. Size is specified in megabytes

Example:

upload_max_size = 20