Deploy Plugin
A simple way to deploy your application to a remote location.
Currently in Active Development
This plugin is incomplete. This plugin is not ready for use. Please do not contact us about this. Please wait for the first release. Thanks
Why is This Plugin Needed?
This plugin helps in cases where your remote server (production, staging, etc) does not have the ability to run the standard deployment workflow, either due to lack of computational resources or lack of service by the hosting provider. An example of this is shared hosting, where shell access is limited or composer does not have enough memory to execute.
How It Works
Before starting, you should have set up a new site in your hosting manager and ideally have an empty database. You may also apply these instructions to an existing website, including legacy versions of October CMS, however, please make sure you have taken a complete backup in case something goes wrong.
Control Panel Setup
After installing this plugin, navigate to the Settings > Deploy in your October CMS control panel and click Create Server.
- Enter the web address for your site (eg: https://mycpanelwebsite.tld/)
- Generate a new RSA private key, or enter an existing one to set up an existing server
- Download the Beacon ZIP files
Beacon Deployment
In your Beacon ZIP file, you should notice the following files:
- index.php
- bootstrap/app.php
- bootstrap/autoload.php
- bootstrap/beacon.php
You can upload these files anywhere and they will become a target for deployment of October CMS. You can use FTP or the file manager in your hosting control panel.
Important: The directory where the files are uploaded must be writable by your web server (eg: permission 777 for apache).
Run Your First Deployment
Once you have the Beacon installed remotely and the server set up locally. It's time to perform your first deployment.
License
This plugin is an official extension of the October CMS platform and is free to use if you have a platform license. See EULA license for more details.