Basic Stack Requirements

The basic stack requirements for running UserFrosting are pretty typical of any web framework or CMS. Those requirements are the software required to run UserFrosting, usually on a "server". These are different from the developer tools used to build your website which we'll see on the next page.

To run UserFrosting, you'll need four things :

  1. Web Server Software Requirements
  2. PHP Requirements
  3. Database
  4. SMTP (Mail) Server

If you're already using or plan on using Docker, all of the necessary stack will already be configured for you. However, it's important to understand what is required to run UserFrosting, so you can understand the services Docker provides for you!

Web Server Software Requirements

To run any website, you need web server software. Its tasks are to receive client requests, execute them, and send a reply. For a PHP website, the web server software won't execute the PHP code itself. Instead, it passes it to PHP which interprets the code and returns a response for the web server to display.

The most popular web servers today are :

Any of these can be used to run UserFrosting. However, when developing locally (on your computer), it's also possible to use PHP's built-in web server. This option isn't suited for production websites (for people on the internet to access), but it's a perfectly viable option when testing your application. The biggest benefit is you don't have to install anything else if you already have PHP installed!

PHP Requirements

You're probably here because you already know what PHP is. Great! The only thing left to say is UserFrosting requires PHP 8.0 or higher. However, it's highly recommended you use the latest supported version, which is PHP 8.2.

But my host only supports PHP 7.x! Why do I need PHP 8.0?

Look, programming languages evolve, and PHP is no exception. Actually, PHP and other web languages have it particularly tough because they have so many responsibilities. PHP is the bouncer at the door: it has to be prepared to defend against constantly evolving security threats to your server. At the same time, it has to keep up with demand for faster performance, and satisfy the demand for new features from the enormous PHP community.

Honestly, PHP 8.0 isn't exactly cutting edge - in fact, PHP 8.0 was no longer in active support as of November 26th, 2022 and was declared "End of Life" as of November 26th, 2023.

In fact, we didn't make this decision directly. UserFrosting depends on a lot of third-party components, and those components require a minimum PHP version of 8.0. As the whole community moves forward, UserFrosting does too. And fast! PHP 8.2 will only be supported until December 8th, 2024 !

If your hosting service doesn't have PHP 8 installed, call them and ask them to upgrade. If they refuse, point out that PHP 7.4 has been out of life for 0 months! To be honest, there is little reason to use a shared hosting (e.g. cPanel) service these days, especially when VPS providers like DigitalOcean and Amazon EC2 are so inexpensive. Unless you're stuck with shared hosting for some reason or another (fussy boss), there's no real reason not to switch to a VPS.

As for your local development environment (You do have a local development environment, right ?), if it's that much of a burden then... I don't know what to tell you. So what are you waiting for? Upgrade!

As a reminder, as of UserFrosting 5.0, PHP 8.2 is officially recommended. While you can still use UserFrosting 5 with PHP 8.0 and 8.1, upgrading to PHP 8.2 is highly recommended. Both PHP 8.0 and 8.1 support will eventually be removed the future.

PHP Extensions

UserFrosting and its dependencies requires some PHP Libraries and Extensions to be installed and enabled :

Occasionally, people use web hosting services that do not provide the GD library, or provide it but do not have it enabled. The GD library is an image processing module for PHP. UserFrosting uses it to generate the captcha code for new account registration. The DOM and ZIP extensions are used by Composer.

Database

To store data, UserFrosting requires a relational database provider. UserFrosting support the following database providers:

MariaDB is an open-source fork of MySQL. The reason it exists is because of numerous concerns that Oracle would not do a good job honoring the open-source nature of the MySQL community. For all technical purposes, MariaDB and MySQL are more or less perfectly interoperable.

Support for SQL Server on Windows is experimental. Contact the UserFrosting team if you want to help improve support for SQL Server !

MySQL and MariaDB are the most popular choice of database provider. However, when developing locally, you can skip installing additional software by using SQLite as your database provider. SQLite support is built-in to PHP and the data is stored as a file within the UserFrosting directory structure. This option isn't suited for production websites as it's slower than other solutions, but it's perfectly viable when testing your application locally.

It is not required to develop with the same database provider as the one you'll be using in production. It's totally fine to develop locally using SQLite and use MySQL on your production server. A testing environment can be used to make sure your code runs smoothly on both.

SMTP (Mail) Server

The final piece of software required on your server is an SMTP Server. The Simple Mail Transfer Protocol (SMTP) is an application used by mail servers to send, receive, and relay outgoing email between senders and receivers. UserFrosting requires you provide a SMTP server for sending email to your users (especially registration emails).

Again, when developing locally it's possible to use third-party services and applications to handle emails, like Mailpit, Mailtrap, or even Gmail. However, keep in mind a complete SMTP server is required in production.