Procedural File: conf.dist.php

Source Location: /conf.dist.php

Page Details:

HRDI Observational Database configuration file.

This file contains the configuration options used for the HRDI Observational Database. All configurable elements can be changed by editing this file. The look and feel of the UI should be changed by editing the CSS file. This file should be copied to 'conf.php' and then edited for the given setup. The code reads 'conf.php', while the documentation parser reads 'conf.dist.php'.

Tags:

filesource:

Source Code for this file

string $archive_prefix [line 113]

Archive prefix.

The prefix where compressed archives will be kept, available for download. This location will be periodically cleaned, but it should be capable of storing large amounts of data. It should also be writeable by the Apache user and/or group.

Default value:

"/var/www/downloads"

[ Top ]

bool $check_dns [line 142]

User e-mail domain checking.

When a user enters an e-mail to register, the domain of the e-mail can be checked by doing a DNS lookup. This is a nice way to ensure that the e-mail address at least has a chance of being real. It should not cause any problems as long as the DNS servers are working.

Default value:

TRUE

[ Top ]

integer $csv_line_character_limit [line 201]

CSV single line character limit.

This integer specifies the largest possible character length to be expected in a single line of a CSV file.

Default value:

10000

[ Top ]

string $day1_ts [line 55]

UARS Day 1 time stamp.

The Unix time stamp of UARS Day 1 (September 12th, 1991)

Default value:

"684648000"

[ Top ]

string $download_prefix [line 132]

Archive download prefix.

The prefix where the compressed archives will be visible to the users. This should be a symbolic link or an Apache alias pointing to the archive prefix specified in $archive_prefix.

Default value:

"/downloads"

[ Top ]

string $dsn [line 48]

Data source name.

The data source name is used by PEAR to connect to the database.

Default value:

"mysqlmysql://$username:$password@$server/$database"

[ Top ]

string $hrdi_admin [line 63]

HRDI admin e-mail.

The e-mail address of the HRDI admin who should be contacted in case of problems.

Default value:

"user@domain.edu"

[ Top ]

string $mail_from [line 78]

'From' mail address.

This e-mail address user in The 'From' address of the password reset e-mail.

Default value:

$hrdi_admin

[ Top ]

string $mail_message [line 94]

E-mail message.

This is the plain text used in the 'Body' of the e-mail message. The (case sensitive) text RANDOM_PASS will be replaced with the actual randomly generated password.

Default value:

"This is your new password: RANDOM_PASS"

[ Top ]

string $mail_subject [line 85]

E-mail subject.

The string used in the 'Subject' of the password reset e-mail.

Default value:

"Some subject"

[ Top ]

integer $max_archive_size [line 103]

Archive size.

The desired maximum size of downloadable archives in megabytes. This size should be at minimum as large as the sum of all the average sizes of the files that can be attached to a single day.

Default value:

[ Top ]

string $offline_prefix [line 151]

Offline file prefix.

The prefix where offline day and week pages will be created. This directory only needs to be writeable by the user and/or group running the offline page generation script.

Default value:

"offline"

[ Top ]

integer $pass_length [line 71]

Random password length.

The desired length of the randomly generated password which is sent to users who reset their password.

Default value:

[ Top ]

array $table_keys [line 185]

Table keys.

This array associates primary keys with HRDI tables. When an entry is being processed by the CSV parser, it is looked up by the table key. If the key exits, an update is performed. If the key does not exist, an insert is performed.

Default value:

array("HRDI_Days"  => "UARS_Day",
                    "HRDI_Downloads" => "ID",
                    "HRDI_FileTypes" => "ID",
                    "HRDI_Files" => "Filename",
                    "HRDI_History" => "ID",
                    "HRDI_Links" => "ID",
                    "HRDI_Modes" => "ID",
                    "HRDI_Pids"  => "Pid",
                    "HRDI_Users" => "ID")

[ Top ]

string $temp_prefix [line 123]

Temporary archive prefix.

The prefix where the archives are kept while being created. Once they are done being created, the files will be moved to $archive_prefix. This location should be capable of storing large amounts of data. It should also be writeable by the Apache user and/or group.

Default value:

"/tmp"

[ Top ]

Documentation generated on Tue, 23 Jan 2007 22:57:43 -0500 by phpDocumentor 1.3.0RC6