redis-browser

Web-based Redis browser that can work as standalone app or mounted Rails engine

  • Owner: humante/redis-browser
  • Platform:
  • License:: MIT License
  • Category::
  • Topic:
  • Like:
    0
      Compare:

Github stars Tracking Chart

Redis Browser Gem Version

Features

  • List all keys as tree
  • See content of all redis types
  • List pagination
  • Pretty print json values
  • Search keys
  • Can be mounted to Rails applications as engine
  • Can connect to multiple databases

Required

  • Ruby Version ">=1.9.2"

Installation

To use with ruby version < 2.2, you must install specifically from 0.4 line which is maintained in ruby-1.9.2+ branch.

$ gem install redis-browser --version '~> 0.4.0'

Otherwise install the newest version.

$ gem install redis-browser

Usage

Standalone

$ redis-browser

You can predefine a list of available connections in a YAML file in couple of ways.

connections:
  default:
    url: redis://127.0.0.1:6379/0
  production:
    host: mydomain.com
    port: 6666
    db: 1
    auth: password

Then start with

$ redis-browser --config path/to/config.yml

Or quickly connect to a database without the hassle of creating custom configuration file

$ redis-browser --url redis://hostname:6379

The connection options can also be specified in similar way to redis-cli command

$ redis-browser -h 127.0.0.1 -p 6379 -a password -n 0

Run with --help to see what other options are available.

As engine

Add to gemfile

gem 'redis-browser'

To use with ruby version < 2.2 specify the version from 0.4 line.

gem 'redis-browser', '~> 0.4.0'

And to routes.rb

mount RedisBrowser::Web => '/redis-browser'

Use config/initializers/redis-browser.rb to predefine a list of available connections

config = Rails.root.join('config', 'redis-browser.yml')
settings = YAML.load(ERB.new(IO.read(config)).result)
RedisBrowser.configure(settings)

Protect with HTTP Basic Auth

RedisBrowser::Web is a Sinatra app, so you can inject any Rack middleware into it.

# config/initializers/redis-browser.rb
RedisBrowser::Web.class_eval do
  use Rack::Auth::Basic, "Protected Area" do, username, password, username == 'foo' && password == 'bar'
  end
end

Screenshots

Browse keys
See list with pagination
ZSET support
JSON pretty print

Contributing

  1. Fork it
  2. Create your feature branch (git checkout -b my-new-feature)
  3. Commit your changes (git commit -am 'Add some feature')
  4. Push to the branch (git push origin my-new-feature)
  5. Create new Pull Request

Main metrics

Overview
Name With Ownerhumante/redis-browser
Primary LanguageJavaScript
Program languageRuby (Language Count: 5)
Platform
License:MIT License
所有者活动
Created At2013-04-19 21:59:37
Pushed At2023-09-19 07:50:09
Last Commit At
Release Count12
Last Release Namev0.5.1 (Posted on 2017-01-02 10:44:04)
First Release Namev0.1.0 (Posted on 2013-04-20 15:48:57)
用户参与
Stargazers Count604
Watchers Count49
Fork Count67
Commits Count75
Has Issues Enabled
Issues Count30
Issue Open Count14
Pull Requests Count12
Pull Requests Open Count3
Pull Requests Close Count5
项目设置
Has Wiki Enabled
Is Archived
Is Fork
Is Locked
Is Mirror
Is Private