README

CapRover SDK for Laravel

Caprover is a "Free and Open Source PaaS".

You can interact with Caprover Api using this Package in your php projects.

Installation

You can install the package via composer:

composer require ariaieboy/caprover-laravel

Usage

step 1:

publish config file and set your credentials:

php artisan vendor:publish --tag="caprover-laravel-config"

This is the contents of the published config file:

return [
    // you caprover main domain that poin to the admin area
    'server'=>env('CAPROVER_SERVER'),
    // the password of your caprover admin panel
    'password'=>env('CAPROVER_PASSWORD'),
    // guzzle timeout in seconds
    'timeout'=>env('CAPROVER_TIMEOUT',60)
];

you can use .env file instead:

#/.env file
CAPROVER_SERVER=YOUR_CAPROVER_MAIN_DOMAIN
CAPROVER_PASSWORD=YOUR_CAPROVER_PASSWORD
CAPROVER_TIMEOUT=60 #its the guzzle timeout in seconds

$caproverLaravel = new Ariaieboy\CaproverLaravel();

// or you can use the CaproverLaravel facade

\Ariaieboy\CaproverLaravel\Facades\CaproverLaravel::method($args);

⚠️ Read this section before you use this package

this package using Caprover-sdk in the background.

before using this package please read caprover-sdk README.md README file for more details about available methods and the limitations.

Testing

we need some help for the testing part of this package. we will accept any PR for testing.

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

ariaieboy / caprover-laravel

Maintainers

Details