An OctoberCMS plugin that adds CLI commands to list and deploy servers managed by the RainLab Deploy plugin.
- OctoberCMS 4.x
- RainLab.Deploy plugin installed and configured
- At least one server added and beacon installed via RainLab Deploy → Servers → Manage
- Copy the
dilexus/deploydirectory into yourplugins/folder. - Run migrations:
php artisan october:migrateLists all servers registered in RainLab Deploy.
# List active and ready servers
php artisan deploy:list
# Include unreachable/legacy servers
php artisan deploy:list --all
# Output as JSON
php artisan deploy:list --jsonExample output:
+----+-------------------+----------------------------+--------+---------+---------------+
| ID | Name | URL | Status | Version | Last Deploy |
+----+-------------------+----------------------------+--------+---------+---------------+
| 1 | Production Server | https://app.example.com/ | active | 4.1.14 | 2 hours ago |
+----+-------------------+----------------------------+--------+---------+---------------+
Deploys a server by running october:migrate and clear_cache via the RainLab beacon.
# Deploy by URL
php artisan deploy:run https://app.example.com/
# Deploy by name (partial match)
php artisan deploy:run --name="Production"
# Interactive selection (prompts you to pick a server)
php artisan deploy:run
# Deploy all active servers without confirmation
php artisan deploy:run --all --force
# Preview without actually deploying
php artisan deploy:run --dry-run| Option | Description |
|---|---|
url |
Server endpoint URL (as registered in RainLab Deploy) |
--name |
Match server by name (partial) |
--all |
Deploy all active/ready servers |
--force |
Skip the confirmation prompt |
--dry-run |
Print what would be deployed without executing |
- Connects to the server via its RainLab Deploy beacon
- Runs
php artisan october:migrateon the remote server - Runs the
clear_cachescript on the remote server - Updates
last_deploy_atandlast_versionon the server record
| Permission | Description |
|---|---|
dilexus.deploy.servers |
Manage servers in the backend |
dilexus.deploy.logs |
View deployment logs |
The plugin adds a Deploy section to the backend sidebar with:
- Servers — view servers (mirrors RainLab Deploy data)
- Deploy Logs — history of deployments triggered from this plugin
- This plugin does not replace RainLab Deploy. It wraps its beacon API for CLI use.
- Servers must have a working beacon endpoint (configured via RainLab Deploy) for
deploy:runto succeed. - The
statusshown indeploy:listreflects the RainLab Deploy beacon status check, not the result of the lastdeploy:run.