phnxdgtl/ctrl-client

There is no license information available for the latest version (dev-master) of this package.

A collection of client APIs for use with the CTRL CMS

dev-master 2023-01-20 17:41 UTC

Requires

• intervention/image: ^2.7
• laravel/framework: ^9.0
• league/flysystem-aws-s3-v3: ^3.0
• maatwebsite/excel: ^3.1
• php-http/curl-client: ^2.2
• typesense/typesense-php: ^4.7
• yajra/laravel-datatables: ^9.0

Unknown License

README

#CTRL Client Package

##Installation instructions

Add this code to your composer.json file:

"repositories": [    
    {
        "type": "git",
        "url": "https://github.com/phnxdgtl/ctrl-client"
    }
]

You can then install the libraries via:

composer require phnxdgtl/ctrl-client

###Note

We have an installation issue with Laravel Datatables in Laravel 9, as described here:

(https://github.com/yajra/laravel-datatables-buttons/issues/143)[https://github.com/yajra/laravel-datatables-buttons/issues/143]

In the short-term, we've added these lines to composer.json for the Client

"psr/simple-cache": "^1.0",
"maatwebsite/excel": "^3.1",

This also requires the --with-all-dependencies option, as follows:

composer require phnxdgtl/ctrl-client -W

These should be removed once Laravel Datatables is updated to fully support Laravel 9.

##S3 buckets

Each site requires its own S3 bucket. These can be configured as Linode Object Storage.

Once a key has been generated, add the following lines to app/config/filesystems.php:

ctrl' => [
    'driver'   => 's3',
    'key'      => env('LINODE_STORAGE_ACCESS_KEY'),
    'secret'   => env('LINODE_STORAGE_SECRET_ACCESS_KEY'),
    'endpoint' => env('LINODE_STORAGE_ENDPOINT'),
    'region'   => env('LINODE_STORAGE_REGION'),
    'bucket'   => env('LINODE_STORAGE_BUCKET'),
],

You'll also need the following in .env; the default keys are shown here:

LINODE_STORAGE_ACCESS_KEY=BPFQN7ALXK1F3AQV1SQR
LINODE_STORAGE_SECRET_ACCESS_KEY=dsoJpJez2AIF75SJCwk5sh3HtTMKEgFLsCfRrzQF
LINODE_STORAGE_ENDPOINT=https://eu-central-1.linodeobjects.com
LINODE_STORAGE_REGION=eu-central-1
LINODE_STORAGE_BUCKET=********

##Images

I like Laravel Thumbnail for this.

composer require rolandstarke/laravel-thumbnail

You can then call the following to render an image from CTRL:

Thumbnail::src(Storage::disk('ctrl')->url(*$object->image*))->smartcrop(200, 200)->url();

##Typesense

Add the following to .env to use the default Typesense account:

TYPESENSE_HOST=1yhk982netu73cplp-1.a1.typesense.net
TYPESENSE_KEY=kUp6Gg9CEzlR0dsdGxx87rMf1yJNYxVM

##Setting up the site in CTRL

Log into the CTRL Server, and add the site.

You should then copy the API Key to .env, as follows:

\CTRL_KEY=********

That's it.