onexcrm/sysinfo

A complete system environment detail information guide for laravel projects

v2.1.0 2023-03-13 19:14 UTC

MIT

• Arindam Roy

README

A package for get complete system environment detail information

Installation

No dependency on PHP version and LARAVEL version

STEP 1: Run the composer command:

composer require onexcrm/sysinfo

STEP 2: Laravel without auto-discovery:

If you don't use auto-discovery, add the ServiceProvider to the providers array in config/app.php

Onex\Sysinfo\OnexSysinfoServiceProvider::class,

If you want to use the facade to log messages, add this to your facades in app.php:

'OnexSysinfo' => Onex\Sysinfo\Sysinfo\SysinfoClassFacade::class,

STEP 3: Publish the package config:

php artisan vendor:publish --provider="Onex\Sysinfo\OnexSysinfoServiceProvider" --force

How to use?:

DIRECT USE BY ROUTE

>> Just install and run the below route

Ex: http://your-website/onex/check-sysinfo

Ex: http://localhost:8000/onex/check-sysinfo

USE LIKE A HELPER IN CONTROLLER

>>> Just install and call below methods

>> Ex1: OnexSysinfo::getSystemInfo();

>> Ex2: OnexSysinfo::getAllPaths();

>> Ex3: OnexSysinfo::isStorageWritable();

>> Ex4: OnexSysinfo::isCacheWritable();

>> Ex5: OnexSysinfo::getAllEnvs();

>> Ex6: OnexSysinfo::getServerInfo();

>> Ex7: OnexSysinfo::howManyTablesInDB();

>> Ex8: OnexSysinfo::getAllTablesName();

>> Ex9: OnexSysinfo::getEnabledPhpExtensions();

You can modify the configuration settings in - "config/onex-sysinfo.php":

/** If you want to disable the route then make it false */
'is_route_enabled' => true,

/** If you want to change the route prefix */
'route_prefix' => 'onex',

/** If you want to change the route name or path */
'route_name' => 'check-sysinfo',

/** If you want to enable the securiry for access the system information
 *  Then make it ('is_enabled') true and also you can set login-id and password 
 */
'authentication' => [
    'is_enabled' => env('ONEX_SYSINFO_AUTH_ENABLED', false),
    'login_id' => env('ONEX_SYSINFO_ID', 'onexadmin'),
    'password' => env('ONEX_SYSINFO_PASSWORD', 'onexpassword')
]

license:

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

Post Issues: if found any

If have any issue please write me.