phpRedisAdmin

phpRedisAdmin is a simple web interface to manage Redis databases. It is released under the Creative Commons Attribution 3.0 license. This code is being developed and maintained by Erik Dubbelboer.

You can send comments, patches, questions here on github or to [email protected].

Example

You can find an example database at http://dubbelboer.com/phpRedisAdmin/

Installing/Configuring

Install Composer using its verified installer, then run:

composer create-project erik-dubbelboer/php-redis-admin path/to/install

You may also want to copy includes/config.sample.inc.php to includes/config.inc.php and edit it with your specific redis configuration.

To install from a Git checkout, install its locked dependencies with Composer:

git clone https://github.com/ErikDubbelboer/phpRedisAdmin.git
cd phpRedisAdmin
composer install

Docker Image

A public phpRedisAdmin Docker image is available on Docker Hub built from the latest tag. The file includes/config.environment.inc.php is used as the configuration file to allow environment variables to be used as configuration values. Authentication is required. Set ADMIN_USER and ADMIN_PASS before exposing the container. If you intentionally need unauthenticated access, set ALLOW_NO_AUTH=true (not recommended outside isolated local development).

Example:

docker run --rm -it \
  -e ADMIN_USER=myuser \
  -e ADMIN_PASS=mysecretpassword \
  -e REDIS_1_HOST=myredis.host \
  -e REDIS_1_NAME=MyRedis \
  -p 80:80 erikdubbelboer/phpredisadmin

The Docker Compose manifest also requires credentials. Start it with:

ADMIN_USER=myuser ADMIN_PASS=mysecretpassword docker-compose up --build

Source installations require a configured login or login_as_acl_auth entry. An operator can set allow_no_auth to true in includes/config.inc.php only for an intentionally isolated development instance.

Environment variables summary

• REDIS_1_HOST - define host of the Redis server
• REDIS_1_NAME - define name of the Redis server
• REDIS_1_PORT - define port of the Redis server
• REDIS_1_SCHEME - define scheme of the Redis server (tcp or tls)
• REDIS_1_AUTH - define password of the Redis server
• REDIS_1_AUTH_FILE - define file containing the password of the Redis server
• REDIS_1_DATABASES - You can modify you config to prevent phpRedisAdmin from using CONFIG command
• ADMIN_USER - define username for user-facing HTTP authentication
• ADMIN_PASS - define password for user-facing HTTP authentication
• ALLOW_NO_AUTH - set to true only to opt into unauthenticated access on an isolated development instance

TODO

• Encoding support for editing
• Javascript sorting of tables
• Better error handling
• Move or Copy key to different server
• Importing JSON
• JSON export with seperate objects based on your seperator

Credits

Icons by http://p.yusukekamiyamane.com/ (https://github.com/yusukekamiyamane/fugue-icons/tree/master/icons-shadowless)

Favicon from https://github.com/antirez/redis-io/blob/master/public/images/favicon.png