Higher Logic Vanilla (Vanilla) only has one supported localhost installation configuration that is included as part of the main repository.
Vanilla Docker
Vanilla Docker is a self-contained, docker-compose setup providing:
- PHP
- MySQL
- Nginx
- Memcached
- Sphinx
- XDebug
- Local SSO & Embedding Stubs
Prerequisites
Set up Vanilla Docker
Clone relevant repositories
Create a directory where you will clone all of your Vanilla repositories. Make sure this directory is shared in the Docker desktop settings.
- Your user directory is typically shared, making it an ideal location to put it.
In this guide, we will use the directory ~/vnla.
- Clone the repository into this directory. It MUST be in the path ~/vnla/vanilla.
- Vanilla staff should clone the repository instead, but ensure that the directory it is cloned into is called vanilla.
- Vanilla staff should run the following script after cloning.
./cloud/scripts/symlink-addons.
Important notes
In this scenario, the entire contents of the ~/vnla directory will be synchronized into the docker containers. Having an excessive amount of content here can slow things down, so it's recommended to only put content needed to run Vanilla into this directory.
Installing Dependencies & Building
The next step is to install composer dependencies & node_modules, and then build the frontend.
composer install
The first time you run this, it may take a while. Subsequent runs should be faster.
Installing The CLI
~/vnla/vanilla/cli/bin/vnla install
Starting/stopping Docker
This is how you will start the Docker containers.
vnla docker up
To shut down the containers in the future, run this:
vnla docker down
Create Your Site
vnla spawn-site
Note
The front end might need to be rebuilt for certain assets to show properly.
composer install
yarn install
vnla build
Troubleshooting
sometimes clearing the cache might be necessary
vnla clear-caches
Install Cloud addons
For vanilla employees only.
Run the following:
~/vnla/vanilla
# Symlink cloud addons
./cloud/scripts/symlink-addons
# Install dependencies and rebuild frontend
composer install
Developer build
If you're constantly updating the JavaScript or CSS or addons or themes, it's recommended to use the developer build. This keeps the build in memory and has fast rebuilds of changes.
To enable dev build, run the following
vnla build —-dev
