{"id":21288983,"url":"https://github.com/hollodotme/readis","last_synced_at":"2025-10-17T13:27:49.692Z","repository":{"id":50942973,"uuid":"42013165","full_name":"hollodotme/readis","owner":"hollodotme","description":" Lightweight web frontend in PHP for reading data, stats and config from multiple redis servers.","archived":false,"fork":false,"pushed_at":"2024-09-10T02:03:29.000Z","size":7818,"stargazers_count":38,"open_issues_count":3,"forks_count":6,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-07-11T15:29:53.140Z","etag":null,"topics":["php","redis","redis-server","stats","webapp"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/hollodotme.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-09-06T18:24:57.000Z","updated_at":"2024-04-22T17:30:53.000Z","dependencies_parsed_at":"2025-04-25T20:01:29.561Z","dependency_job_id":"2abbfff0-5640-421a-8a85-e7bf4095d38d","html_url":"https://github.com/hollodotme/readis","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/hollodotme/readis","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2Freadis","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2Freadis/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2Freadis/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2Freadis/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/hollodotme","download_url":"https://codeload.github.com/hollodotme/readis/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/hollodotme%2Freadis/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279352127,"owners_count":26154070,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-17T02:00:07.504Z","response_time":56,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["php","redis","redis-server","stats","webapp"],"created_at":"2024-11-21T12:32:49.362Z","updated_at":"2025-10-17T13:27:49.649Z","avatar_url":"https://github.com/hollodotme.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"![Build](https://github.com/hollodotme/readis/workflows/Build/badge.svg)\n[![Latest Stable Version](https://poser.pugx.org/hollodotme/readis/v/stable)](https://packagist.org/packages/hollodotme/readis) \n[![License](https://poser.pugx.org/hollodotme/readis/license)](https://packagist.org/packages/hollodotme/readis)\n\n# re\u003csup style=\"color: #ff0000;\"\u003ea\u003c/sup\u003edis\n\nA web interface to read data from redis server(s)\n\n## Docker image\n\n**[You can find a ready to run docker image here.](https://hub.docker.com/r/hollodotme/readis/)**\n\n```bash\ndocker pull hollodotme/readis\n```\n\n## Features\n\n * Setup / Selection for multiple redis servers\n * Mapping database keys to expressive database names\n * Selection of a database inside a redis server\n * Searching for keys (with placeholders) inside a database\n * Listing of found keys with variable limit\n * Basic information about keys\n * Viewing the content of all key types\n * Viewing all elements/members/fields in lists, (sorted) sets and hashes all at once\n * Prettified JSON view, if value is a compact JSON string\n * Listing of slow logs\n * Table with all the current server instance information / stats\n * Table with all the current server configs\n * Real-time server monitor for connected clients and I/O in KB/sec.\n\n## Requirements\n\n * Webserver (nginx, apache2, etc.)\n * PHP \u003e= 7.1 with phpredis extension\n * [composer](https://getcomposer.org)\n\n## Installation\n\nAssuming you'll install re\u003csup style=\"color: #ff0000;\"\u003ea\u003c/sup\u003edis under `/var/www/readis` on your server.\n\n1. SSH into your webserver.\n2. `$ git clone https://github.com/hollodotme/readis.git /var/www/readis`\n3. `$ cd /var/www/readis`\n4. `$ git checkout v2.0.0`\n6. `$ composer install -a --no-dev --no-interaction`\n7. `$ cp config/app.sample.php config/app.php`\n8. Set up the baseUrl in `config/app.php` (Should be the full HTTP URL with path, e.g. `https://www.example.com/readis/`) \n9. `$ cp config/servers.sample.php config/servers.php`\n10. Set up all server instances in `config/servers.php`\n11. Set up your webserver VHost with document root `/var/www/readis/public`  \n\n### Sample app configuration \n\n* File: `config/app.php`\n\nUsing re\u003csup style=\"color: #ff0000;\"\u003ea\u003c/sup\u003edis under a separate (sub-)domain:\n\n```php\n\u003c?php\n\nreturn [\n\t'baseUrl' =\u003e 'http://readis.example.com',\n];\n```\n\nUsing re\u003csup style=\"color: #ff0000;\"\u003ea\u003c/sup\u003edis under a path of a domain:\n\n```php\n\u003c?php\n\nreturn [\n\t'baseUrl' =\u003e 'http://www.example.com/readis',\n];\n```\n\n### Sample server configuration\n\n* File: `config/servers.php`\n\n```php\n\u003c?php\n\nreturn [\n\t[\n\t\t'name'          =\u003e 'Local redis server 1',\n\t\t'host'          =\u003e '127.0.0.1',\n\t\t'port'          =\u003e 6379,\n\t\t'timeout'       =\u003e 2.5,\n\t\t'retryInterval' =\u003e 100,\n\t\t'auth'          =\u003e null,\n\t\t'databaseMap'   =\u003e [\n\t\t\t'0' =\u003e 'Sessions',\n\t\t\t'1' =\u003e 'Sample Data',\n\t\t\t// ...\n\t\t],\n\t],\n\t/*\n\t[\n\t\t'name'          =\u003e 'Local redis server 2',\n\t\t'host'          =\u003e '127.0.0.2',\n\t\t'port'          =\u003e 6379,\n\t\t'timeout'       =\u003e 2.5,\n\t\t'retryInterval' =\u003e 100,\n\t\t'auth'          =\u003e null,\n\t\t'databaseMap'   =\u003e [\n\t\t\t'0' =\u003e 'Sessions',\n\t\t\t'1' =\u003e 'Sample Data',\n\t\t\t// ...\n\t\t],\n\t],\n\t*/\n];\n```\n\nYou can map the numeric database keys to plain text names. \nKeys that were not mapped will still be displayed as `Database [KEY]`.\n\n**Please note:** If the `CONFIG` command is disabled in your redis server, the database map becomes the fallback \nlisting of available databases.\n\n**Regarding auth/password:**  \nIf your redis server is not started with the `requirepass` option and a password, the value for the `auth` config value\nmust be `null` (not an empty string or `false`). \n\n### Sample nginx configuration\n\n```nginx\nserver {\n\tlisten 80;\n\t\n\t# Change the domain name\n\tserver_name www.your-domain.net;\n\n\troot /var/www/readis/public;\n\tindex index.php;\n\n\tlocation / {\n\t\ttry_files $uri $uri/ /index.php?$args;\n\t}\n\n\tlocation ~ \\.php$ {\n\t\tfastcgi_split_path_info ^(.+\\.php)(/.+)$;\n\t\tfastcgi_pass unix:/var/run/php/php7.1-fpm.sock;\n\t\tfastcgi_index index.php;\n\t\tinclude fastcgi_params;\n\t}\n}\n```\n\n**That's it.**\n\n## Run locally\n\nIn order to run re\u003csup style=\"color: #ff0000;\"\u003ea\u003c/sup\u003edis locally, follow these steps:\n\n1. `$ git clone https://github.com/hollodotme/readis.git`\n2. `$ cd readis/`\n3. `$ composer update -o`\n4. `$ cp config/app.sample.php config/app.php` \n5. `$ cp config/servers.sample.php config/servers.php`\n6. `$ php -S 127.0.0.1:8080 -t public/` (starts local webserver)\n7. `$ docker-compose up -d redis` (starts redis-server instance on `localhost:6379`)\n8. Open: http://127.0.0.1:8080\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhollodotme%2Freadis","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhollodotme%2Freadis","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhollodotme%2Freadis/lists"}