Home › Open Source › Kimura › Documentation

Directory Structure

Directory Structure

There are 3 main directories:

  • Modules
  • Sites
  • System

When you install Kimura, you shouldn't need to touch anything in the System folder.  You would install system wide modules in the Modules folder.  The Sites folder contains a subfolder for each site where each site can has its own configuration, served root, and modules.

Directory/File Description 
/modules
 ? 
  /module_name
 ? 
    /controllers
 ? 
    /components
 ? 
    /models
 ? 
    /views
 ? 
/sites
 ? 
  /site_name
 ? 
    /conf
 ? 
      site.json.conf
 The site's configuration file. 
    /modules
 Holds site specific modules. 
    /www
 The served root. Configure this directory as Apache's DocumentRoot. 
      .htaccess
 Controls what type of files Apache serves and the URL rewriting rules. 
      index.php
 The main entry point of the site. It invokes the kernel. 
/system
 Contains the Kimura core logic. 
  /conf
 This is where all system level configuration files go. 
    settings.php
 System level settings. 
  /lib
 Contains all of the class that make Kimura tick. 
    /cache
 Contains cache specific classes. 
  /templates
 Contains 
    /error
 ? 
      kernel_error.tpl
 ? 
    /site
 Holds templates used for creating a new site. 
      htaccess.template
 The default .htaccess file. 
      index.template
 The default index.php file.
‹ Database LayerupFeatures ›