encore/redis-manager

Redis manager for laravel

Installs: 42 905

Dependents: 0

Suggesters: 0

Security: 0

Stars: 251

Watchers: 12

Forks: 35

Open Issues: 5

Language:Vue

v0.1.2 2018-04-24 09:26 UTC

This package is auto-updated.

Last update: 2024-09-13 23:06:35 UTC


README

redis-manager

StyleCI Packagist Total Downloads

Redis-manager gives your laravel application a redis web administration interface that allows you to easily manipulate the most commonly used data types for redis (strings, hashes, lists, sets, sorted sets).

It also provides a web-style command-line tool that works like redis-cli that can run most of the redis commands.

Redis-manager allows you to easily monitor several redis system status, including memory usage, cpu usage, and the throughput of each command.

Here is the living demo

redis-manager reads laravel's redis configuration located in the config/database.php

Installation

You may use Composer to install Redis-manager into your Laravel project:

composer require encore/redis-manager

After installing redis-manager, publish its assets using the vendor:publish Artisan command:

php artisan vendor:publish --provider="Encore\RedisManager\RedisManagerServiceProvider"

After installation, open http://your-server/redis-manager to access redis-manager.

Configuration

The config file was published at config/redis-manager.php, and the default contents of the configuration:

<?php

return [

    /*
    |--------------------------------------------------------------------------
    | Redis Manager Base Path
    |--------------------------------------------------------------------------
    |
    | Base path for Redis Manager
    |
    */

    'base_path' => 'redis-manager',

    /*
    |--------------------------------------------------------------------------
    | Redis Manager Middleware
    |--------------------------------------------------------------------------
    |
    | The Redis Manager's route middleware.
    |
    */

    'middleware' => [],

    /*
    |--------------------------------------------------------------------------
    | Redis Manager Results Per Page
    |--------------------------------------------------------------------------
    |
    | Here you can configure for the number of results will show in the
    | Redis Manager search page.
    |
    */

    'results_per_page' => 50,

    /*
    |--------------------------------------------------------------------------
    | Redis Manager Disable Commands
    |--------------------------------------------------------------------------
    |
    | The commands listed here was disabled when you use Redis Manager Console
    | to run commands. Feel free to add commands here which you do not want
    | users to use.
    |
    */

    'disable_commands' => [
        'flushdb'
    ]
];

Authentication

By default, you will only be able to access redis-manager in the local environment. To define a more specific access policy for it, you should use the RedisManager::auth method. The auth method accepts a callback which should return true or false, indicating whether the user should have access to redis-manager:

RedisManager::auth(function ($request) {
    // return true / false;
});

License

Redis manager is open-sourced software licensed under the MIT license