Folder Structure
Here you can see the folder structure of the CMS. For information about the modules folder structure see the different modules sections in this documentation.
_cron
Contains cronjob files. Execute these files according to their time period (e.g., cron.daily for daily tasks).
_script
Contains installed and active script modules. Manage these through the Administrator Interface; manual edits are not advised. See the documentation for module development details.
_site
Holds installed and active site modules. Use the Administrator Interface for management; manual edits are not advised. Refer to the documentation for more information.
_image
Contains installed and active image modules. It's recommended to manage these through the Administrator Interface; manual edits are not advised. Refer to the documentation for module development.
_core
The _core folder contains core code and will be overwritten during core updates.
| Folder Structure | Description |
|---|---|
| _core | Holds all core-related files. This folder is upgraded during core updates, and changes here are not persistent. |
| _core/_action | Stores external actions requested by CMS PHP scripts. |
| _core/_action/admin_switch.php | Page to Switch between Backend and Frontend. Can be accessed diretly through browser. |
| _core/_action/js_debug_action.php | External Action for the Debugging of Javascript Code, if Activated in Config will Log Errors in Javascript Commands in the Logging Table. |
| _core/_action/token_switch.php | Page to switch between Site Modules with Tokens if activated in cfg-ruleset.php Can be accessed diretly through browser. |
| _core/_action/user_activate.php | General Action Script to Activate Accounts via Mail. Can be accessed diretly through browser if activated in Site Modules Config. |
| _core/_action/user_login.php | General Login page. Can be accessed diretly through browser if activated in Site Modules Config. |
| _core/_action/user_logout.php | General Logout Page. |
| _core/_action/user_mail_change.php | Change Mail of current Account Page. Can be accessed diretly through browser if activated in Site Modules Config. |
| _core/_action/user_recover.php | Recover Account Password per Mail if not Logged in. Can be accessed diretly through browser if activated in Site Modules Config. |
| _core/_action/user_register.php | Register New Account. Can be accessed diretly through browser if activated in Site Modules Config. |
| _core/_captcha | Contains captcha images for inclusion in your project. Refer to the documentation for session variable details to store captcha tokens. |
| _core/_captcha/captcha.comment.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.comment"] |
| _core/_captcha/captcha.contact.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.contact"] |
| _core/_captcha/captcha.download.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.download"] |
| _core/_captcha/captcha.guestbook.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.guestbook"] |
| _core/_captcha/captcha.login.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.login"] |
| _core/_captcha/captcha.member.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.member"] |
| _core/_captcha/captcha.misc.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.misc"] |
| _core/_captcha/captcha.newsletter.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.newsletter"] |
| _core/_captcha/captcha.register.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.register"] |
| _core/_captcha/captcha.reset.php | Capchta Image with Code Generation at $SESSION[HIVE_SITE_COOKIE."captcha.reset"] |
| _core/_error | Default error templates used in .htaccess and for project integration. Use as full-page templates to include HTTP error codes. |
| _core/_error/error.400.php | Error File |
| _core/_error/error.401.php | Error File |
| _core/_error/error.403.php | Error File |
| _core/_error/error.404.php | Error File |
| _core/_error/error.500.php | Error File |
| _core/_error/error.501.php | Error File |
| _core/_error/error.502.php | Error File |
| _core/_error/error.503.php | Error File |
| _core/_error/error.504.php | Error File |
| _core/_error/error.520.php | Error File |
| _core/_error/error.521.php | Error File |
| _core/_error/error.533.php | Error File |
| _core/_font | Stores included font files. Check the license for each font in the documentation or the _licenses folder. |
| _core/_font/font.captcha_fallback.ttf | Font File |
| _core/_font/font.Changa-Bold.ttf | Font File |
| _core/_font/font.Changa-ExtraBold.ttf | Font File |
| _core/_font/font.Changa-ExtraLight.ttf | Font File |
| _core/_font/font.Changa-Light.ttf | Font File |
| _core/_font/font.Changa-Medium.ttf | Font File |
| _core/_font/font.Changa-Regular.ttf | Font File |
| _core/_font/font.Changa-SemiBold.ttf | Font File |
| _core/_font/font.Changa-VariableFont_wght.ttf | Font File |
| _core/_font/font.ComicNeue-Bold.ttf | Font File |
| _core/_font/font.ComicNeue-BoldItalic.ttf | Font File |
| _core/_font/font.ComicNeue-Italic.ttf | Font File |
| _core/_font/font.ComicNeue-Light.ttf | Font File |
| _core/_font/font.ComicNeue-LightItalic.ttf | Font File |
| _core/_font/font.ComicNeue-Regular.ttf | Font File |
| _core/_font/font.Lato-Black.ttf | Font File |
| _core/_font/font.Lato-BlackItalic.ttf | Font File |
| _core/_font/font.Lato-Bold.ttf | Font File |
| _core/_font/font.Lato-BoldItalic.ttf | Font File |
| _core/_font/font.Lato-Italic.ttf | Font File |
| _core/_font/font.Lato-Light.ttf | Font File |
| _core/_font/font.Lato-LightItalic.ttf | Font File |
| _core/_font/font.Lato-Regular.ttf | Font File |
| _core/_font/font.Lato-Thin.ttf | Font File |
| _core/_font/font.Lato-ThinItalic.ttf | Font File |
| _core/_font/font.Roboto-Black.ttf | Font File |
| _core/_font/font.Roboto-BlackItalic.ttf | Font File |
| _core/_font/font.Roboto-Bold.ttf | Font File |
| _core/_font/font.Roboto-BoldItalic.ttf | Font File |
| _core/_font/font.Roboto-Italic.ttf | Font File |
| _core/_font/font.Roboto-Light.ttf | Font File |
| _core/_font/font.Roboto-LightItalic.ttf | Font File |
| _core/_font/font.Roboto-Medium.ttf | Font File |
| _core/_font/font.Roboto-MediumItalic.ttf | Font File |
| _core/_font/font.Roboto-Regular.ttf | Font File |
| _core/_font/font.Roboto-Thin.ttf | Font File |
| _core/_font/font.Roboto-ThinItalic.ttf | Font File |
| _core/_font/font.RockSalt-Regular.ttf | Font File |
| _core/_framework | Contains Bugfish Framework files included automatically in javascript.php and stylesheet.php during initialization. |
| _core/_image** | Default JPG/PNG/ICO images used in various CMS sections. |
| _core/_image/image.cms_banner.jpg | Image File |
| _core/_image/image.cms_logo.jpg | Image File |
| _core/_image/image.cms_logo_alpha.png | Image File |
| _core/_image/image.cms_logo_alpha_dark.png | Image File |
| _core/_image/image.favicon.ico | Image File |
| _core/_image/image.flat_background.jpg | Image File |
| _core/_image/image.framework_banner.jpg | Image File |
| _core/_image/image.framework_logo.jpg | Image File |
| _core/_image/image.framework_logo_small.jpg | Image File |
| _core/_image/image.user_profile.png | Image File |
| _core/_lang | Default language translation files. Automatically loaded based on the _HIVE_LANG_ constant, which controls the displayed language. |
| _core/_lang/en.php | Default English Translations if not overwritten by Site Module Language Files, mostly for Files in _action in the Core Folder. |
| _core/_lib | Core function library of the CMS, included automatically during site initialization. |
| _core/_lib/lib.adminbsb.php | Default Functions for the AdminBSB Dashboard Template |
| _core/_lib/lib.hive.php | bugfishCMS Core Function Library for various purposes. |
| _core/_lib/lib.simple.php | Default Functions for the Simple Template |
| _core/_lib/lib.volt.php | Default Functions for the Volt Dashboard Template |
| _core/_lib/lib.windmill.php | Default Functions for the Windmill Dashboard Template |
| _core/_mysql | Contains MySQL core system tables installed during site initialization, as specified in initialize.php. |
| _core/_mysql/mysql.hub.php | Stores Data for distributed Software Hub Items controlled via the administrator Interface. |
| _core/_mysql/mysql.store.php | Stores Data for distributed Store Modules controlled via the administrator Interface. |
| _core/_mysql/mysql.token.php | Stores Data for the Token Switch _action Script controlled via the administrator Interface. |
| _core/_vendor | 3rd party scripts, functions, and templates. Include these in your module to add new functionalities or UX features. Licenses can be found in the documentation or _licenses folder. |
| _core/initialize.php | Initializes site functionalities and includes variables, referenced by settings.php. |
| _core/javascript.php | JavaScript loader for framework, module, and extension-related scripts. Include this file in your project's header as a standard JS script file. |
| _core/stylesheet.php | CSS loader for framework, module, and extension-related stylesheets. Include this file in your project's header as a standard CSS file. |
| _core/version.php | Contains versioning information for the core system. |
_data
The _data folder contains all dynamic data for site modules and their extensions. Within the _data directory, a corresponding folder for each site module (based on the module's folder name in _site) is automatically created to store this data. This includes all on-site uploads and data that are not part of the module's source code, which remains in _site. If these folders are deleted, they will be automatically recreated by the CMS. Upgrades won't touch this folder.
| Folder Structure | Description |
|---|---|
| _data | Stores module-related files, including public, private, extensions, and dynamic files for site modules. For more details, see the documentation or module folder structure section below |
| _data/__internal | Folder for Internal Data Files like Backups and More. |
| _data/__internal/_backup | Folder to store Backups of all Kind. |
| _data/__internal/_docker | Folder to store Docker Related Files. |
| _data/MODULE | A folder matching the site module name in _site is created here to store its data. If the _site module folder is renamed, this _data folder must also be renamed to maintain the connection between the module and its data during CMS initialization. |
| _data/MODULE/_public | Stores public data for site modules, accessible without PHP scripts. This folder is not HTACCESS secured, allowing hardlinking. |
| _data/MODULE/_private | Contains private data for the module, protected by HTACCESS. Access to this data requires PHP handlers with appropriate access controls or predefined scripts. |
| _data/MODULE/_extension | Stores active extensions for the site module. |
| _data/MODULE/_extension_disabled | Stores inactive extensions for the site module. |
| _data/MODULE/_domain | Used for storing site module-related domain files like sitemaps, robots.txt, and other linked files. |
_disabled
The _disabled folder contains disabled modules and is not affected by core updates.
| Folder Structure | Description |
|---|---|
| _disabled | Stores inactive modules. |
| _disabled/_image | Stores installed but inactive image modules. |
| _disabled/_script | Stores installed but inactive script modules. |
| _disabled/_site | Stores installed but inactive site modules. |
_store
The _store folder manages cache files from downloaded items via the internal store, as well as files for deploying modules, core versions, or software through the CMS. Core updates do not affect this folder, except for PHP files in _store/*.php which may be updated during core releases.
| Folder Structure | Description |
|---|---|
| _store | Manages store-related data for deployments and downloads. |
| _store/_temp | Stores temporary data related to the store. |
| _store/_hub | Contains data for bugfishHUB software deployment. |
| _store/_hub/_release | Holds software releases for bugfishHUB. |
| _store/_hub/_changelog | Contains changelogs for bugfishHUB software releases. |
| _store/_hub/_download | Manages the bugfishHUB software download library. |
| _store/_hub/_download/_image | Stores images for the bugfishHUB download library. |
| _store/_hub/_download/_changelog | Contains changelogs for downloads in the bugfishHUB library. |
| _store/_hub/_download/_cache | Stores cache files for the bugfishHUB download library. |
| _store/_hub/_download/_release | Holds release files for the bugfishHUB download library. |
| _store/_core | Manages data for bugfishCMS core deployment. |
| _store/_core/_release | Contains release files for bugfishCMS core. |
| _store/_core/_changelog | Holds changelogs for bugfishCMS core releases. |
| _store/_app | Manages data for bugfishApp deployment. |
| _store/_app/_release | Contains release files for bugfishApp. |
| _store/_app/_changelog | Holds changelogs for bugfishApp releases. |
| _store/_module | Manages data for bugfishCMS module deployment. |
| _store/_module/_release | Contains release files for bugfishCMS modules. |
| _store/_module/_image | Stores images for bugfishCMS module releases. |
| _store/_module/_changelog | Holds changelogs for bugfishCMS module releases. |
| _store/_module/_cache | Manages cache for bugfishCMS module releases. |
| _store/_tpl | Contains available modules for installation via the administrator module. |
| _store/_tpl/_site | Contains available site modules for installation. |
| _store/_tpl/_image | Stores available site images for installation. |
| _store/_tpl/_docker | Manages available Docker images for installation. |
| _store/_tpl/_extension | Contains available module extensions for installation. |
| _store/_tpl/_script | Manages available script extensions for installation. |
| _store/app_fetch_all.php | API to fetch all available bugfishAPP versions. |
| _store/app_fetch_latest.php | API to fetch the latest bugfishAPP version. |
| _store/core_fetch_all.php | API to fetch all available core versions. |
| _store/core_fetch_latest.php | API to fetch the latest core version. |
| _store/hub_fetch_all.php | API to fetch all available bugfishHUB versions. |
| _store/hub_fetch_latest.php | API to fetch the latest bugfishHUB software version. |
| _store/hub_fetch_download.php | API to fetch deployed Hub modules. |
| _store/module_fetch_all.php | API to fetch all deployed store modules. |
cfg_ruleset_sample.php
Sample configuration file for developers to modify CMS settings. Rename to cfg_ruleset.php to apply changes. Check the file for configuration parameters.
index.php
Main index file to initialize the CMS and load the current website section.
.htaccess
Automatically created file for server configuration. Changes to this file will be persistent and include explanations for usable configurations.
updater.php
Script for deploying site mode build updates. Further details can be found in the documentation.
developer.php
Files for developers to control site functionalities during development. More details are available in the documentation.
settings.php
Created after a successful installation using installer.php or by manually editing and renaming settings_sample.php.
robots.txt
Automatically created file for managing search engine robots. Changes to this file will be persistent.
settings_sample.php
Sample settings file used if the installer fails to create settings.php. Manual changes are not required if using the default installer.
installer.php
Installation script to set up the CMS on the web server and create the settings.php file if it does not exist.