Download the PHP package victorive/superban without Composer
On this page you can find all versions of the php package victorive/superban. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
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 superban
Superban
Superban is a Laravel package designed to enable you ban API clients for a specified period. It allows you to easily limit the number of requests a client can execute within a certain time frame, and if they surpass this limit, they will be banned for the specified duration.
Installation
Install the package via composer using:
Next, publish the configuration file (config/superban.php) with:
The published configuration file enables you to customize the SUPERBAN_CACHE_DRIVER and SUPERBAN_BAN_CRITERIA
parameters
for rate-limiting operations. These settings can be modified in your .env file with your preferred values.
If you choose to use the "database" as your cache driver, remember to run php artisan cache:table to create the necessary tables for the cache storage.
See the Cache docs for more info.
Configuration
- The
SUPERBAN_CACHE_DRIVERparameter determines the cache driver used for Superban operations. Supported drivers include"array", "database", "file", "memcached", "redis", "dynamodb", and "octane". - The
SUPERBAN_BAN_CRITERIAparameter sets the criteria for rate-limiting or banning users. - Supported options include
"user_id", "email", and "ip".
Example configuration:
Update your .env file with your preferred values for the keys below:
SUPERBAN_CACHE_DRIVER= {{your preferred cache driver}}
SUPERBAN_BAN_CRITERIA= {{your preferred ban criteria}}
Usage
To utilize Superban's functionalities, add the following to your app/Http/Kernel.php file.
Then you can protect your routes using the middleware rules. For instance
-
Route group:
- Single route:
In the examples above,
- 100 is the maximum number of requests allowed,
- 2 is the time period (in minutes) during which these requests can occur, and
- 720 is the duration (in minutes) for which the user will be banned after exceeding the limit.
Testing
To run the tests, use the following command:
Changelog
For information on recent updates, refer to the CHANGELOG file.
Contributing
Contributions are welcome! Feel free to fork the repo, make any changes or report any issues, and submit a PR.
License
This package is licensed under the MIT License. For more information, please see the License File.
