diff --git a/index.html b/index.html index b62da08..cc5d3fa 100644 --- a/index.html +++ b/index.html @@ -79,6 +79,16 @@ +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -354,13 +364,13 @@
    Table of Contents
    -

    light

    +

    Dotkernel Light

    DotKernel Light

    Installation

    -

    Using Composer

    +

    Using Git

             
-        composer require dotkernel/light
+        git clone https://github.com/dotkernel/light.git dotkernel-light
    @@ -403,54 +413,74 @@

    Support

     @@ -525,5 +555,5 @@
    Search
    diff --git a/pages/404.html b/pages/404.html index 27798b5..a1baa81 100644 --- a/pages/404.html +++ b/pages/404.html @@ -77,6 +77,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -200,54 +210,74 @@

    Something went wrong!

     diff --git a/search/search_index.json b/search/search_index.json index 035847a..4cefe80 100644 --- a/search/search_index.json +++ b/search/search_index.json @@ -1 +1 @@ -{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"../../README.md","title":"Home"},{"location":"#readmemd","text":"","title":"../../README.md"},{"location":"v1/introduction/","text":"Dotkernel light Minimal project to generate a simple website.","title":"Introduction"},{"location":"v1/introduction/#dotkernel-light","text":"Minimal project to generate a simple website.","title":"Dotkernel light"},{"location":"v1/core-features/npm-commands/","text":"NPM Commands To install dependencies into the node_modules directory run this command. npm install If npm install fails, this could be caused by user permissions of npm. Recommendation is to install npm through Node Version Manager . The watch command compiles the components then watches the files and recompiles when one of them changes: npm run watch When you are done making changes to your code, this command compiles the assets locally, minifies them and makes them ready for production: npm run prod","title":"NPM Commands"},{"location":"v1/core-features/npm-commands/#npm-commands","text":"To install dependencies into the node_modules directory run this command. npm install If npm install fails, this could be caused by user permissions of npm. Recommendation is to install npm through Node Version Manager . The watch command compiles the components then watches the files and recompiles when one of them changes: npm run watch When you are done making changes to your code, this command compiles the assets locally, minifies them and makes them ready for production: npm run prod","title":"NPM Commands"},{"location":"v1/installation/composer/","text":"Composer Installation of Packages Composer is required to install DotKernel Light . You can install Composer starting here . Install dependencies composer install The setup script will prompt you for the below configuration setting: Please select which config file you wish to inject 'Laminas\\HttpHandlerRunner\\ConfigProvider' into: [0] Do not inject [1] config/config.php Make your selection (default is 1): Simply select [0] Do not inject , because DotKernel includes its own ConfigProvider which already contains the prompted configurations. The next question is: Remember this option for other packages of the same type? (y/N) Type y here, and hit Enter .","title":"Composer"},{"location":"v1/installation/composer/#composer-installation-of-packages","text":"Composer is required to install DotKernel Light . You can install Composer starting here .","title":"Composer Installation of Packages"},{"location":"v1/installation/composer/#install-dependencies","text":"composer install The setup script will prompt you for the below configuration setting: Please select which config file you wish to inject 'Laminas\\HttpHandlerRunner\\ConfigProvider' into: [0] Do not inject [1] config/config.php Make your selection (default is 1): Simply select [0] Do not inject , because DotKernel includes its own ConfigProvider which already contains the prompted configurations. The next question is: Remember this option for other packages of the same type? (y/N) Type y here, and hit Enter .","title":"Install dependencies"},{"location":"v1/installation/configuration-files/","text":"Configuration Files Duplicate config/autoload/local.php.dist as config/autoload/local.php .","title":"Configuration Files"},{"location":"v1/installation/configuration-files/#configuration-files","text":"Duplicate config/autoload/local.php.dist as config/autoload/local.php .","title":"Configuration Files"},{"location":"v1/installation/development-mode/","text":"Development mode If you're installing the project for development, make sure you have development mode enabled, by running: composer development-enable You can disable development mode by running: composer development-disable You can check if you have development mode enabled by running: composer development-status","title":"Development Mode"},{"location":"v1/installation/development-mode/#development-mode","text":"If you're installing the project for development, make sure you have development mode enabled, by running: composer development-enable You can disable development mode by running: composer development-disable You can check if you have development mode enabled by running: composer development-status","title":"Development mode"},{"location":"v1/installation/faq/","text":"Frequently Asked Questions How do I fix common permission issues? If running your project you encounter some permission issues, follow the below steps. Errors PHP Fatal error: Uncaught InvalidArgumentException: The directory \"/var/www/ example.local /html/data\" is not writable... PHP Fatal error: Uncaught InvalidArgumentException: The directory \"/var/www/ example.local /html/data/cache\" is not writable... Fix: chmod -R 777 data Error PHP Fatal error: Uncaught ErrorException: fopen(/var/www/ example.local /config/autoload/../../log/error-log- yyyy-mm-dd.log ): Failed to open stream: Permission denied... Fix: chmod -R 777 log","title":"FAQ"},{"location":"v1/installation/faq/#frequently-asked-questions","text":"","title":"Frequently Asked Questions"},{"location":"v1/installation/faq/#how-do-i-fix-common-permission-issues","text":"If running your project you encounter some permission issues, follow the below steps.","title":"How do I fix common permission issues?"},{"location":"v1/installation/getting-started/","text":"Clone the project Recommended development environment If you are using Windows as OS on your machine, you can use WSL2 as development environment. Read more on dotkernel.com . Using your terminal, navigate inside the directory you want to download the project files into. Make sure that the directory is empty before proceeding to the download process. Once there, run the following command: git clone https://github.com/dotkernel/light.git .","title":"Getting Started"},{"location":"v1/installation/getting-started/#clone-the-project","text":"","title":"Clone the project"},{"location":"v1/installation/getting-started/#recommended-development-environment","text":"If you are using Windows as OS on your machine, you can use WSL2 as development environment. Read more on dotkernel.com . Using your terminal, navigate inside the directory you want to download the project files into. Make sure that the directory is empty before proceeding to the download process. Once there, run the following command: git clone https://github.com/dotkernel/light.git .","title":"Recommended development environment"},{"location":"v1/installation/running-the-application/","text":"Running the application We recommend running your applications in WSL: make sure you have WSL installed on your system currently we provide a distro implementations for AlmaLinux9 install the application in a virtualhost as recommended by the chosen distro set $baseUrl in config/autoload/local.php to the address of the virtualhost run the application by opening the virtualhost address in your browser You should see the DotKernel Light welcome page. If you are getting exceptions or errors regarding some missing services, try running the following command: sudo php bin/clear-config-cache.php If data/cache/config-cache.php is present, that config will be loaded regardless of the ConfigAggregator::ENABLE_CACHE configuration in config/autoload/mezzio.global.php","title":"Running the Application"},{"location":"v1/installation/running-the-application/#running-the-application","text":"We recommend running your applications in WSL: make sure you have WSL installed on your system currently we provide a distro implementations for AlmaLinux9 install the application in a virtualhost as recommended by the chosen distro set $baseUrl in config/autoload/local.php to the address of the virtualhost run the application by opening the virtualhost address in your browser You should see the DotKernel Light welcome page. If you are getting exceptions or errors regarding some missing services, try running the following command: sudo php bin/clear-config-cache.php If data/cache/config-cache.php is present, that config will be loaded regardless of the ConfigAggregator::ENABLE_CACHE configuration in config/autoload/mezzio.global.php","title":"Running the application"},{"location":"v1/introduction/file-structure/","text":"File structure Dotkernel Light follows the PSR-4 standards. It is a good practice to standardize the file structure of projects. When using DotKernel Light, the following structure is installed by default: Main directories bin - various helper scripts config - various configuration files data - should contain project-related data log - storage of log files generated by dot-error-log library public - publicly visible files. The webserver need to have this folder as www-document root folder. src - should contain the source code files test - should contain the test files bin directory This directory contains one file, clear-config-cache.php which removes the config cache file ( data/cache/config-cache.php - available only when development mode is enabled). config directory This directory contains all application-related config files: config.php : here you will register ConfigProviders after installing packages container.php : main service container, providing access to all registered services development.config.php.dist : gets symlinked as development.config.php when enabling development mode - activates debug mode pipeline.php : contains a list of middlewares, in their order of execution twig-cs-fixer.php : configuration file for Twig code style checker/fixer autoload directory This directory contains all service-related local and global config files: app.global.php : sets the application name dependencies.global.php : config file to set global dependencies that should be accessible by all modules development.local.php.dist : gets symlinked as development.local.php when enabling development mode - activates error handlers error-handling.global.php : configures and activates error logs local.php.dist : local config file where you can overwrite application name and URL mezzio.global.php : Mezzio core config file templates.global.php : dotkernel/dot-twigrenderer config file data directory This directory is a storage for project data files and service caches. Inside you will find: cache : Twig's cache directory AVOID storing sensitive data on VCS. log directory This directory stores daily log files. When you access the application from the browser, (if not already created) a new log file gets created in the format specified in the config/autoload/error-handling.global.php config file under the stream array key. public directory This directory contains all publicly available assets and serves as the entry point of the application: css : contains app.css , a single file containing the entire CSS code collected from all modules, in a minified form fonts : contains app , a directory containing custom font files collected from all modules images : contains app , a directory containing all image files collected from all modules js : contains app.js , a single file containing the entire JavaScript code collected from all modules, in a minified form .htacess : server configuration file used by Apache web server - this file enables the URL rewrite functionality index.php : the application's main entry point robots.txt.dist : a sample robots.txt file, providing settings allow/deny bot access to certain areas of your application - activate it by duplicating the file as robots.txt and comment out the lines that don't match your environment src directory This directory contains two directories, called modules: App Page App directory This is the App module. It contains all generic functionalities your application depends on. The assets directory contains all generic assets, reusable across the application. The src contains ConfigProvider.php , a file that sets template path aliases ( getTemplates ) but can also provide dependencies ( getDependencies ). The templates : contains misc components like the home page, custom error pages, template partials and the default layout template. Page directory This is the Page module. It contains page-related components for your application. The src directory contains the following items: Controller : contains module controllers Factory : contains module factories, which are used to provide ready-to-use instances of certain classes Service : contains module service files, which contain classes that provide custom functionalities ConfigProvider.php - provides module configuration data RoutesDelegator.php - stored main routes found in the module The templates directory contains the page directory, with template files for various web pages. Special purpose directories .github - contains workflow files .laminas-ci - contains Laminas Continuous Integration (CI) workflow files","title":"File Structure"},{"location":"v1/introduction/file-structure/#file-structure","text":"Dotkernel Light follows the PSR-4 standards. It is a good practice to standardize the file structure of projects. When using DotKernel Light, the following structure is installed by default:","title":"File structure"},{"location":"v1/introduction/file-structure/#main-directories","text":"bin - various helper scripts config - various configuration files data - should contain project-related data log - storage of log files generated by dot-error-log library public - publicly visible files. The webserver need to have this folder as www-document root folder. src - should contain the source code files test - should contain the test files","title":"Main directories"},{"location":"v1/introduction/file-structure/#special-purpose-directories","text":".github - contains workflow files .laminas-ci - contains Laminas Continuous Integration (CI) workflow files","title":"Special purpose directories"},{"location":"v1/introduction/packages/","text":"Packages dotkernel/dot-controller - Provides base classes for action based controllers similar to Laminas controller component dotkernel/dot-errorhandler - Logging Error Handler for Middleware Applications dotkernel/dot-twigrenderer - DotKernel component providing twig extensions and customizations friendsofphp/proxy-manager-lts - Fork of ocramius/proxy-manager laminas/laminas-component-installer - Composer plugin for injecting modules and configuration providers into application configuration laminas/laminas-config-aggregator - Lightweight library for collecting and merging configuration from different sources mezzio/mezzio - PSR-15 Middleware Microframework mezzio/mezzio-fastroute - FastRoute integration for Mezzio","title":"Packages"},{"location":"v1/introduction/packages/#packages","text":"dotkernel/dot-controller - Provides base classes for action based controllers similar to Laminas controller component dotkernel/dot-errorhandler - Logging Error Handler for Middleware Applications dotkernel/dot-twigrenderer - DotKernel component providing twig extensions and customizations friendsofphp/proxy-manager-lts - Fork of ocramius/proxy-manager laminas/laminas-component-installer - Composer plugin for injecting modules and configuration providers into application configuration laminas/laminas-config-aggregator - Lightweight library for collecting and merging configuration from different sources mezzio/mezzio - PSR-15 Middleware Microframework mezzio/mezzio-fastroute - FastRoute integration for Mezzio","title":"Packages"},{"location":"v1/introduction/server-requirements/","text":"Server Requirements For production, we highly recommend a *nix based system. Webserver Apache >= 2.2 or Nginx mod_rewrite .htaccess support (AllowOverride All) PHP >= 8.2 Both mod_php and FCGI (FPM) are supported. Required Settings and Modules & Extensions memory_limit >= 128M upload_max_filesize and post_max_size >= 100M (depending on your data) mbstring CLI SAPI (for Cron Jobs) Composer (added to $PATH) RDBMS MariaDB >= 10.11 LTS Recommended extensions opcache pdo_mysql or mysqli (if using MySQL or MariaDB as RDBMS) dom - if working with markup files structure (html, xml etc.) simplexml - working with xml files gd, exif - if working with images zlib, zip, bz2 - if compressing files curl (required if APIs are used) sqlite3 - for tests","title":"Server Requirements"},{"location":"v1/introduction/server-requirements/#server-requirements","text":"For production, we highly recommend a *nix based system.","title":"Server Requirements"},{"location":"v1/introduction/server-requirements/#webserver","text":"Apache >= 2.2 or Nginx mod_rewrite .htaccess support (AllowOverride All)","title":"Webserver"},{"location":"v1/introduction/server-requirements/#php-82","text":"Both mod_php and FCGI (FPM) are supported.","title":"PHP >= 8.2"},{"location":"v1/introduction/server-requirements/#required-settings-and-modules-extensions","text":"memory_limit >= 128M upload_max_filesize and post_max_size >= 100M (depending on your data) mbstring CLI SAPI (for Cron Jobs) Composer (added to $PATH)","title":"Required Settings and Modules & Extensions"},{"location":"v1/introduction/server-requirements/#rdbms","text":"MariaDB >= 10.11 LTS","title":"RDBMS"},{"location":"v1/introduction/server-requirements/#recommended-extensions","text":"opcache pdo_mysql or mysqli (if using MySQL or MariaDB as RDBMS) dom - if working with markup files structure (html, xml etc.) simplexml - working with xml files gd, exif - if working with images zlib, zip, bz2 - if compressing files curl (required if APIs are used) sqlite3 - for tests","title":"Recommended extensions"}]} \ No newline at end of file +{"config":{"indexing":"full","lang":["en"],"min_search_length":3,"prebuild_index":false,"separator":"[\\s\\-]+"},"docs":[{"location":"","text":"../../README.md","title":"Home"},{"location":"#readmemd","text":"","title":"../../README.md"},{"location":"v1/introduction/","text":"Dotkernel light Minimal project to generate a simple website.","title":"Introduction"},{"location":"v1/introduction/#dotkernel-light","text":"Minimal project to generate a simple website.","title":"Dotkernel light"},{"location":"v1/core-features/npm-commands/","text":"NPM Commands To install dependencies into the node_modules directory run this command. npm install If npm install fails, this could be caused by user permissions of npm. Recommendation is to install npm through Node Version Manager . The watch command compiles the components then watches the files and recompiles when one of them changes: npm run watch When you are done making changes to your code, this command compiles the assets locally, minifies them and makes them ready for production: npm run prod","title":"NPM Commands"},{"location":"v1/core-features/npm-commands/#npm-commands","text":"To install dependencies into the node_modules directory run this command. npm install If npm install fails, this could be caused by user permissions of npm. Recommendation is to install npm through Node Version Manager . The watch command compiles the components then watches the files and recompiles when one of them changes: npm run watch When you are done making changes to your code, this command compiles the assets locally, minifies them and makes them ready for production: npm run prod","title":"NPM Commands"},{"location":"v1/installation/composer/","text":"Composer Installation of Packages Composer is required to install DotKernel Light . You can install Composer starting here . Install dependencies composer install The setup script will prompt you for the below configuration setting: Please select which config file you wish to inject 'Laminas\\HttpHandlerRunner\\ConfigProvider' into: [0] Do not inject [1] config/config.php Make your selection (default is 1): Simply select [0] Do not inject , because DotKernel includes its own ConfigProvider which already contains the prompted configurations. The next question is: Remember this option for other packages of the same type? (y/N) Type y here, and hit Enter .","title":"Composer"},{"location":"v1/installation/composer/#composer-installation-of-packages","text":"Composer is required to install DotKernel Light . You can install Composer starting here .","title":"Composer Installation of Packages"},{"location":"v1/installation/composer/#install-dependencies","text":"composer install The setup script will prompt you for the below configuration setting: Please select which config file you wish to inject 'Laminas\\HttpHandlerRunner\\ConfigProvider' into: [0] Do not inject [1] config/config.php Make your selection (default is 1): Simply select [0] Do not inject , because DotKernel includes its own ConfigProvider which already contains the prompted configurations. The next question is: Remember this option for other packages of the same type? (y/N) Type y here, and hit Enter .","title":"Install dependencies"},{"location":"v1/installation/configuration-files/","text":"Configuration Files Duplicate config/autoload/local.php.dist as config/autoload/local.php .","title":"Configuration Files"},{"location":"v1/installation/configuration-files/#configuration-files","text":"Duplicate config/autoload/local.php.dist as config/autoload/local.php .","title":"Configuration Files"},{"location":"v1/installation/development-mode/","text":"Development mode If you're installing the project for development, make sure you have development mode enabled, by running: composer development-enable You can disable development mode by running: composer development-disable You can check if you have development mode enabled by running: composer development-status","title":"Development Mode"},{"location":"v1/installation/development-mode/#development-mode","text":"If you're installing the project for development, make sure you have development mode enabled, by running: composer development-enable You can disable development mode by running: composer development-disable You can check if you have development mode enabled by running: composer development-status","title":"Development mode"},{"location":"v1/installation/faq/","text":"Frequently Asked Questions How do I fix common permission issues? If running your project you encounter some permission issues, follow the below steps. Errors PHP Fatal error: Uncaught InvalidArgumentException: The directory \"/var/www/ example.local /html/data\" is not writable... PHP Fatal error: Uncaught InvalidArgumentException: The directory \"/var/www/ example.local /html/data/cache\" is not writable... Fix: chmod -R 777 data Error PHP Fatal error: Uncaught ErrorException: fopen(/var/www/ example.local /config/autoload/../../log/error-log- yyyy-mm-dd.log ): Failed to open stream: Permission denied... Fix: chmod -R 777 log","title":"FAQ"},{"location":"v1/installation/faq/#frequently-asked-questions","text":"","title":"Frequently Asked Questions"},{"location":"v1/installation/faq/#how-do-i-fix-common-permission-issues","text":"If running your project you encounter some permission issues, follow the below steps.","title":"How do I fix common permission issues?"},{"location":"v1/installation/getting-started/","text":"Clone the project Recommended development environment If you are using Windows as OS on your machine, you can use WSL2 as development environment. Read more on dotkernel.com . Using your terminal, navigate inside the directory you want to download the project files into. Make sure that the directory is empty before proceeding to the download process. Once there, run the following command: git clone https://github.com/dotkernel/light.git .","title":"Getting Started"},{"location":"v1/installation/getting-started/#clone-the-project","text":"","title":"Clone the project"},{"location":"v1/installation/getting-started/#recommended-development-environment","text":"If you are using Windows as OS on your machine, you can use WSL2 as development environment. Read more on dotkernel.com . Using your terminal, navigate inside the directory you want to download the project files into. Make sure that the directory is empty before proceeding to the download process. Once there, run the following command: git clone https://github.com/dotkernel/light.git .","title":"Recommended development environment"},{"location":"v1/installation/running-the-application/","text":"Running the application We recommend running your applications in WSL: make sure you have WSL installed on your system currently we provide a distro implementations for AlmaLinux9 install the application in a virtualhost as recommended by the chosen distro set $baseUrl in config/autoload/local.php to the address of the virtualhost run the application by opening the virtualhost address in your browser You should see the DotKernel Light welcome page. If you are getting exceptions or errors regarding some missing services, try running the following command: sudo php bin/clear-config-cache.php If data/cache/config-cache.php is present, that config will be loaded regardless of the ConfigAggregator::ENABLE_CACHE configuration in config/autoload/mezzio.global.php","title":"Running the Application"},{"location":"v1/installation/running-the-application/#running-the-application","text":"We recommend running your applications in WSL: make sure you have WSL installed on your system currently we provide a distro implementations for AlmaLinux9 install the application in a virtualhost as recommended by the chosen distro set $baseUrl in config/autoload/local.php to the address of the virtualhost run the application by opening the virtualhost address in your browser You should see the DotKernel Light welcome page. If you are getting exceptions or errors regarding some missing services, try running the following command: sudo php bin/clear-config-cache.php If data/cache/config-cache.php is present, that config will be loaded regardless of the ConfigAggregator::ENABLE_CACHE configuration in config/autoload/mezzio.global.php","title":"Running the application"},{"location":"v1/introduction/file-structure/","text":"File structure Dotkernel Light follows the PSR-4 standards. It is a good practice to standardize the file structure of projects. When using DotKernel Light, the following structure is installed by default: Main directories bin - various helper scripts config - various configuration files data - should contain project-related data log - storage of log files generated by dot-error-log library public - publicly visible files. The webserver need to have this folder as www-document root folder. src - should contain the source code files test - should contain the test files bin directory This directory contains one file, clear-config-cache.php which removes the config cache file ( data/cache/config-cache.php - available only when development mode is enabled). config directory This directory contains all application-related config files: config.php : here you will register ConfigProviders after installing packages container.php : main service container, providing access to all registered services development.config.php.dist : gets symlinked as development.config.php when enabling development mode - activates debug mode pipeline.php : contains a list of middlewares, in their order of execution twig-cs-fixer.php : configuration file for Twig code style checker/fixer autoload directory This directory contains all service-related local and global config files: app.global.php : sets the application name dependencies.global.php : config file to set global dependencies that should be accessible by all modules development.local.php.dist : gets symlinked as development.local.php when enabling development mode - activates error handlers error-handling.global.php : configures and activates error logs local.php.dist : local config file where you can overwrite application name and URL mezzio.global.php : Mezzio core config file templates.global.php : dotkernel/dot-twigrenderer config file data directory This directory is a storage for project data files and service caches. Inside you will find: cache : Twig's cache directory AVOID storing sensitive data on VCS. log directory This directory stores daily log files. When you access the application from the browser, (if not already created) a new log file gets created in the format specified in the config/autoload/error-handling.global.php config file under the stream array key. public directory This directory contains all publicly available assets and serves as the entry point of the application: css : contains app.css , a single file containing the entire CSS code collected from all modules, in a minified form fonts : contains app , a directory containing custom font files collected from all modules images : contains app , a directory containing all image files collected from all modules js : contains app.js , a single file containing the entire JavaScript code collected from all modules, in a minified form .htacess : server configuration file used by Apache web server - this file enables the URL rewrite functionality index.php : the application's main entry point robots.txt.dist : a sample robots.txt file, providing settings allow/deny bot access to certain areas of your application - activate it by duplicating the file as robots.txt and comment out the lines that don't match your environment src directory This directory contains two directories, called modules: App Page App directory This is the App module. It contains all generic functionalities your application depends on. The assets directory contains all generic assets, reusable across the application. The src contains ConfigProvider.php , a file that sets template path aliases ( getTemplates ) but can also provide dependencies ( getDependencies ). The templates : contains misc components like the home page, custom error pages, template partials and the default layout template. Page directory This is the Page module. It contains page-related components for your application. The src directory contains the following items: Controller : contains module controllers Factory : contains module factories, which are used to provide ready-to-use instances of certain classes Service : contains module service files, which contain classes that provide custom functionalities ConfigProvider.php - provides module configuration data RoutesDelegator.php - stored main routes found in the module The templates directory contains the page directory, with template files for various web pages. Special purpose directories .github - contains workflow files .laminas-ci - contains Laminas Continuous Integration (CI) workflow files","title":"File Structure"},{"location":"v1/introduction/file-structure/#file-structure","text":"Dotkernel Light follows the PSR-4 standards. It is a good practice to standardize the file structure of projects. When using DotKernel Light, the following structure is installed by default:","title":"File structure"},{"location":"v1/introduction/file-structure/#main-directories","text":"bin - various helper scripts config - various configuration files data - should contain project-related data log - storage of log files generated by dot-error-log library public - publicly visible files. The webserver need to have this folder as www-document root folder. src - should contain the source code files test - should contain the test files","title":"Main directories"},{"location":"v1/introduction/file-structure/#special-purpose-directories","text":".github - contains workflow files .laminas-ci - contains Laminas Continuous Integration (CI) workflow files","title":"Special purpose directories"},{"location":"v1/introduction/packages/","text":"Packages dotkernel/dot-controller - Provides base classes for action based controllers similar to Laminas controller component dotkernel/dot-errorhandler - Logging Error Handler for Middleware Applications dotkernel/dot-twigrenderer - DotKernel component providing twig extensions and customizations friendsofphp/proxy-manager-lts - Fork of ocramius/proxy-manager laminas/laminas-component-installer - Composer plugin for injecting modules and configuration providers into application configuration laminas/laminas-config-aggregator - Lightweight library for collecting and merging configuration from different sources mezzio/mezzio - PSR-15 Middleware Microframework mezzio/mezzio-fastroute - FastRoute integration for Mezzio","title":"Packages"},{"location":"v1/introduction/packages/#packages","text":"dotkernel/dot-controller - Provides base classes for action based controllers similar to Laminas controller component dotkernel/dot-errorhandler - Logging Error Handler for Middleware Applications dotkernel/dot-twigrenderer - DotKernel component providing twig extensions and customizations friendsofphp/proxy-manager-lts - Fork of ocramius/proxy-manager laminas/laminas-component-installer - Composer plugin for injecting modules and configuration providers into application configuration laminas/laminas-config-aggregator - Lightweight library for collecting and merging configuration from different sources mezzio/mezzio - PSR-15 Middleware Microframework mezzio/mezzio-fastroute - FastRoute integration for Mezzio","title":"Packages"},{"location":"v1/introduction/server-requirements/","text":"Server Requirements For production, we highly recommend a *nix based system. Webserver Apache >= 2.2 mod_rewrite .htaccess support (AllowOverride All) The repo contains in the public folder a default .htacess file NGINX you need to convert the provided Apache related .htaccess file into Nginx configuration instructions PHP >= 8.2 Both mod_php and FCGI (FPM) are supported. Required Settings and Modules & Extensions memory_limit >= 128M upload_max_filesize and post_max_size >= 100M (depending on your data) mbstring CLI SAPI (for Cron Jobs) Composer (added to $PATH) RDBMS MariaDB >= 10.11 LTS Recommended extensions opcache pdo_mysql or mysqli (if using MySQL or MariaDB as RDBMS) dom - if working with markup files structure (html, xml etc.) simplexml - working with xml files gd, exif - if working with images zlib, zip, bz2 - if compressing files curl (required if APIs are used) sqlite3 - for tests","title":"Server Requirements"},{"location":"v1/introduction/server-requirements/#server-requirements","text":"For production, we highly recommend a *nix based system.","title":"Server Requirements"},{"location":"v1/introduction/server-requirements/#webserver","text":"","title":"Webserver"},{"location":"v1/introduction/server-requirements/#php-82","text":"Both mod_php and FCGI (FPM) are supported.","title":"PHP >= 8.2"},{"location":"v1/introduction/server-requirements/#required-settings-and-modules-extensions","text":"memory_limit >= 128M upload_max_filesize and post_max_size >= 100M (depending on your data) mbstring CLI SAPI (for Cron Jobs) Composer (added to $PATH)","title":"Required Settings and Modules & Extensions"},{"location":"v1/introduction/server-requirements/#rdbms","text":"MariaDB >= 10.11 LTS","title":"RDBMS"},{"location":"v1/introduction/server-requirements/#recommended-extensions","text":"opcache pdo_mysql or mysqli (if using MySQL or MariaDB as RDBMS) dom - if working with markup files structure (html, xml etc.) simplexml - working with xml files gd, exif - if working with images zlib, zip, bz2 - if compressing files curl (required if APIs are used) sqlite3 - for tests","title":"Recommended extensions"}]} \ No newline at end of file diff --git a/v1/core-features/npm-commands/index.html b/v1/core-features/npm-commands/index.html index db8e2b3..5a84872 100644 --- a/v1/core-features/npm-commands/index.html +++ b/v1/core-features/npm-commands/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -425,54 +435,74 @@

    NPM Commands

     diff --git a/v1/installation/composer/index.html b/v1/installation/composer/index.html index 47e4788..96b0ddf 100644 --- a/v1/installation/composer/index.html +++ b/v1/installation/composer/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -446,54 +456,74 @@

    Install dependencies

     diff --git a/v1/installation/configuration-files/index.html b/v1/installation/configuration-files/index.html index 13e551e..253ca9d 100644 --- a/v1/installation/configuration-files/index.html +++ b/v1/installation/configuration-files/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -424,54 +434,74 @@

    Configuration Files

     diff --git a/v1/installation/development-mode/index.html b/v1/installation/development-mode/index.html index b46780d..fbf721f 100644 --- a/v1/installation/development-mode/index.html +++ b/v1/installation/development-mode/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -429,54 +439,74 @@

    Development mode

     diff --git a/v1/installation/faq/index.html b/v1/installation/faq/index.html index 8b0048b..898473f 100644 --- a/v1/installation/faq/index.html +++ b/v1/installation/faq/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -449,54 +459,74 @@

    Error

     diff --git a/v1/installation/getting-started/index.html b/v1/installation/getting-started/index.html index b6e6c4d..8f52333 100644 --- a/v1/installation/getting-started/index.html +++ b/v1/installation/getting-started/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -443,54 +453,74 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -439,54 +449,74 @@

    Running the application

     diff --git a/v1/introduction/file-structure/index.html b/v1/introduction/file-structure/index.html index 86c9c08..aaf0ce1 100644 --- a/v1/introduction/file-structure/index.html +++ b/v1/introduction/file-structure/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -526,54 +536,74 @@

    Special purpose directories

     diff --git a/v1/introduction/index.html b/v1/introduction/index.html index 1b4089e..b0d331a 100644 --- a/v1/introduction/index.html +++ b/v1/introduction/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -425,54 +435,74 @@

    Dotkernel light

     diff --git a/v1/introduction/packages/index.html b/v1/introduction/packages/index.html index 67aa512..8f5c078 100644 --- a/v1/introduction/packages/index.html +++ b/v1/introduction/packages/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -433,54 +443,74 @@

    Packages

     diff --git a/v1/introduction/server-requirements/index.html b/v1/introduction/server-requirements/index.html index 46d8b6a..55dd22b 100644 --- a/v1/introduction/server-requirements/index.html +++ b/v1/introduction/server-requirements/index.html @@ -79,6 +79,16 @@
    • +
  • + + DotKernel Logo +
    + Light + DotKernel Light application +
    +     +
    • +
  • DotKernel Logo @@ -412,11 +422,18 @@
    On this page

    Server Requirements

    For production, we highly recommend a *nix based system.

    Webserver

    +

    Apache >= 2.2

    +
    +

    The repo contains in the public folder a default .htacess file

    +
    +

    NGINX

    +

    PHP >= 8.2

    Both mod_php and FCGI (FPM) are supported.

    Required Settings and Modules & Extensions

    @@ -482,54 +499,74 @@