PHPackages ariaieboy/caprover-sdk - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. ariaieboy/caprover-sdk AbandonedArchivedLibrary[Utility & Helpers](/categories/utility) ariaieboy/caprover-sdk ====================== CapRover SDK for PHP and Laravel 1.1.2(1y ago)81411MITPHPPHP ~8.1.0|~8.2.0|~8.3|~8.4 Since Feb 28Pushed 1y ago1 watchersCompare [ Source](https://github.com/ariaieboy/caprover-sdk)[ Packagist](https://packagist.org/packages/ariaieboy/caprover-sdk)[ Docs](https://github.com/ariaieboy/caprover-sdk)[ GitHub Sponsors](https://github.com/ariaieboy)[ RSS](/packages/ariaieboy-caprover-sdk/feed)WikiDiscussions main Synced 3w ago READMEChangelog (7)Dependencies (6)Versions (10)Used By (1) CapRover SDK for Laravel ======================== [](#caprover-sdk-for-laravel) [![Latest Version on Packagist](https://camo.githubusercontent.com/e62fc3e06651547f58f0f83f2df99529c8325a5f620ee1524c6a79030b916ad3/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f617269616965626f792f636170726f7665722d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ariaieboy/caprover-sdk)[![Total Downloads](https://camo.githubusercontent.com/39945e2ca7bcdbae240cda16878ce3a87ea3b54e67f89727b88f2a3da3934f62/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f617269616965626f792f636170726f7665722d73646b2e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/ariaieboy/caprover-sdk) [Caprover](https://github.com/caprover/caprover) is a "Free and Open Source PaaS". You can interact with Caprover Api using this package in your PHP projects. ⚠️ Read this section before you use this package ================================================ [](#️-read-this-section-before-you-use-this-package) According to this [section](https://github.com/caprover/caprover-cli#api), the API of the Caprover needs to be documented. `There is no official document for the API commands at this point as it is subject to change at any point.` The line above is the exact sentence the Caprover team put in the API section of the `Caprover CLI`. Because of this, we can't guarantee that this SDK will work with all versions of the `Caprover`. We will test each release of [`Caprover-Sdk`](https://github.com/ariaieboy/caprover-sdk) with the latest version of the `Caprover`, and we only guarantee that this package will work with the newest version. The latest release is tested with [v1.10.1](https://github.com/caprover/caprover/releases/tag/v1.10.1) of the `Caprover`. Installation ------------ [](#installation) You can install the package via Composer: ``` composer require ariaieboy/caprover-sdk ``` Usage in Laravel ---------------- [](#usage-in-laravel) Publish config file and set your credentials: ``` php artisan vendor:publish --tag="caprover-config" ``` This is the contents of the published config file: ``` return [ // Your Caprover main domain that point 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 the .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 ``` ``` \Ariaieboy\CaproverLaravel\Facades\Caprover::method($args); ``` Using In PHP Application ------------------------ [](#using-in-php-application) ``` $caprover = new \Ariaieboy\Caprover\Caprover('caprover address','caprover password','timeout (default:60)') $caprover->method($args); ``` Available Methods ----------------- [](#available-methods) ``` $caprover = new \Ariaieboy\Caprover\Caprover('server','password'); $caprover->getCaptainInfo(); /** * You can retrieve the auth token for the API calls * but it's not necessary to call other methods * The SDK will handle getting API Auth Token for you. */ $caprover->getAuthToken(); //Attach a new domain to an app $caprover->attachNewCustomDomainToApp(appName: string,customDomain: string); //Enable SSL for a custom domain on an app $caprover->enableSslForCustomDomain(appName: string,customDomain: string); //Remove a Custom domain from an app $caprover->removeCustomDomain(appName: string,customDomain: string); //Force Ssl on captain root domain $caprover->forceSsl(isEnabled: bool); //Change Captain root domain $caprover->updateRootDomain(rootDomain: string); //Enable root domain SSL $caprover->enableRootSsl(emailAddress: string); //Get All Apps $caprover->getAllApps(); ``` Testing ------- [](#testing) We are using Saloon as the base for our SDK, and for testing, we are using PestPHP. To run available tests, you can run the tests using PestPHP CLI: ``` ./vendor/bin/pest ``` We use Saloon `Recording Responses`, and because of that, if you run the available tests, you do not need to provide any caprover server for the tests. You can run tests on a specific caprover server by creating a `.env` file in your tests folder. We have an example `.env` file called `.env.example` that you can use to create your `.env` file. For testing APIs that do operations on an app, you must provide a test app name from your caprover server using the `CAPROVER_TEST_APP` ENV variable. And for testing the APIs that change an app's custom domain, you must provide a domain name that points to your caprover server using the `CAPROVER_TEST_DOMAIN` ENV variable. Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for recent changes. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details. Security Vulnerabilities ------------------------ [](#security-vulnerabilities) Please review [our security policy](../../security/policy) on how to report security vulnerabilities. Credits ------- [](#credits) - [AriaieBOY](https://github.com/ariaieboy) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. ### Health Score 37 — LowBetter than 81% of packages Maintenance34 Infrequent updates — may be unmaintained Popularity16 Limited adoption so far Community13 Small or concentrated contributor base Maturity72 Established project with proven stability Bus Factor1 Top contributor holds 88.1% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~134 days Recently: every ~172 days Total 8 Last Release 632d ago Major Versions 0.x-dev → 1.0.02023-05-23 PHP version history (5 changes)0.1.0PHP ~8.1 0.2.0PHP ~8.1|~8.2 0.x-devPHP ~8.1.0|~8.2.0 1.1.1PHP ~8.1.0|~8.2.0|~8.3 1.1.2PHP ~8.1.0|~8.2.0|~8.3|~8.4 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/15873972?v=4)[AriaieBOY](/maintainers/ariaieboy)[@ariaieboy](https://github.com/ariaieboy) --- Top Contributors [![ariaieboy](https://avatars.githubusercontent.com/u/15873972?v=4)](https://github.com/ariaieboy "ariaieboy (52 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (5 commits)")[![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?v=4)](https://github.com/github-actions[bot] "github-actions[bot] (2 commits)") --- Tags laravelsdkariaieboycaprover-laravelcaprover sdk ### Code Quality TestsPest ### Embed Badge ![Health badge](/badges/ariaieboy-caprover-sdk/health.svg) ``` [![Health](https://phpackages.com/badges/ariaieboy-caprover-sdk/health.svg)](https://phpackages.com/packages/ariaieboy-caprover-sdk) ``` ### Alternatives [spatie/laravel-data Create unified resources and data transfer objects 1.8k33.0M880](/packages/spatie-laravel-data)[spatie/laravel-pdf Create PDFs in Laravel apps 1.0k4.3M42](/packages/spatie-laravel-pdf)[codewithdennis/filament-select-tree The multi-level select field enables you to make single selections from a predefined list of options that are organized into multiple levels or depths. 328482.0k25](/packages/codewithdennis-filament-select-tree)[nativephp/desktop NativePHP for Desktop 38133.6k8](/packages/nativephp-desktop)[worksome/exchange Check Exchange Rates for any currency in Laravel. 124581.3k](/packages/worksome-exchange)[rawilk/profile-filament-plugin Profile & MFA starter kit for filament. 3913.7k](/packages/rawilk-profile-filament-plugin) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)