webCOMAND

Folder Layout

Top-Level Folder

There are typically just a few files in the main folder where webCOMAND is installed.

  • comand (comand.exe on Windows) - CLI to webCOMAND features and packages.
  • comand.php - The file to include from PHP scripts to use the PHP API.
  • config.php - Main configuration options to override defaults.
  • license.txt - The webCOMAND software license in plain-text format.
  • readme.txt - High-level information about webCOMAND.

Subfolders

webCOMAND's files are organized into the following folders

  • files/ - contains files that will be produced and managed by webCOMAND and it's users
    • packages/ - Where custom packages are created and maintained.  Depending on the configuration, user-installed packages (from the Market) may be installed here as well.
    • publications/ - webCOMAND is typically configured to publish files to a subfolders of this folder.  The subfolders are typically named after the hostname of each published website.  For example:
      • www.website.com/ - A folder typically named with the website hostname.
        • htdocs/ - The document root that contains all of the public website files.
  • packages/ - Where standard webCOMAND packages are installed.  Depending on the configuration, user-installed packages (from the Market) may be installed here as well.
  • system/ - Where system managed files, such as cache files, user uploads, process lock files and other temporarily files are located.  The subfolders can typically be emptied out when webCOMAND is not running and the necessary files will be rebuilt as needed.
  • webroot/ - these files should be copied to the web server's document root folder.

Package Folders

Packages folders above may contain any number of package folders, each named after the package namespace (based on reversed hostnames).  For example, io_comand_images.

Each package folder will typically contain one or more of the files and folders outlined on the Package Routing and cMVC Framework pages.