Deploy October CMS project to a private or shared server.

When deploying a site to production, make sure that you have implemented the recommended production configuration.

October CMS projects can be deployed using Composer with command line (shell) access, and the official Deploy plugin when shell access is limited.

# Deploying with Composer

That scenario applies if you have SSH access and have Composer installed on the target server. Deploying October CMS projects with Composer is the same as deploying any other Composer project:

  • clone the project repository on the server.
  • copy the auth.json file manually to the server.
  • run composer install in the project directory.
  • update the configuration files.

Keep in mind that the Composer's auth.json (opens new window) file from your source October CMS installation must be added to the server. The file is automatically generated when you install October CMS for the first time. It includes the license key information and is required for authenticating Composer requests to the October CMS Gateway.

Alternatively, you can recreate the auth.json file with the project:set artisan command before running composer install.

php artisan project:set <license key>

# Deploying without Composer

If you don't have SSH access to the server or can't run Composer commands for any reason, there is an option to deploy an October CMS project using the official Deploy Plugin.

Deploy Tutorial

This video describes how to deploy your project to a remote server without Composer.

Watch the tutorial

This Deploy plugin uses a local installation of October CMS to run composer commands on your own computer. The locally generated files are deployed to your server based on this installation. From there, October CMS has a one-click updater that can be used to update the installation directly on the server. If the one-click update fails, the deploy plugin can be used to repair an installation without command line access.

# See Also