Installing October CMS with DDEV

Tutorial

On this page

DDEV is a Docker-based tool that provisions the web server, PHP and database for a local development environment in isolated containers. It is a good choice when you don't want to install PHP and Composer on your operating system. This article creates a new October CMS project with DDEV and opens it in the browser in a few commands.

Before You Begin

Install Docker and DDEV before you begin.

Tip: Since the web server runs inside a container, commands are called using ddev artisan and ddev composer instead of php artisan and composer.

Create the Project Directory

Create a directory for the project and enter it. The directory name becomes the project name and local site address.

mkdir myoctober && cd myoctober

Configure DDEV

Configure the environment using the Laravel project type, which October CMS is compatible with.

ddev config --project-type=laravel --webserver-type=apache-fpm

With the Laravel project type, DDEV creates or updates the .env file with the database connection details for its database container, so there is no database to configure by hand.

Start the Containers

Start the environment. The first run may take a few minutes while the images are downloaded.

ddev start

Install October CMS

Install October CMS in the project directory.

ddev composer create-project october/october

Run the installation command.

ddev artisan october:install --no-interaction

In non-interactive mode the installer uses the database settings DDEV wrote to the .env file. It migrates the database, migrates Tailor and seeds the demo theme, without asking any questions.

Tip: The non-interactive install doesn't ask for a license key, so you can explore October CMS locally straight away. To unlock updates and marketplace access, add your License Key later with ddev artisan project:set <license key>.

Open the Website

Open the website in a browser.

ddev launch

Your site is now running. Add /admin to the URL to access the admin panel and create your first administrator account. For a project directory named myoctober, the address is:

https://myoctober.ddev.site/admin

See Also

Was this article helpful?

comments powered by Disqus
Still need help?
October Forum

Community members share experiences, ask questions and exchange tips.

Discord

Talk with other October CMS developers in real time.

Custom Development

Hire the October CMS team to work on your website.

Contact Us

For bug reports and help with this website. See the roadmap or submit an idea on the Portal.