Vanilla has only 1 supported localhost installation configuration, Vanilla Docker.
Vanilla Docker is a self-container docker-compose setup providing:
- Local SSO & Embedding Stubs
brew install composer
composer self-update --1
Setting up Vanilla Docker
Clone relevant repositories
Create a directory where you will clone all of your vanilla repositories and make sure this directory is shared in the docker desktop settings.
Your user directory is generally shared so this is a good place to put it.
In this guide we will use the directory
In this scenario the entire contents of the ~/vnla directory will be synchronized into the docker containers. Having an excessive amount of contents here can slow things down so it is recommended that you only put things needed to run vanilla into this directory.
Run the macOS setup script
Run the following setup script.
Symlink the docker config
ln -s ../../vanilla-docker/bootstrap.before.php
Installing Dependencies & Building
The next step is to install composer dependencies & node_modules, then build the frontend.
# Add This to you config.php
# $Configuration['HotReload']['Enabled'] = true;
# The run this
This is how you will start the docker containers.
docker compose up --build -d
To shut down the containers in the future run this:
docker compose down
Go to your site.
- Finish filling out the form.
- Submit the form.
- See your new site.
Install Cloud Addons
For vanilla employees only.
Run the following:
# Symlink cloud addons
# Install dependencies and rebuild frontend