souravmsh / laravel-installer
A sleek and easy-to-use web-based installer for Laravel applications.
Package info
github.com/souravmsh/laravel-installer
Language:Blade
pkg:composer/souravmsh/laravel-installer
Requires
- php: ^8.2
- illuminate/support: ^8.0|^9.0|^10.0|^11.0|^12.0|^13.0
Requires (Dev)
- orchestra/testbench: ^6.0|^7.0|^8.0|^9.0|^10.0|^11.0
- phpunit/phpunit: ^9.5|^10.1
README
A sleek, modern, and easy-to-use web-based installer for Laravel applications. This package provides a step-by-step wizard to help users set up your Laravel application, including environment configuration, database connection, and license validation.
Features
- Standard Requirements Check: Verifies PHP version and required extensions.
- Permissions Check: Ensures necessary directories are writable.
- Environment Configuration: Easy setup for
.envvariables. - Database Setup: Wizard for database connection and migration.
- License Validation: Flexible support for license key validation (Required, Optional, or Disabled).
- Modern Mobile-App UI: Sleek, glassmorphism-based design optimized for clarity and ease of use.
Installation
You can install the package via composer:
composer require souravmsh/laravel-installer
Setup
1. Register the Service Provider (Optional for Laravel 5.5+)
The package will automatically register itself using Laravel's package discovery.
2. Publish Configuration and Assets
You can publish the configuration file and views using the following commands:
Publish All:
php artisan vendor:publish --tag="laravel-installer-publish"
Publish Configuration Only:
php artisan vendor:publish --tag="laravel-installer-config"
Publish Views Only:
php artisan vendor:publish --tag="laravel-installer-views"
3. Middleware
The package provides two middlewares:
installer.check: Ensures the application is installed before allowing access.installer.redirect: Redirects to the homepage if the application is already installed.
You should apply these to your routes as needed.
The configuration file is located at config/laravel_installer.php. You can customize the application name, license server, and other settings here.
return [ 'app_name' => env('APP_NAME', 'Laravel Application'), // Enable or disable the installer 'installer_enabled' => env('INSTALLER_ENABLED', true), // Path to the installation lock file 'installed_key_path' => env('INSTALLER_KEY_PATH', 'app/private/key.install'), // Supported: "required", "optional", "disabled" 'license_check' => env('INSTALLER_LICENSE', 'optional'), 'license_server_url' => env('INSTALLER_LICENSE_URL', 'null'), 'license_storage_path' => env('INSTALLER_LICENSE_KEY_PATH', 'app/private/key.private'), ];
Usage
Once installed, navigate to /install to begin the installation process. The installer will guide you through:
- Welcome Screen
- Server Requirements Check
- Directory Permissions Check
- Environment Configuration
- Database Setup
- License Validation
- Installation Completion
Security
If you discover any security-related issues, please email sourav.diubd@gmail.com instead of using the issue tracker.
Credits
License
Proprietary License. Please see License File for more information.