Pawtucket2:Configuration

From CollectiveAccess Documentation
Jump to: navigation, search

Configuration files

app.conf

The main configuration file for the application. Settings include:

Commonly changed options affecting user experience

Option Description Values Default
disable_lightbox Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
dont_allow_registration_and_login Locale code to use if user has not specified a preferred locale. Should be in standard 2-letter ISO-639 language - underscore - 2-letter ISO-3166-1 region code. Locale code, ex. fr_CA (Canadian French) en_US
dont_approve_logins_on_registration Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
email_notification_for_new_registrations Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
dont_moderate_comments Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
dont_email_notification_for_new_comments Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
enable_bookmarks Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
media_overlay_titlebar_template Display template used to format information text at bottom of media overlay. Template is evaluated relative to the item with which the media is associated. Display template If left blank preferred label + identifier of the item associated with the media is displayed.
ca_users_lookup_settings Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
ca_users_lookup_delimiter Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
user_set_type Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
allow_ca_objects_representation_download Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
user_set_type Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
user_set_type Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1

Commonly changed options affecting application behavior

Option Description Values Default
clean_urls xxx 0=no, 1=yes 1
locale_default Locale code to use if user has not specified a preferred locale. Should be in standard 2-letter ISO-639 language - underscore - 2-letter ISO-3166-1 region code. Locale code, ex. fr_CA (Canadian French) en_US
do_content_caching xxx xxx
content_cache_dir xxx xxx
dont_enforce_access_settings xxx xxx
public_access_settings xxx xxx
privileged_access_settings xxx xxx
privileged_networks xxx xxx
ui_locales xxx xxx
html_page_title xxx xxx

Developer configuration

Option Description Values Default
purify_all_text_input Filter all user-entered text for possibly dangerous content such as javascript code. You should leave this on unless you know exactly why you don't need it. 0=no, 1=yes 1
minification xxx. Locale code, ex. fr_CA (Canadian French) en_US
auth_login_path xxx. Locale code, ex. fr_CA (Canadian French) en_US
password_reset_url xxx. Locale code, ex. fr_CA (Canadian French) en_US
auth_login_url xxx. Locale code, ex. fr_CA (Canadian French) en_US
auth_logout_url xxx. Locale code, ex. fr_CA (Canadian French) en_US
error_display_url xxx. Locale code, ex. fr_CA (Canadian French) en_US
default_action xxx. Locale code, ex. fr_CA (Canadian French) en_US
taskqueue_handlers xxx. Locale code, ex. fr_CA (Canadian French) en_US
taskqueue_handler_plugins xxx. Locale code, ex. fr_CA (Canadian French) en_US
taskqueue_tmp_directory xxx. Locale code, ex. fr_CA (Canadian French) en_US
default_bundle_access_level xxx. Locale code, ex. fr_CA (Canadian French) en_US
perform_type_access_checking xxx. Locale code, ex. fr_CA (Canadian French) en_US
default_type_access_level xxx. Locale code, ex. fr_CA (Canadian French) en_US
perform_item_level_access_checking xxx. Locale code, ex. fr_CA (Canadian French) en_US
default_item_access_level xxx. Locale code, ex. fr_CA (Canadian French) en_US

detail.conf

Controls options for all detail pages.

Option Description Values Default
pdfExportTitle A display template used to generate the file name of an export for download. The template is evaluated relative to the detail subject. Static text or a display template Preferred label of detail subject

search.conf

Defines search interfaces available for the installation.

Option Description Values Default
pdfExportTitle Text to use as the file name of an export for download. Static text If omitted the text of the search expression is used.

browse.conf

Defines browse interfaces available for the installation.

Option Description Values Default
pdfExportTitle Text to use as the file name of an export for download Static text If omitted text of the browse criteria are used.

lightbox.conf

Controls options for the optional lightbox interface.

Option Description Values Default
pdfExportTitle A display template used to generate the file name of an export for download. The template is evaluated relative to the lightbox's underlying set. Static text or a display template Preferred label of the set
Namespaces

Variants
Actions
Navigation
Tools
User
Personal tools