awyiss / project
Awyiss starter project
Requires
- php: >=8.4
- awyiss/awyiss: ^0.3
Requires (Dev)
- awyiss/phpcs-sniffs: ^0.5.0
- cakephp/cakephp-codesniffer: ^5.3.2
- cakephp/debug_kit: ^5.2.4
- squizlabs/php_codesniffer: ^4.0
README
Starter project for Awyiss CMS, built on top of the CakePHP framework.
Requirements
- PHP 8.4 or higher
- MySQL 5.7+ or MariaDB 10.3+
- Composer
- Web server (Apache or Nginx) with URL rewriting enabled and rights to create symlinks
- Shell access with PHP CLI
- Cronjob support (often & long-running)
- Imagick or GD PHP extension (for image manipulation)
- FileInfo PHP extension
- Intl PHP extension
Installation
Tip
It's recommended to run the command as the web server user to ensure proper file permissions,
for example using sudo runuser -u <username> -- <command> on Debian-based systems.
Create a new project with Composer:
composer create-project awyiss/project your-project-name
This installs Awyiss along with its dependencies and then automatically runs the Awyiss installer, which will ask you for:
- Customer name – unique identifier for your project, used as the default namespace for plugins and themes
- Database credentials – leave empty to skip database setup
- Admin username
- Admin password – leave empty to generate a random one
- Environment (
developmentby default) – setsCONFIG_ENVin your.envfile
Important
Passwords are visible when typed in the terminal. Don't use sensitive passwords if others can see your terminal.
Forgot your admin password? Reset it with:
bin/cake awyiss reset_password
Configure your Web Server
Point your web server to the webroot directory and set up the cronjobs:
*/10 * * * * cd /var/www/ && bin/cake queue run -q -g general >> /var/www/logs/cron.log 2>&1 */1 * * * * cd /var/www/ && bin/cake media convert_files --include-avif --include-webp -q
Important
Only include --include-avif / --include-webp if your server can handle these formats. Check with:
bin/cake media detect_available_commands
Once configured, access the Backend at http://your-domain.com/backend with the credentials from the installer.
Documentation
More detailed documentation is available in the official documentation.
License
Awyiss is licensed under the MIT License.
See the LICENSE file for details.
Support
For support inquiries, please contact awyiss@2f.media.
© 2025-2026 Awyiss CMS. All rights reserved.
