Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/neelkanthk/laravel-surveillance-ui
Provides a Graphical UI for Laravel Surveillance package and integrates within your existing application.
https://github.com/neelkanthk/laravel-surveillance-ui
access-control laravel laravel-package laravel-security laravel-surveillance php
Last synced: 9 days ago
JSON representation
Provides a Graphical UI for Laravel Surveillance package and integrates within your existing application.
- Host: GitHub
- URL: https://github.com/neelkanthk/laravel-surveillance-ui
- Owner: neelkanthk
- License: mit
- Created: 2020-10-15T09:20:48.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2020-11-14T21:15:30.000Z (almost 4 years ago)
- Last Synced: 2024-10-12T11:12:09.471Z (26 days ago)
- Topics: access-control, laravel, laravel-package, laravel-security, laravel-surveillance, php
- Language: JavaScript
- Homepage:
- Size: 3.87 MB
- Stars: 20
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
## What is Laravel Surveillance UI?
Provides a Graphical UI for [Laravel Surveillance](https://github.com/neelkanthk/laravel-surveillance) and integrates within your existing application.
## What is Laravel Surveillance?
Laravel Surveillance is a package to put malicious users, IP addresses and anonymous browser fingerprints under surveillance, write surveillance logs and block malicious ones from accessing the app. [Read more](https://github.com/neelkanthk/laravel-surveillance#laravel-surveillance-)
## Laravel Surveillance UI Demo
[](https://www.youtube.com/watch?v=G0foqT7WPeA)
## Minimum Requirements
1. Laravel 6.0
2. PHP 7.2
## Installation
```bash
composer require neelkanthk/laravel-surveillance-ui
```
## Usage
## Step 1: [Configure Laravel Surveillance](#step-1)
_NOTE:- If you have already installed ```neelkanthk/laravel-surveillance``` in your application then please go directly to Step 2_.
#### 1.1. Publish the migration files:
```bash
php artisan vendor:publish --provider="Neelkanth\Laravel\Surveillance\Providers\SurveillanceServiceProvider" --tag="migrations"
```
#### 1.2. Publish language files:
```bash
php artisan vendor:publish --provider="Neelkanth\Laravel\Surveillance\Providers\SurveillanceServiceProvider" --tag="lang"
```
#### 1.3. Run the migrations
```bash
php artisan migrate
```
#### 1.4. Publish the config file (Optional):
```bash
php artisan vendor:publish --provider="Neelkanth\Laravel\Surveillance\Providers\SurveillanceServiceProvider" --tag="config"
```
[Read more about Laravel Surveillance installation](https://github.com/neelkanthk/laravel-surveillance#installation)
## Step 2: [Configure Laravel Surveillance UI](#step-2)
_The following steps will install Laravel Surveillance UI in your application_.
#### 2.1. Publish views:
```bash
php artisan vendor:publish --provider="Neelkanth\Laravel\SurveillanceUi\Providers\SurveillanceUiServiceProvider" --tag="views"
```
#### 2.2. Publish config:
```bash
php artisan vendor:publish --provider="Neelkanth\Laravel\SurveillanceUi\Providers\SurveillanceUiServiceProvider" --tag="config"
```
#### 2.3. Publish assets:
```bash
php artisan vendor:publish --provider="Neelkanth\Laravel\SurveillanceUi\Providers\SurveillanceUiServiceProvider" --tag="assets"
```
## Add Middleware
Laravel Surveillance provides a ```surveillance``` middleware that can be used on any route or route group to make it eligible for surveillance.
```php
Route::middleware(["surveillance"])->get('/path', function () {});
```
[Read more about middleware usage](https://github.com/neelkanthk/laravel-surveillance#middleware-usage)
## Accessing the Dashboard
The **Laravel Surveillance UI manager dashboard** can be accessed at: http://your.domain/surveillance/ui/manager
The **Laravel Surveillance UI logs dashboard** can be accessed at: http://your.domain/surveillance/ui/logs
## Overriding and customizing the package default configuration
### Customizing the route prefix
By default ```surveillance/ui``` route prefix is appended to the package's routes.
If you want to customize it then you can do so easily in the ```config/surveillance-ui.php``` file's _**prefix**_ key as shown below.
```php
/**
* The prefix to be used in the surveillance ui routes
*/
"prefix" => "surveillance/ui",
```
### Customizing the route middleware
By default ```web``` middleware is added to the package's routes.
If you want to add more middlewares like ```auth``` or something else, then you can add them easily in the ```config/surveillance-ui.php``` file's _**middleware**_ key as shown below.
```php
/**
* The middleware(s) to be used in the surveillance ui routes
*/
"middleware" => ["web", "auth"], //auth middleware added
```
### Customizing the views
After publishing the package views you can change the design as per your taste.
The views are published inside your project's ```resources/views/vendor/surveillance-ui``` directory.
### Customizing the JS and CSS
After publishing the package assets you can tweak the JS and CSS inside your project's ```public/surveillance-ui``` directory.
### Replacing the default logo
You can change the default CCTV logo and favicon displayed on the Surveillance Dashboard by replacing them with your own at ```public/surveillance-ui/images/logo.png``` and ```public/surveillance-ui/images/favicon.ico```.
## Contributing
Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.
## Security
If you discover any security-related issues, please email [email protected] instead of using the issue tracker.
## Credits
- [Neelkanth Kaushik](https://github.com/neelkanthk)
- [All Contributors](../../contributors)
## License
[MIT](https://choosealicense.com/licenses/mit/)