Download the PHP package naqla/laravel-performance-lock without Composer
On this page you can find all versions of the php package naqla/laravel-performance-lock. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download naqla/laravel-performance-lock
More information about naqla/laravel-performance-lock
Files in naqla/laravel-performance-lock
Package laravel-performance-lock
Short Description Lock your Laravel website until client payment
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-performance-lock
Laravel Performance Lock 🔒
A simple and elegant Laravel package that allows you to lock your entire website until client payment or any other condition is met. Perfect for freelancers and agencies who want to ensure payment before delivering the final product.
Features
- 🔐 Lock/Unlock entire website with a single command
- 🎨 Customizable lock page with your own views
- 🔑 Secret unlock URL for secure access
- ⚡ Easy toggle via routes or programmatically
- 🎯 Middleware-based protection
- 📝 Configurable messages and titles
- 🚀 Zero dependencies (uses only Laravel core)
- 🔒 Hidden lock mechanism - no .env pollution
- 📊 Lock metadata tracking - track when and who locked the site
Requirements
- PHP 8.2 or higher
- Laravel 11.x or 12.x
Installation
You can install the package via composer:
Publish Configuration
Publish the configuration file:
This will create a config/performance-lock.php file where you can customize the lock message and title.
Publish Views (Optional)
If you want to customize the lock page view:
This will publish the views to resources/views/vendor/performance-lock/locked.blade.php.
Configuration
Add these variables to your .env file (optional):
Usage
1. Apply Middleware
Apply the middleware to your routes that you want to protect:
Protect All Routes
In bootstrap/app.php (Laravel 11+):
Or in app/Http/Kernel.php (Laravel 10):
Protect Specific Routes
2. Lock/Unlock Methods
Using Built-in Routes
Lock the site:
Unlock the site (with secret code):
⚠️ Important: Change the secret code in your
.envfile:
Programmatically
Using API Endpoint
3. Artisan Commands (Optional)
Create custom Artisan commands for easier management:
Customization
Custom Lock Page
After publishing the views, edit resources/views/vendor/performance-lock/locked.blade.php:
Change Secret Code
Add your secret code to .env:
Or update config/performance-lock.php:
Custom Routes
You can disable the default routes by not loading them, and create your own:
Use Cases
- Freelance Projects: Lock the site until the client makes the final payment
- Agency Work: Ensure milestone payments before deployment
- Maintenance Mode: Different from Laravel's maintenance mode, allows specific unlock mechanisms
- Demo Sites: Lock after trial period expires
- Staging Environments: Restrict access to staging sites
How It Works
- The package creates a hidden
.lockfile in the vendor directory when locked - Middleware checks for this file on each request
- If locked, users see a custom lock page (403 response)
- The unlock route bypasses the middleware
- Lock state persists even after deployment or server restart
- Lock metadata (timestamp, IP, user agent) is tracked automatically
Why Hidden File Instead of .env?
- ✅ No .env pollution - Your main project stays clean
- ✅ Persistent - Survives composer updates
- ✅ Fast - Simple file existence check
- ✅ Hidden - Stored in
vendor/naqla/laravel-performance-lock/.lock - ✅ Metadata tracking - Know when and who locked the site
Security Considerations
- Always use a strong, unique secret code for the unlock URL
- Consider adding additional authentication to lock/unlock routes in production
-
The
/lockroute is public by default - protect it if needed: - Don't share your unlock URL publicly
- Change the default unlock code before deploying to production
Testing
The package automatically bypasses the lock for the toggle routes, allowing you to always access the unlock functionality.
API Reference
Available Methods
Troubleshooting
Site still accessible after locking
Make sure the middleware is properly registered and applied to your routes.
Can't unlock the site
- Check that your unlock code matches the one in
.envor config - Ensure the unlock route is not protected by the middleware
- Try accessing
/unlock/your-secret-codedirectly
Lock state not persisting
- Ensure the vendor directory is writable
- Check file permissions on the package directory
Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
Credits
- AYOUB LAAOUAOUCHA
- All Contributors
License
The MIT License (MIT). Please see License File for more information.
Support
If you find this package helpful, please consider:
- ⭐ Starring the repository
- 🐛 Reporting issues
- 📖 Improving documentation
- 🔀 Contributing code
Made with ❤️ by AYOUB LAAOUAOUCHA
