Installation

Installation

Learn how to install October CMS on a server.

Installation Tutorial

This video describes how to create a project, purchase a license and install October CMS for the first time.

Watch the tutorial

# Minimum System Requirements

Before installing October CMS, ensure the target system meets the minimum requirements:

  • PHP version 8.0.0 or higher
  • Composer 2.0 or higher
  • PDO PHP Extension
  • cURL PHP Extension
  • OpenSSL PHP Extension
  • Mbstring PHP Extension
  • ZipArchive PHP Extension
  • GD PHP Extension
  • SimpleXML PHP Extension.

Supported database servers:

  • MySQL 5.7 or MariaDB 10.2. For older versions of MySQL or MariaDB, you may need to configure the index lengths to support the utf8mb4 character set.
  • PostgreSQL 9.6
  • SQLite 3.8.8.

Supported web servers:

  • Apache
  • Nginx
  • Lighttpd
  • Microsoft IIS

# Installing October CMS

You should configure a virtual host on the web server to access the installation directory. For local development you can use Laravel Sail, Valet (opens new window), Laragon (opens new window) or the built-in Laravel development server.

October CMS is a PHP web application that uses Composer (opens new window) to manage its dependencies. Ensure that Composer is installed before you begin. The License Key (opens new window) will be required to complete the installation.

To install the platform, initialize a project using the create-project command in the terminal. The following command creates a new project in a directory called myoctober:

composer create-project october/october myoctober

When the command finishes, enter the project directory:

cd myoctober

Run the installation command:

php artisan october:install

The last step is the migration command that will initialize the database. Alternatively, October CMS can initialize the database when you first access the backend panel.

php artisan october:migrate

When the process finishes, you can access the backend panel in a browser and create the administrator user profile. If you are using the built-in web server, you can launch it with the following command:

php artisan serve

If you are installing the platform on a production web server, review the recommendations listed in the Production Configuration article.

# Bleeding Edge Updates

To receive bleeding edge updates of October CMS, target the develop branch in the composer.json file:

"october/all": "dev-develop",
"october/rain": "dev-develop",

The develop branch includes updates that are not released in the stable channel yet. There can be the latest bug fixes and features, but at the same time, it can contain unfinished work. Enabling bleeding edge updates is not recommended for production environments.

The dev-develop notation may also apply to some plugins and themes.

# Troubleshooting Installation

Several typical issues can occur during or after installation.

The installation freezes after entering the license key

It can happen in some environments when pasting the license key contents. Press the ENTER key several times to allow the installation process to continue.

An error "Specified key was too long" is displayed during migration

It can happen with older versions of MySQL or MariaDB. Configuring the index lengths to support the utf8mb4 character set can help to resolve this issue.

A blank screen is displayed when opening the application

Check the permissions are set correctly on the /storage files and subdirectories. They must be writable for the web server.

The backend panel displays "Page not found" (404)

If the application cannot find the database then a 404 page will be shown for the back-end. Try enabling debug mode to see the underlying error message.

An error 500 is displayed when updating the application

The request timeout on the web server should be increased or disabled. For example, Apache's FastCGI sometimes has the -idle-timeout option set to 30 seconds.

# See Also