Installation


Installing Kernel Connect Via Composer

{info} License

Before installing Kernel Connect, you will need to purchase a Kernel Connect license. You can purchase a Kernel Connect license via the Kernel Connect dashboard.

To get started installing Kernel Connect, add Kernel Connect repository to your application's composer.json file:

"repositories": [
    {
        "type": "composer",
        "url": "https://rogue.repo.packagist.com/{username}"
    }
],

Next, you may add the rogue/kernel-connect package to the list of required packages in your composer.json file:

"require": {
    "php": "^7.4.0",
    "laravel/framework": "^8.0",
    "rogue/kernel-connect": "^1.0"
},

After your composer.json file has been updated, run the composer update command in your console terminal:

composer update
{
    "http-basic": {
        "rogue.repo.packagist.com": {
            "username": "email@example.com",
            "password": "{token}"
        }
    }
}

When running composer update, you will be prompted to provide your login credentials for the Rogue Packagist site. These credentials will authenticate your Composer session as having permission to download the Kernel Connect's source code. To avoid manually typing these credentials, you may create a Composer auth.json file and use your API token in place of your {token}:

composer config http-basic.rogue.repo.packagist.com email@example.com {token}

{danger.fa-close}

The auth.json File You should not commit your application's auth.json file into source control.

Once the package is installed via Composer, run the kernel-connect:install Artisan command:

php artisan kernel-connect:install

Finnally, you will need to run the migrate command

php artisan migrate

That's it! Next, you may navigate to your application's config/kernel-connect.php configuration file and begin configuring your Kernel Connect installation.

Installing Kernel Connect Via Zip Downloads

Once you have purchased a Kernel Connect license, you may download a Kernel Connect release from the "releases" section of your Rogue Development dashboard. After downloading a Zip file containing the Kernel Connect source code, you will need to install it as a Composer "path" repository within your Laravel application's composer.json file.

First, unzip the contents of the Kernel Connect release into a kernel-connect directory within your application's root directory. Once you have unzipped and placed the Kernel Connect source code within the appropriate directory, you are ready to update your composer.json file. You should add the following configuration to the file:

"repositories": [
    {
        "type": "path",
        "url": "./kernel-connect"
    }
],

{warning} Hidden Files

When unzipping Kernel Connect into your application's kernel-connect directory, make sure all of Kernel Connects's "hidden" files (such as its .gitignore file) are included.

Next, add rogue/kernel-connect to the require section of your composer.json file:

"require": {
    "php": "^7.4",
    "laravel/framework": "^7.0",
    "rogue/kernel-connect": "*"
},

After your composer.json file has been updated, run the composer update command in your console terminal:

composer update

{info} Package Stability

If you are not able to install Kernel Connect into your application because of your minimum-stability setting, consider setting your minimum-stability option to dev and your prefer-stable option to true. This will allow you to install Kernel Connect while still preferring stable package releases for your application.

Finally, run the kernel-connect:install and migrate Artisan commands. The kernel-connect:install command will install Kernel Connect's service provider and public assets within your application:

php artisan kernel-connect:install
php artisan migrate

After running this command, verify that the App\Providers\KernelConnectServiceProvider was added to the providers array in your app configuration file. If it wasn't, you should add it manually. Of course, if your application does not use the App namespace, you should update the provider class name as needed.

Authenticating Kernel Connect in Continuous Integration (CI) Environments

It's not advised to store your auth.json file inside your project's version control repository. However, there may be times you wish to download Kernel Connect inside a CI environment like Chipper CI. For instance, you may wish to run tests for any custom tools you create. To authenticate Kernel Connect in these situations, you can use Composer to set the configuration option inside your CI system's pipeline, injecting environment variables containing the email address associated with your subscription, along with your {token}:

composer config http-basic.rogue.repo.packagist.com ${KERNEL_CONNECT_USERNAME} ${KERNEL_CONNECT_TOKEN}