Learn how to install October CMS on a server.
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:
- 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:
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.
# Wizard Installation
The wizard installation is an alternative way to install October CMS without using Composer. It is simpler than the command-line installation and doesn't require any special skills.
- Prepare a directory on your server that is empty. It can be a sub-directory, domain root or a sub-domain.
- Download the installer archive file (opens new window).
- Unpack the installer archive to the prepared directory.
- Grant writing permissions on the installation directory and all its subdirectories and files.
- Navigate to the
install.phpscript in your web browser.
- Follow the installation instructions.
# Bleeding Edge Updates
To receive bleeding edge updates of October CMS, target the
develop branch in the composer.json file. For example:
"october/all": "dev-develop", "october/rain": "dev-develop",
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.
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 "Unable to get local issuer certificate" is displayed during installation
The complete error may read
cURL error 60: SSL certificate problem: unable to get local issuer certificate.
Download this certificate file (opens new window) and save it as
cacert.pem. Open your php.ini file and insert or edit the following line. You may need to restart Apache for the changes to take effect.
curl.cainfo = "/path/to/cacert.pem"
An error "Specified key was too long" is displayed during migration
The complete error may read
SQLSTATE: Syntax error or access violation: 1071 Specified key was too long; max key length is 767 bytes
This 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.
Invalid security token error when logging in
Check to ensure no missing subdirectories in the storage/framework path. You may need to add the sessions, cache and views directories (opens new window).
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.
Zend OPcache API is restricted by "restrict_api" configuration directive
This issue can appear when internals try to use the OPcache internals. This can be disabled by setting the force_bytecode_invalidation configuration to
false inside the config/cms.php file.