Download the PHP package gtcrais/laravel-centinel-api without Composer
On this page you can find all versions of the php package gtcrais/laravel-centinel-api. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download gtcrais/laravel-centinel-api
More information about gtcrais/laravel-centinel-api
Files in gtcrais/laravel-centinel-api
Package laravel-centinel-api
Short Description Laravel Centinel API
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-centinel-api
Laravel Centinel API for Laravel 5
This package provides API for downloading the application log file, and dumping and downloading the database. It ships with authentication middleware which protects the API routes.
Centinel API is designed to work in combination with Centinel - centralized application management system.
For Laravel 4.2 use Centinel API v1.2
Requirements
- PHP 5.6+
- Laravel 5.1+ (Laravel 5.0 is not supported due to incompatibility with Symfony components used in it)
- make sure your Cache driver is configured and is working
- Windows environment is not supported
Installation: Laravel
- add
"gtcrais/laravel-centinel-api": "2.3.*"to yourcomposer.jsonand runcomposer update - for Laravel
<=5.4addGTCrais\LaravelCentinelApi\LaravelCentinelApiServiceProvider::class,to providers array in/app/config/app.phpand runcomposer dump-autoload - run
php artisan centinel-api:setup
Installation: Lumen
- add
"gtcrais/laravel-centinel-api": "2.3.*"to yourcomposer.jsonand runcomposer update - uncomment
$app->withFacades();in/bootstrap/app.php - add
$app->configure('centinelApi');to/bootstrap/app.php. This will load Centinel API configuration - add
$app->register(GTCrais\LaravelCentinelApi\LumenCentinelApiServiceProvider::class);to/bootstrap/app.phpbelow config file registration - run
php artisan centinel-api:setup
Additional Installation Notes
Laravel 5.1
- add
routePrefixtoVerifyCsrfTokenmiddleware's$exceptarray. Example:
Lumen
Centinel API will first look for database connection configuration in /config/database.php. If it's not available there,
it will look in .env file. Make sure one of these options is available if you wish to use the database dump functionality.
Usage
It's highly recommended to use this plugin only on websites that use HTTPS!
After going through the installation process you will find centinelApi.php configuration file in /config directory.
From there, copy privateKey, encryptionKey and routePrefix to Centinel, and you're ready to schedule your application log checks and database backups.
Config File
privateKey- random string, used for authenticationencryptionKey- random string, used for additional security layerroutePrefix- random string, prefixing the API routesenabledRoutes- if you only wish to expose a part of the API, you can disable either Log or Database routes heredisableTimeBasedAuthorization- set totruein case of your server's and Centinel's datetime being out of sync which results inRequest time mismatchorToo many API callserrorzipPassword- password used when zipping the database dump. Make sure to save the Zip Password so you can restore your database in case of server crashdatabase- database settings and options
All of the database options except for connection are optional.
Some of the database options are not available for Laravel/Lumen 5.1, and on PHP 5 (regardless of the framework version). For more details check Spatie DB Dumper v1.5.1
For details on how to use the options check the installed version of the package. For Laravel/Lumen 5.2+ on PHP 7 that will be Spatie DB Dumper v2.9
To ignore a database setting/option, set it to null.
API Routes
- [POST]
/{routePrefix}/create-log - [POST]
/{routePrefix}/download-log - [POST]
/{routePrefix}/dump-database - [POST]
/{routePrefix}/download-database
For more details check /Controllers/CentinelApiController.php controller.
Database Backups
Spatie DB Dumper is used to make database dumps. MySQL and PostgreSQL
are supported, and require mysqldump and pg_dump utilities, respectively.
Additionally, on Laravel/Lumen 5.2+ applications running on PHP 7, Sqlite and MongoDB are supported, and require
sqlite3 and mongodump utilities, respectively.
Centinel API will try to zip and password protect database dumps before sending them to Centinel. In case you're using PHP 7.2+, it will use
PHP's native ZipArchive class to zip and encrypt the database. Otherwise, it will look for 7-Zip and Zip libraries to do so. If no option
is available, dumps will be sent without being zipped and password protected.
Run php artisan centinel-api:check-zip to see which library is available on your server. Note that Zip encryption algorithm is much less
secure than that of ZipArchive and 7-Zip. Ultimately it is up to you to decide which level of security is satisfactory. You can always opt out of
backing up your database by disabling database backups in Centinel, and additionally, commenting out DatabaseRoutes in the
enabledRoutes config option.
Authentication
For details check /Middleware/AuthorizeCentinelApiRequest.php middleware.
License
Laravel Centinel API is open-sourced software licensed under the MIT license.
