Pawtucket Global Configuration

From CollectiveAccess Documentation
Jump to: navigation, search

The global.conf configuration file

This configuration file is specific to the Pawtucket public web front-end application. It contains settings to configure Pawtucket to function within your web server environment and connect to your database and mail server. For information on the syntax of CA configuration files see Configuration File Syntax, the section titled Substituting values is especially useful to review as this technique is widely employed when defining file paths in app.conf.

Directives

Application identification

app_name This is a short name alphanumeric-only (no spaces or punctuation) name for this CollectiveAccess instance. It should be unique to this instance; if you are running more than one instance of CollectiveAccess on the same server make sure each instance has its own app_name.

The app_name is used to name the session cookie CollectiveAccess issues to users upon login. If you use characters not allowed in cookie names (spaces for instance) you will almost certainly run into problems with logins and session management. Be sure to keep your app_name to letters, numbers and underscores only.



General

app_display_name Name displayed on login screen
window_title Title to put in all windows
locale_defaults List of default locale codes ** THESE MUST EXIST IN THE ca_locales TABLE **
queue_enabled set to non-zero value if you want large media to be queued for background processing if you set it to zero then no queuing will occur, no matter what the threshold is in your media_processing.conf file



Paths & URLs

These are imported from setup.php; you should not have to change them.
ca_base_dir Complete server file path to the main Pawtucket directory
ca_conf_dir Complete server file path to Pawtucket config directory
ca_app_dir Complete server file path to Pawtucket app directory
ca_lib_dir Complete server file path to Pawtucket lib directory
ca_models_dir Complete server file path to directory containing Pawtucket database models

You MUST change these next three entries to match your web setup.
site_protocol For example: http or https
site_hostname Hostname of site, for example: www.google.com
site_host Complete url of site, for example: http://www.google.com

ca_web_root_dir The path to the web server root, omit trailing slashes.
For example: If CollectiveAccess is in /path/to/webserver/root/apps/ca then the 'ca_web_root_dir' would be /path/to/webserver/root
ca_url_root Leave 'ca_url_root' BLANK if the CollectiveAccess directory is the web server root. If CollectiveAccess is in a subdirectory set 'ca_url_root' to the root relative url path to the subdirectory; start the path with a slash ('/') but omit trailing slashes
For example: If CollectiveAccess is in /path/to/webserver/root/apps/ca then the 'ca_url_root' would be /apps/ca
ca_media_url_root By convention all media is stored in a subdirectory named with the app_name located within in a directory called 'media' that is in turn located in the CollectionAccess directory. You should not have to change this.



Database Login

You MUST change these to match your setup

db_host If your MySQL database runs on the same machine as the web server leave this as "localhost"
db_user Database login user name
db_password Database login password
db_database CollectiveAccess database name
db_type Leave this set to 'mysql'



Google maps support

google_api version of Google API (2 or 3)
google_map_key Google API key (for use with version 2; version 3 doesn't require a key)
NOTE: You will have to register with Google at http://code.google.com/apis/maps/ for each hostname you wish to use, otherwise mapping will throw an error.



Email

smtp_server SMTP server to use for outgoing email notifications. If your server isn't running a mail server locally, the default smtp_server value will have to be changed
smtp_auth If your SMTP server requires you to authenticate then you need to set this value. Otherwise it can be omitted.
smtp_username SMTP server username. If your SMTP server requires you to authenticate then you need to set this value. Otherwise it can be omitted.
smtp_password SMTP server password. If your SMTP server requires you to authenticate then you need to set this value. Otherwise it can be omitted.
ca_admin_email Generic site admin email
password_email_from From: address for password reset emails

sphinx

Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools