Mura Directory Structure
There are a few primary directories and files you'll want to be aware of in Mura. The image below displays the directory structure of Mura, highlighting its required directories and files. The directories and files highlighted in red may be updated when updating Mura.
Note: Unless explicitly stated to the contrary, none of the directories or files listed below should be modified.
Directory or File | Editable | Description |
---|---|---|
{context}/admin/ | No | These files should never be modified. The files located here comprise the view and much of the functionality used for the administrative features of Mura. |
{context}/config/ | Yes | This directory contains configuration files. See The "config" Directory section for more information. |
{context}/core/ | No | These file should never be modified. The files located here are essentially the beating heart of Mura. We'll discuss a few files specific to Theme Developers in other sections. That said, it's best to simply leave the files in this directory alone. |
{context}/sites/ | Yes* | The directory itself is required, however the contents may be edited and will not be overwritten when updating Mura. This directory will be covered in the "Site Files" section. |
{context}/themes/ | Yes* | The directory itself is required, however the contents may be edited and will not be overwritten when updating Mura. This directory will be covered in the "Theme Layout Templates" section. |
{context}/modules/ | Yes* | The directory itself is required, however the contents may be edited and will not be overwritten when updating Mura. |
{context}/resource_bundles/ | Yes* | The directory itself is required, however the contents may be edited and will not be overwritten when updating Mura. |
{context}/plugins/ | Yes* | The directory itself is required, however the contents may be edited and will not be overwritten when updating Mura. This directory is used by experienced developers when creating Mura plugins. |
{context}/.git | No | The Mura team uses Git for distributed version control. This directory is created and used specifically by Git. You can safely ignore this directory. |
{context}/.gitignore | No | The Mura Team uses Git for distributed version control, and this is the root .gitignore file used to specify intentionally untracked files. |
{context}/.travis.yml | No | This file is used by Travis CI for automated testing. |
{context}/Application.cfc | No | This file contains Mura's application-specific variables and settings. |
{context}/box.json | No | This file is used by the Mura Team to run various tests using CommandBox and TestBox. |
{context}/index.cfm | No | This is Mura's "start" file, and should not be modified. |
{context}/installation.txt | No | This file outlines the basic steps to get up and running with Mura CMS. |
{context}/license.txt | No | This is the GNU General Public License, Version 2, with exceptions. |
{context}/Mura_CMS_ contribution_agreement.pdf |
No* | This file shouldn't be modified per se, but rather completed. For developers or development teams who wish to contribute to Mura, please complete this document and return it to matt.levine@blueriver.com. |
{context}/README.md | No | A simple README file. When viewed on Github, a badge from Travis CI will display whether or not the current build is passing its required tests. |
{context}/robots.txt | Yes | This file is used to give instructions about their site to web robots. You can safely modify this file. |
{context}/htaccess.txt | No | This is a sample .htaccess file for experienced web server administrators using Apache HTTP Server, and are looking for an example of how to eliminate the "index.cfm" from the URL. |
{context}/web.config.txt | No | This is a sample web.config file for experienced web server administrators using Microsoft IIS, and are looking for an example of how to eliminate the "index.cfm" from the URL. |
{context}/web.config | Yes | This file is used by Microsoft IIS. You can safely modify this file. However, it is recommended that only experienced web server administrators do so. |