Configure a local WordPress development on macOS from scratch
So you are a macOS user and you want to configure a local environment to build a WordPress project. Great choice, it is a fantastic piece of software! There are plenty of tools that let you set it up in no time at no cost — MAMP / XAMPP and Local by FlyWheel are probably the best choices for beginners. Smashing Magazine published an article called “WordPress Local Development For Beginners: From Setup To Deployment” by Nick Schäferhoff which is a great guide that takes you through the journey when using these kinds of tools. There is one disadvantage though — applications like these hide lots of important details from the user and come pre-bundled with lots of stuff that you just don’t need to run a WordPress website.
My approach is a little bit more complicated but gives you enough knowledge about the environment to walk away confidently. An Apache HTTP server, MySQL database and PHP programming language is all that we need and, believe it or not, your Apple computer comes with the majority of these elements baked in.
Configure an Apache HTTP server and enable PHP #
The Apache HTTP Server and PHP language are already on your machine. You can confirm they are installed by checking the current version for each of them in the command line.
Before we run the server we need to make a tiny adjustment in its configuration file. To do so, feel free to use your favourite text editor such as
subl or my beloved
code. Superuser privileges (
sudo) will be needed.
sudo nano /etc/apache2/httpd.conf
This is the main Apache configuration file that contains tons of helpful comments about all the available directives. We need to proceed with a few tweaks here:
- Enable vhost
- Enable rewrites
- Enable PHP
- Change the default location for our projects
- Enable .htaccess
Enable vhost (Virtual Host) #
There is a chance that you are going to work on multiple WordPress projects in the future and it would be cool to access them via custom domains (i.e.
anotherone.localhost). Virtual Host is a term that describes exactly this functionality. To enable it uncomment
LoadModule vhost_alias_module libexec/apache2/mod_vhost_alias.so and
Include /private/etc/apache2/extra/httpd-vhosts.conf inside your Apache configuration file.
old: #LoadModule vhost_alias_module libexec/apache2/mod_vhost_alias.so new: LoadModule vhost_alias_module libexec/apache2/mod_vhost_alias.so
old: #Include /private/etc/apache2/extra/httpd-vhosts.conf new: Include /private/etc/apache2/extra/httpd-vhosts.conf
Enable rewrites #
By default mod_rewrite follows the filesystem path. For example the URL to a page about your company may end up being
mycompany.com/about.php. In the case of WordPress we will more likely see something like
mycompany.com/?p=1. Wouldn’t it be cool to simplify it to
mycompany.com/about? This is the reason why we need to explicitly enable it. Uncomment
LoadModule rewrite_module libexec/apache2/mod_rewrite.so.
old: #LoadModule rewrite_module libexec/apache2/mod_rewrite.so new: LoadModule rewrite_module libexec/apache2/mod_rewrite.so
Enable PHP #
WordPress is written in PHP. That being so our server surely needs to know how to deal with
.php files. It is as easy as uncommenting
LoadModule php7_module libexec/apache2/libphp7.so.
old: #LoadModule php7_module libexec/apache2/libphp7.so new: LoadModule php7_module libexec/apache2/libphp7.so
Change the default location for our projects #
Personally I store the source files to all websites that I am working on inside a
Sites folder in my home directory. It is not a requirement, just a convention. The default root directory for the Apache server is
/Library/WebServer/Documents. We have to amend this path. Please, be sure to change the name of your username folder — the chances that your directory is called
pawelgrzybek are slim!
old: DocumentRoot "/Library/WebServer/Documents" old: <Directory "/Library/WebServer/Documents"> new: DocumentRoot "/Users/pawelgrzybek/Sites/" new: <Directory "/Users/pawelgrzybek/Sites/">
Enable .htaccess #
To easily change the server configuration on a per-directory basis, Apache uses
.htaccess files. The
AllowOverride controls section of the configuration file allows us to enable the use of .htaccess files. Edit the value of
All. We are done here!
old: AllowOverride None new: AllowOverride All
Manage local domains using vhost #
Do you remember vhost (Virtual Host) that we enabled second ago? We have to configure that in a way that our
localhost serves files from
~/Sites/wp.localhost. We need to add a custom configuration to its configuration file that is located under
/etc/apache2/extra/httpd-vhosts.conf. Open this file via the text editor of your choice.
sudo nano /etc/apache2/extra/httpd-vhosts.conf
This file comes with some example configuration that we don’t need. Feel free to comment it out or delete it. Add a configuration blocks that look like this (make sure that you have amended the paths accordingly to your username and domain):
<VirtualHost *:80> DocumentRoot "/Users/pawelgrzybek/Sites" ServerName localhost ErrorLog "/var/log/apache2/localhost-error_log" </VirtualHost> <VirtualHost *:80> DocumentRoot "/Users/pawelgrzybek/Sites/wp.localhost" ServerName wp.localhost ErrorLog "/var/log/apache2/wp.localhost-error_log" </VirtualHost>
DocumentRoot tells Apache which directory the domain specified under the
ServerName should be pointing to. The
ErrorLog enables any error log files for this website (this may be helpful for debugging in the future). If you need to set up extra domains, simply duplicate one of those blocks and amend domain and path accordingly.
Start, stop, restart and test apache server config #
I know it is a little bit daunting but I promise that we’ll never come back to this nasty lengthy configuration file again. Four simple commands are everything that we need to remember from now on. Start, stop, restart and configuration test.
sudo apachectl start sudo apachectl stop sudo apachectl restart sudo apachectl configtest
Hopefully the commands are self-explanatory. Please bare in mind that every single change of the Apache configuration files require rebooting of the server. A good practice is to run a sanity check beforehand by executing
sudo apachectl configtest. If you get
Syntax OK feel free to run the server using
sudo apachectl start.
Test time! Now let’s create a test
index.php file in the
~/Sites as we specified in vhost config file. Put a
<?php phpinfo(); in there please. If you followed my previous instructions carefully, this is what you should see under http://localhost/.
Point localhost domains to 127.0.0.1 #
Every time when you visit a website your browser asks a DNS server for the IP address to redirect the request to. DNS server is like a massive phone book that maps domain names to IP numbers.
My convention is to use
.localhost as a domain suffix for locally stored websites. We don’t want those domains to go to the DNS Server to ask for an IP number because we already know it – it is the IP of our own computer —
127.0.0.1 (“localhost” in other words). A
hosts file helps us with it — you can think of it as a local DNS directory. Add
127.0.0.1 *.localhost to this file — it is located under
sudo nano /etc/hosts
MySQL to store data, Sequel Pro to manage it #
WordPress’ mission is to edit and serve content stored in a database which is the last missing piece of our setup. In order to download the database software and a great GUI (graphical user interface) for it, we are going to use Homebrew — the missing package manager for macOS. If you are not a Homebrew user, please follow the installation steps from the website and take my word that it is going to make your life much easier in the future. I published “Homebrew — the best friend of the macOS user” where I elaborate more about benefits of using it.
brew install mysql
brew cask install sequel-pro
MySQL has been installed and
root user with blank password has been added. Since version 8 it uses a different method of password encoding. To make our life easier we should change this encoding for our pre-created user. Log into MySQL shell using
mysql -u root, change a password encoding using
ALTER USER 'root'@'localhost' IDENTIFIED WITH mysql_native_password BY ''; and exit shell using
Now you have everything that you need. Run a
mysql.server start command to initialise a MySQL daemon and launch Sequel Pro app to create the first database that we are going to use on our website later on. On the initial screen use a descriptive name for your connection,
127.0.0.1 as a host,
root as a username, keep the password blank and hit the “Connect” button.
Are you in? From the dropdown in the top-left corner pick “Add database…”, give it a meaningful name (I always follow the convention:
localhost_nameofawebsite), confirm and you are done.
Build a WordPress website via WP-CLI #
If you are working a lot with WordPress but you don’t use the Command line interface for WordPress you need to re-evaluate your workflow. Seriously! There is no other way to save yourself more time than this. If you don’t have it yet, install it via
brew (I told you second ago that the Homebrew is amazing).
brew install wp-cli
Time to build out a new website! Let’s call it
wp.localhost. It was common practice to use
.dev as a development domain but a few browser vendors made this a little bit more complicated by requiring an SSL certificate for all
.dev domains. To avoid the additional steps required to configure it, change your habits and use
mkdir ~/Sites/wp.localhost && cd ~/Sites/wp.localhost
wp core download
wp config create --dbname=NAME_OF_YOUR_DATABASE --dbuser=root --dbpass= --dbhost=127.0.0.1
These few lines create a folder
wp.localhost inside a
Sites directory, download all the WordPress core files into it, creates a
wp-config.php file and fills all the necessary details for you. Nice, isn’t it? Time to check if everything is working as expected.
Helpful tip #
As a front end developer, the majority of the time I use some node-based servers for my local environment. I rarely build WordPress projects so there is no need for me to keep Apache and MySQL always running in a background. I created two quick bash aliases that enable / disable those tools for me in a blink of an eye. If you like my approach, add it to your
# start / stop Apache & MySQL alias am-start="sudo apachectl start && mysql.server start" alias am-stop="sudo apachectl stop && mysql.server stop"
Enjoy WordPressing #
Voilà! We ended up with a robust local environment for your WordPress development. You can easily run other frameworks like Laravel on this setup with ease. I hope that you found this article helpful.
I almost forgot! Thanks a ton for proofreading to Marcin Krzemiński who gave me lots of great advices how to make this article better. I highly advice this dude for any WordPress related stuff — he knows his craft!
Until next time!