The "config" Directory
This directory contains Mura's configuration files. The files and their purpose are listed below.
Directory | Editable | Description |
---|---|---|
{context}/config/Application.cfc | No | This file prevents site visitors from navigating directly to any of the .CFM files contained within this directory. |
{context}/config/cfapplication.cfm | Yes | Experienced developers may add custom Application.cfc variables and/or ColdFusion/CFML mappings here. |
{context}/config/README.md | No | This file contains information about the files contained in this directory. |
{context}/config/settings.ini.cfm | Yes | This is an extremely important file, and contains many of the default settings for Mura. View the settings.ini.cfm reference guide for details. |
The "settings.ini.cfm" File
This extremely important file contains many configuration settings for Mura. The ".ini
" file format is an informal standard for configuration files. It's a simple text file with a basic structure composed of sections with key-value pairs.
Example
[production] adminemail=steve@blueriver.com dbtype=mysql yourCustomKey=Your Value
Semicolons (;
) at the beginning of the line indicate a comment. Comment lines are ignored.
Reference
A reference for Mura's configuration settings is outlined below.
Settings Section
Key | Type | Default | Description |
---|---|---|---|
appreloadkey | string | appreload | The URL variable used to trigger Mura to reload the entire application. For security purposes, it is highly recommended to change this setting for production environments. |
mode | string | production |
Sets the mode per the appropriate settings in the section defined as [production], [development], etc. A complete set of key-value pairs is required for each mode. Duplicate the default production set, and edit as necessary. Valid options:
|
Production Section
Key | Type | Default | Description |
---|---|---|---|
admindomain | string | empty string | Controls the URL for accessing the back-end administration area of Mura. Especially useful for when you wish to use SSL for the admin area. |
admindir | string | /admin | A custom path to where the admin directory is located. The path must not be nested in a subdirectory (e.g., /some/custom/path is bad). Essentially, this setting merely allows you to rename, the admin directory, not necessarily move it. If you change this setting, you must reload Mura from the webroot, and not from the back-end administration area. |
adminemail | string | empty string | Default email address of the primary administrator for the installation of Mura. |
adminssl | boolean | false |
Valid options:
|
aggregatecontentqueries | boolean | false |
This setting is only used when the "Extranet" setting is set to "On", as found under Site Settings > Modules tab > Extranet (Password Protection), and will only apply to "content" feed beans using the "
|
allowautoupdates | boolean | true |
Determines whether links to update the Core and Site files are displayed. Valid options:
|
allowedindexfiles | string | index.cfm, index.json, index.html | Filenames allowed to be used with Mura's directory path URLs. |
allowlocalfiles | boolean | false | When importing files, Mura checks to see if you allow files to be imported from the local file system. |
allowsimplehtmlforms | boolean | true | If false , only FormBuilder forms will be allowed. This is often used for security purposes. |
assetdir | string | empty string | A custom file path to where your site assets should be stored. |
assetpath | string | empty string | The URL to where your assets are stored. Can be a domain or a root relative path. |
autodiscoverplugins | boolean | false | If true , Mura will scan the plugins directory for any new plugins, and if found, will auto-register them. |
autoresetpasswords | boolean | false | When using the "Lost Password" functionality, if true it will send a new password via email, otherwise if false , it will send a link via email to auto-login and prompt user to change password. |
autoupdatemode | string | default |
This feature is used when Mura is releasing a public Beta of the next version. Valid options include:
|
bcryptpasswords | boolean | true | Determines whether or not passwords go through the BCrypt process. If false , passwords are hashed instead. |
clientmanagement | boolean | false | This is an Application.cfc variable. |
clientstorage | string | empty string | This is an Application.cfc variable. |
confirmsaveasdraft | boolean | true | If true , a confirmation alert will appear when you navigate away from a content item without saving it. |
context | string | empty string | If Mura is installed under a subdirectory of the webroot, you should enter the path here. Mura will typically populate this field automatically, but you may have to enter the information if you move Mura after being installed. |
cookiedomain | string | empty string | Attribute to describe the scope of cookies. Read more |
cookiepath | string | empty string | Another attribute to describe the scope of cookies. Read more |
customtagpaths | string | empty string | A comma-delimited list of custom tag paths. For example, "c:\mapped1,c:\mapped2" |
datasource | string | empty string | This is the datasource (DSN) Mura should use to access the database. |
dbcasesensitive | boolean | false | If your database is case sensitive, (e.g., Oracle, Postgres), then set this to true |
dbpassword | string | empty string | Do not use this, if you're able to set your able to define your datasource. |
dbtype | string | empty string |
The database type being used by the
|
dbtablespace | string | USERS | Used only when dbtype=Oracle |
dbusername | string | empty string | Do not use this, if you're able to set your able to define your datasource. |
debuggingenabled | boolean | true | Controls whether or not Mura should display CFML errors to the browser. If set to false , Mura will display the file found under errortemplate . |
defaultfilemode | integer | 777 | If Mura is installed on a Unix based system, this setting will control the default permissions, in numeric notation. |
defermurajs | boolean | true | If true , the script reference to Mura.js will include the "defer" attribute, which means it be executed after the document has been parsed. This will improve the page load performance time. |
enablemuratag | boolean | true | At a global level, controls whether or not Mura will parse content for Mura [m] tags. May also be controlled at a site-level via the contentRenderer.cfc, on a site-by-site basis. |
encryptionkey | string | hash of getCurrentTemplatePath() |
Available for developers to use as an application-level storage for a custom encryption key. |
errortemplate | string | /muraWRM/config/error.html | Specifies the location of a file Mura should use when a CFML error occurs, and debuggingenabled=false . |
filedir | string | empty string | Optionally specify a custom directory to store Mura files, such as associated images (this does not include files uploaded via the web editor). Defaults to {context}/{SiteID}/cache/file/ |
fmshowapplicationroot | boolean | true | Controls whether or not the File Manager (CKFinder) displays the application root. |
fmshowsitefiles | boolean | true | Controls whether or not the File Manager (CKFinder) displays site files. |
forceadminssl | boolean | true | If true , Mura will force "https" protocol. |
hashurls | boolean | false | If true , Mura will generate URLs with directory names as hashes. |
haslockablenodes | boolean | false | If true , when a content manager is editing content, other content managers will be unable to edit the same content. |
hstsmaxage | integer | 1200 | View https://en.wikipedia.org/wiki/ HTTP_Strict_Transport_Security for more information. |
imageinterpolation | string | highQuality |
Specify a specific interpolation algorithm by name, by image quality, or by performance. See ImageResize for more information. Valid options:
|
indexfileinurls | boolean | true |
Controls whether or not "/index.cfm" appears in Mura-generated URLs. Valid options:
|
javasettingsloadcoldfusionclasspath | boolean | true | This is an Application.cfc variable. |
javasettingsloadpaths | string | /requirements/lib | This is an Application.cfc variable. |
javasettingswatchextensions | string | jar,class | This is an Application.cfc variable. |
javasettingswatchinterval | integer | 60 | This is an Application.cfc variable. |
legacyappcfc | boolean | false | Prior to v7.1, Application.cfc lifecycle files existed under the config/appcfc/ directory, and Mura Plugin developers sometimes linked to some of these files. To ease the upgrade path for legacy plugins, Mura will add stub files back to this location if this setting is set to true |
locale | string | server |
Renders dates and times per the selected locale. Valid options are:
|
loginstrikes | integer | 4 | The number of times a user can attempt to login before being locked out. |
mailserverip | string | empty string | SMTP server address to use for sending email messages. |
mailserverpassword | string | empty string | A password to send to SMTP servers that require authentication. |
mailserverpopport | integer | 110 | POP port |
mailserversmtpport | integer | 25 | TCP/IP port on which SMTP server listens for requests |
mailserverssl | boolean | false | Whether to use Secure Sockets Layer |
mailservertls | boolean | false | Whether to use Transport Level Security |
mailserverusername | string | empty string | A username to send to SMTP servers that require authentication. |
maxarchivedversions | integer | 50 | The number of versions to store in Mura. |
maxportalitems | integer | 1000 | Limits the number of total content items to display for pagination purposes on Folder displays. |
maxsourceimagewidth | integer | 4000 | Mura attempts to store the source image when uploading files. If the image size exceeds the width setting here in pixels, Mura will resize down to this setting. |
mfa | boolean | false | Experimental. Multi-factor authentication setting. If set to true , Mura will send email to user with authentication token to use to login. |
mfaperdevice | boolean | false | Experimental. Determines whether you have to use MFA only once per device. |
mfasendauthcode | boolean | true | Experimental. Set to false , if sending MFA token via a custom method. |
notifywithversionlink | boolean | true | Tells Mura when notifications for review are sent whether to send return link to the version history page or directly to the version edit form. |
ormautomanagesession | boolean | true | This is a CFML ORM setting. |
offline404 | boolean | true | Controls whether Mura returns a 404 status code for offline content. |
ormcfclocation | string | empty string | This is a CFML ORM setting. |
ormdatasource | string | empty string | This is a CFML ORM setting. |
ormdbcreate | string | update | This is a CFML ORM setting. |
ormenabled | boolean | true | This is a CFML ORM setting. |
ormeventhandling | boolean | true | This is a CFML ORM setting. |
ormflushatrequestend | boolean | false | This is a CFML ORM setting. |
ormlogsql | boolean | false | This is a CFML ORM setting. |
ormsavemapping | boolean | false | This is a CFML ORM setting. |
ormskipcfcwitherror | boolean | false | This is a CFML ORM setting. |
ormusedbformapping | boolean | false | This is a CFML ORM setting. |
ping | boolean | false |
Controls the scheduled task Mura creates for publishing scheduled content, sending scheduled emails, etc. Valid options:
|
plugindir | string | empty string | A custom filepath to where your plugins will be installed. Example: c:\inetpub\wwwroot\plugins |
port | integer | ${cgi.SERVER_PORT} | The Port that Mura runs on, and is included in Mura generated links. The Port needs to be the same for both the front end and back end of the site. |
proxypassword | string | empty string | Network proxy password for external http calls, if needed. |
proxyport | integer | ${cgi.SERVER_PORT} | Network proxy port for external http calls, if needed. |
proxyserver | string | empty string | Network proxy server for external http calls, if needed. |
proxyuser | string | empty string | Network proxy user for external http calls, if needed. |
purgedrafts | boolean | true | Whether or not to purge drafts when a new, active version is published. |
recaptchasitekey | string | empty string | The global Google reCAPTCHA site key. Used if no setting is entered at a site level via Site Settings. |
recaptchasecret | string | empty string | The global Google reCAPTCHA secret. Used if no setting is entered at a site level via Site Settings. |
recaptchalanguage | string | en | The global Google reCAPTCHA language. Used if no setting is entered at a site level via Site Settings. |
rendermuraalerts | boolean | true | Whether or not to display alerts in the Mura administration area. |
requesttimeout | integer | 1000 | This is an Application.cfc variable. |
sameformfieldsasarray | boolean | false | This is an Application.cfc variable. |
scriptprotect | boolean | true | This is an Application.cfc variable. |
scriptprotectexceptions | string | body,source,params | This is Mura's internal parsing for script protection. A comma-delimited list of fields to ignore for script protection. |
manageSessionCookies | boolean | true | This determines whether Mura will manage session cookies. |
securecookies | boolean | false | This is an Application.cfc variable. |
sessioncookiesexpires | string | never | This is an Application.cfc variable. |
sendfrommailserverusername | boolean | true | Whether or not to send email messages via the mailserverusername setting. |
sessionhistory | integer | 0 | Number of days to be stored for session tracking stats. |
sessiontimeout | integer | 180 | This is an Application.cfc variable. |
showadminloginhelp | boolean | true | Whether or not to display help when attempting to log in to the Mura administration area. |
siteidinurls | boolean | false | Whether or not to include the {SiteID} in links generated by Mura. |
sortpermission | string | editor |
Controls which Mura "role" has the ability to sort content. Valid options are:
|
strictfactory | boolean | true | This controls the DI/1 strict setting. If true , DI/1 will throw an exception if it cannot resolve a bean implied by a constructor argument, setter name, or property name. If false , DI/1 simply calls logMissingBean() which writes the failure to the Java console. |
stricthtml | boolean | false | If true , Mura will not allow HTML syntax to be used in class extension's extended attributes, unless explicitly excluded via the stricthtmlexclude setting. |
stricthtmlexclude | string | empty string | If stricthtml=true , Mura will check this setting for a list of extended attributes to allow HTML syntax. It is not necessary to specify any extended attributes where its type is set to HTMLEditor . |
strongpasswordregex | regex | (?=^.{7,15}$)(?=.*\d)(?![.\n])(?=.*[a-zA-Z]).*$ | If strongpasswords=true , Mura will use the regular expression (regex) entered here when users create their passwords. |
strongpasswords | boolean | false | If true , Mura enforces the strongpasswordregex setting. |
tempdir | string | empty string | A custom path for temporary storage for uploaded files. |
title | string | Mura CMS | Text to prepend the Site Name in the <title> tag of the Mura Administrator. |
usedefaultsmtpserver | boolean | true | Whether or not to use the SMTP server settings stored in the CFML administrator. |
usefilemode | boolean | false | Option to specify that Mura set file permissions for Unix-based systems. |
windowdocumentdomain | string | empty string | This setting controls the document.domain setting for Mura's administration UI when editing content via the front-end for potential cross-subdomain issues. See Same-origin policy on the Mozilla Developer Network for more information. |