Prerequisites
Required software
Brezel requires:
- PHP 7.4 (with PHP-FPM)
- MySQL 8+ or MariaDB 10.5.2+
- a web server (nginx/Apache)
Brezel SPA requires Node 18+ to build.
Additional software
These are tools that are needed to use the full functionality of brezel.
Ghostscript
This tool is used to merge PDF files. It needs to be installed in your path to be accessible by brezel-api.
Imagick
This tool creates thumbnails for images and pdf files.
The process to install it will differ from platform to platform.
If possible you can install it directly as a PECL
extension.
Windows
- Go to pecl.php.net/package/imagick.
- Choose the newest version and click on “DLL”.
- Download the version appropriate for your System. (Mostly Php 7.4, non-thread-safe, x64)
- Extract the file somewhere safe and copy
php_imagick.dll
into your php extension folder. (<path/to/php/installation>/ext
) - Add the path where you extracted the extension into to your PATH. (e.g. C:/php_imagick-3.7.0)
- Add
extension=imagick
to the extension section of your php.ini
Node and PHP
Linux
Install PHP 7.4, MySQL and Node.js:
sudo add-apt-repository ppa:ondrej/phpsudo apt updatesudo apt install php7.4sudo apt install php7.4-common php7.4-mbstring php7.4-xml php7.4-zip php7.4-curl php7.4-bcmath php7.4-mysql php7.4-gd php7.4-cli php7.4-imap php7.1-mcryptsudo apt install mysql-serversudo apt-get install -y nodejssudo ln -s `which nodejs` /usr/bin/nodesudo apt install npm
valet
macOS
Install Valet: https://laravel.com/docs/8.x/valet#installation
Make sure to install php@7.4
instead of php
.
Linux
Install valet-linux (if a system does not answer after that, try to reinstall valet):
sudo apt-get install network-manager libnss3-tools jq xselcomposer global require cpriego/valet-linuxsudo service apache2 stopvalet install
Serve on Windows
- Have git installed
- Install php somewhere (e.g.
C:/php
). - Install a up-to-date Node.js version. (See requirements at the top)
- Install a database. (See requirements at the top)
Make sure that you have Powershell 7 installed and available with the pwsh
command.
You also need to have the Windows Terminal installed, but this should come standard with current Windows versions.
You can now run <Path to your Brezel Project>\bin\serve_on_windows.ps1
.