malhuda/jikan-rest
1
0
Fork 0
mirror of https://github.com/jikan-me/jikan-rest.git synced 2025-02-20 11:23:35 +08:00
Code Issues Actions Packages Projects Releases Wiki Activity

remove blacklist residue

Browse Source
This commit is contained in:
Irfan 2021-09-18 17:52:51 +05:00
parent 0f8ed0ba23
commit a367373a12
2 changed files with 0 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
COMMANDS.MD
View File

@ -5,10 +5,6 @@ For an entire list of commands, you can run `php artisan list`
## Index
- [Serve](#serve)
- [Blacklist](#blacklist)
- [Add](#blacklist-add)
- [Remove](#blacklist-remove)
- [Flush](#blacklist-flush)
- [Queue](#queue)
- [Clear](#queue-clear)
- [Cache](#cache)
@ -24,46 +20,6 @@ Example: `php artisan serve`
Serve the application on the PHP development server
### Blacklist
Add IPs to your API's blacklist. A blacklisted IP will get a HTTP 403 with the following JSON body:
```json
{
"status": 403,
"type": null,
"message": "You have been blocked from the service for breaching Terms of Use",
"error": null
}
```
The blacklist is stored in `/storage/app/blacklist.json`. Once your application starts, the blacklist is loaded into memory via Redis.
#### Blacklist: Add
Command: `blacklist:add {ip} {--reload}`
Example: `php artisan blacklist:add 123.456.789.10`
**Note:** Without `--reload`, the blacklist won't take immediate effect as it will only be saved to `blacklist.json` and won't updated in-memory.
Therefore, it's recommended to use `--reload` for real-time effect.
#### Blacklist: Remove
Command: `blacklist:remove {ip} {--reload}`
Example: `php artisan blacklist:remove 123.456.789.10`
**Note:** Without `--reload`, the blacklist won't take immediate effect as it will only be removed from `blacklist.json` and won't be updated in-memory.
Therefore, it's recommended to use `--reload` for real-time effect.
#### Blacklist: Flush
Command: `blacklist:flush {--reload}`
Example: `php artisan blacklist:flush`
**Note:** Without `--reload`, the blacklist won't take immediate effect as it will only empty `blacklist.json` and won't be updated in-memory.
Therefore, it's recommended to use `--reload` for real-time effect.
### Queue
#### Queue: Clear

3
app/Console/Kernel.php
View File

@ -2,9 +2,6 @@
namespace App\Console;
use App\Console\Commands\BlacklistAdd;
use App\Console\Commands\BlacklistFlush;
use App\Console\Commands\BlacklistRemove;
use App\Console\Commands\ClearQueuedJobs;
use App\Console\Commands\CacheRemove;
use App\Console\Commands\ModifyCacheDriver;