Download the PHP package relayercore/laravel-installer without Composer
On this page you can find all versions of the php package relayercore/laravel-installer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download relayercore/laravel-installer
More information about relayercore/laravel-installer
Files in relayercore/laravel-installer
Package laravel-installer
Short Description A beautiful, reusable web-based installer for Laravel applications
License MIT
Homepage https://github.com/relayercore/laravel-installer
Informations about the package laravel-installer
Laravel Installer
A beautiful, reusable, and highly customizable web-based installer wizard for Laravel applications. Drop it into any project to provide a professional onboarding experience for your users — zero bloat, maximum flexibility.
Features
- 🎨 Beautiful UI — Modern, responsive, Tailwind and Livewire-powered wizard.
- 📋 Config-Driven Pipeline — Add, remove, or reorder steps easily via configuration.
- ✅ Server Requirements — Automatic checking for PHP version and required extensions.
- 📂 Permissions Checking — Verifies required directories are writable (e.g.,
storage,bootstrap/cache). - 🗄️ Database Setup — Instant connection testing and automatic database creation for MySQL, PostgreSQL, SQL Server, and SQLite.
- 👤 Admin Creation — Built-in admin account creation with hook-based role assignment.
- 🛠️ Custom Step Generator — Scaffold custom steps instantly using the
php artisan make:installer-stepcommand. - 🌐 Localization (i18n) — 100% of the UI strings are translatable.
- 🔌 Dynamic
.envInjection — Easily prompt users for custom environment variables during the database setup step. - 🛡️ Secure — Automatically runs
key:generateand protects your app with API-friendly 503 middleware until installation is complete. - 🔄 Forward Compatible — Works flawlessly with Laravel 10, 11, 12 & 13.
Installation
Require the package via Composer:
Quick Start
1. Publish Assets
To customize the installer for your application, you should publish the configuration file. You can also publish views and translations if you want full control over the UI and text.
2. Configure the Installer
Open config/installer.php. This file is the heart of the installer. You can configure the app name, logo, theme colors, and the exact steps your users will walk through.
3. Launch the Installer
Simply navigate to /install in your browser. The package will automatically intercept traffic to your application if the app hasn't been installed yet.
Adding Custom Steps
The installer is designed to be fully extensible. If your application requires users to select a pricing plan, configure a third-party API key, or choose an industry, you can add a custom step!
1. Scaffold the Step
Use our provided Artisan command to generate the boilerplate:
This will create a new class at app/Installer/Steps/SelectPlan.php:
2. Create the View
Create the Livewire view file referenced in your step (e.g., resources/views/installer/steps/plan.blade.php). Use wire:model="state.plan" to bind inputs to the $data array passed to your validate() and process() methods.
3. Register the Step
Add your new step to the steps array in config/installer.php:
Customizing the Admin Step
By default, the built-in CreateAdmin step expects your User model to have name, email, and password fields.
What if your User model uses username, or first_name and last_name?
Because the installer is modular, you shouldn't try to hack the core. Instead, simply swap out the default admin step with your own!
-
Generate your custom admin step:
- Implement your custom user creation logic in the
process()method ofapp/Installer/Steps/SetupAdmin.php. - Update
config/installer.phpto remove the default step and use yours:
Extra Environment Fields
If you just need to prompt the user for a few extra .env variables (like Timezone or Multi-Tenancy mode), you don't need a custom step! You can inject them directly into the built-in Database Setup screen via config/installer.php:
How It Works Under the Hood
- Middleware (
CheckInstallation): Checks for the existence of thestorage/installedfile. - Interception: If missing, it redirects web routes to
/install. API requests receive a503 Service UnavailableJSON response. - Wizard: Guides the user through your configured pipeline of steps.
- Completion: Creates the
storage/installedmarker file and automatically runsphp artisan key:generateto secure the application. - Success: The application runs normally for all future requests.
Security & Distribution Best Practices
If you are distributing your application (e.g., via CodeCanyon, GitHub, or zip file):
- Include a generic
.envfile in your distribution with an empty or genericAPP_KEY. - Do NOT include the
storage/installedfile in your distribution. - When the user finishes the installer, the package will automatically generate a unique, secure
APP_KEYfor their specific installation.
License
The Laravel Installer is open-sourced software licensed under the MIT license.
All versions of laravel-installer with dependencies
illuminate/support Version ^10.0|^11.0|^12.0|^13.0
livewire/livewire Version ^3.0|^4.0