Version 2.3.6 (05.11.2018)
Created by wpdistillery.org
I’m putting a lot of time into maintaining WPDistillery. So if you like it, please consider supporting it:
What is WPDistillery
WP Distillery does all the work for you when setting up a new WordPress project with Scotch Box. Simply add your preferred theme, plugins, and options into
config.yml and you're good to go! With WPDistillery it won't take longer than 5 minutes until you can start working on your new WordPress project.
One simple command will:
- Install Scotch Box
- Install and update requirements on the local webserver
- Download, install, and configure WordPress
- Set WordPress options
- Install and activate your favorite WordPress theme (default: WPSeed)
- Remove default themes
- Install and activate the plugins defined in the config files
- Clean the contents, plugins, unused files, and other Wordpress defaults
You're able to adjust which of the above tasks will be executed. Simply set the desired tasks to
false in the Setup Options section at the bottom of
config.yml. All you need to do after customizing your config file is
vagrant up. That's it! With that one single command WPDistillery will:
- SSH to the VM
- Update WP-CLI
- Install and configure everything
It also comes with an optional auto-update function and integrated support for Windows. Check out the Changelog for a complete list of changes.
WPDistillery is fully compatible with Scotchbox 3.0
- ScotchBox (using Vagrant & Virtualbox)
- Vagrant Hostsupdater (
vagrant plugin install vagrant-hostsupdater)
To setup a new project running Scotch Box and WordPress, simply follow these steps:
- In a terminal, run:
git clone https://github.com/flurinduerst/WPDistillery.git my-project
wpdistillery/config.ymlto suit your needs. See configuration file documentation.
- Inside the
Vagrantfileadd your local URL at
config.vm.hostname. This should be the same as
vagrant upfrom where your
Done! You can now access your project at the local URL (for example
yoursite.vm) defined in Step 3. (or at http://192.168.33.10/)
Note: Currently there's an issue related to ScotchBox that hinders Vagrant from mounting VirtualBox Shared folders. The solution is to install vagrant-vbguest before running vagrant. This will install the correct vbguest package into the box:
vagrant plugin install vagrant-vbguest vagrant vbguest
Windows users may wish to
vagrant plugin install vagrant-winnfsd before
vagrant up for a moderate speed increase on sites with a lot of files. WPDistillery will detect WinNFSd support if needed. See Vagrant WinNFSd for more information.
WPDistillery with WP-Multisite
Auto Update WordPress and Plugins
If you want to automatically update WordPress and all Plugins on every
vagrant up you can remove the comment character at line 26 inside the Vagrantfile.
Using Windows? No Problem! WPDistillery will detect if you're using Windows and if so, automatically convert all files using dos2unix.
Basic Vagrant Commands
vagrant upwill start the machine. The first ever
vagrant upin your project will also install Scotch Box and execute provisioning.
vagrant provisionwill execute provisioning. This is where WPDistillery runs its core function which is installing and configuring WordPress according to
config.yml. Before that, it will also update WP-CLI and set the upload size to 64MB. Normally
vagrant provisionshould not be executed manually but can be used to re-run the WPDistillery setup in case you want to re-install WordPress.
vagrant reloadwill restart Vagrant. This is required for changes made in the
Vagrantfileto take effect.
vagrant haltwill shut down the virtual machine.
vagrant destroywill destroy all the resources related to the current virtual machine. This action is not reversable.
More informations can be found at vagrantup.com.
Something went wrong within the WPDistillery setup. I'd like to restart the setup:
- Fix your setting (probably in
- Remove all tables from the
- Remove the
vagrant reload --provision
- Author: Flurin Dürst | Twitter
- Fork it
- Create your feature branch
- Commit your changes
- Push to the branch
- Create new a Pull Request
Feel free to contact me if you have questions or need any advice.
WPDistillery is released under the MIT Public License.
Note: The "About" section in
README.md and the author (
@author) notice in the file-headers shall not be edited or deleted without permission. For details, please see License.