Setup
Features
API

OctoberCMS

Setup guide to install and configure 1Pilot client on OctoberCMS

Installation

Setup for OctoberCMS 3

  1. Run following commands to install 1Pilot client:
php artisan plugin:install OnePilot.Client
  1. Once installed, go to Settings, then 1Pilot Settings and copy the generated private key
  2. Go to your 1Pilot Dashboard and click add new site
  3. Fill out the required fields and paste the private key

Setup for OctoberCMS 2

  1. Run the following commands to install 1Pilot client:
php artisan plugin:install OnePilot.Client
php artisan october:migrate
  1. Once installed, go to Settings, then 1Pilot Settings and copy the generated private key
  2. Go to your 1Pilot Dashboard and click add new site
  3. Fill out the required fields and paste the private key

Setup for OctoberCMS 1

  1. Install the "1Pilot remote manager" plugin on your website
  2. Once installed, go to Settings, then 1Pilot Settings and copy the private key
  3. Go to your 1Pilot Dashboard and click add new site
  4. Fill out the required fields and paste the private key

Advanced configuration

Disable timestamp check

If your servertime is not set correctly, you can have issues to connecting your application to 1Pilot. To solve that, go to 1Pilot Settings on the OctoberCMS backend of your site and check "Skip timestamp validation".

Please note that this option will decrease security and that you should set your server time correctly if possible.

Composer update (OctoberCMS ≥ 2)

As you probably know, October (from version 2) uses composer to update the core and plugins. To be able to update plugins from the 1Pilot dashboard without reaching the timeout during the process and breaking your website, we now perform theses updates asynchronously via your website cron.

In practice, when you click on the update button from the 1Pilot dashboard, we contact your website and ask it to schedule the update command. The next time the cron calls schedule:run your website runs a composer update (after all other scheduled tasks, to avoid delaying them) to update the requested plugins. Once the composer update finishes, the website contacts the 1Pilot server to show that the update has been completed on the dashboard.

Requirements

For the update to work properly, you must have :

  • 1Pilot plugin ≥ 1.2.0 installed

  • October scheduler properly configured
    On 1Pilot, under the "Details" tab of your website, you should see the "Scheduler: Works properly" row

  • Composer v2
    You can run composer --version to know the composer version

    if your server has multiple composer binaries (v1 and v2) you can set the composer binary path in config/system.php

'composer_binary' => '/your/composer/path'
On this page