{"id":19446075,"url":"https://github.com/stitchfix/redis_ui_rails","last_synced_at":"2025-04-25T01:31:55.075Z","repository":{"id":57746475,"uuid":"520953225","full_name":"stitchfix/redis_ui_rails","owner":"stitchfix","description":"A Rails engine for inspecting your Redis instances","archived":false,"fork":false,"pushed_at":"2022-09-30T17:04:22.000Z","size":13064,"stargazers_count":3,"open_issues_count":0,"forks_count":0,"subscribers_count":16,"default_branch":"main","last_synced_at":"2025-03-30T13:02:40.703Z","etag":null,"topics":["deprecated","observability","rails","redis"],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stitchfix.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"MIT-LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":"CODEOWNERS","security":null,"support":null}},"created_at":"2022-08-03T16:22:45.000Z","updated_at":"2023-02-08T19:17:33.000Z","dependencies_parsed_at":"2022-08-28T05:40:45.704Z","dependency_job_id":null,"html_url":"https://github.com/stitchfix/redis_ui_rails","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchfix%2Fredis_ui_rails","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchfix%2Fredis_ui_rails/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchfix%2Fredis_ui_rails/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stitchfix%2Fredis_ui_rails/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stitchfix","download_url":"https://codeload.github.com/stitchfix/redis_ui_rails/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250738083,"owners_count":21479130,"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","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":["deprecated","observability","rails","redis"],"created_at":"2024-11-10T16:12:49.759Z","updated_at":"2025-04-25T01:31:54.187Z","avatar_url":"https://github.com/stitchfix.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![stitchfix](https://circleci.com/gh/stitchfix/redis_ui_rails.svg?style=svg)](https://app.circleci.com/pipelines/github/stitchfix/redis_ui_rails)\n\n# RedisUiRails\n\nA Rails engine for inspecting your Redis instances through a web UI.\n\nBuilt for teams that cannot easily use more direct access methods (e.g. console) to inspect their Redis instances.\n\n![Animated GIF of functionality](docs/demo.gif)\n\n## Installation\n\n1. Add this line to your application's Gemfile:\n\n```ruby\ngem 'redis_ui_rails'\n```\n\n2. In `config/routes.rb`, mount the engine\n\n```ruby\nRails.application.routes.draw do\n  mount RedisUiRails::Engine =\u003e \"/redis_ui\"\nend\n```\n\n3. Precompile your assets\n\n```bash\ncd path/to/your/rails/app/root\nbundle exec rake assets:precompile\n```\n\n4. Configure your engine.\n\nExample:\n\n```ruby\n# config/initializers/redis_ui_rail.rb\n\n# Each Redis \"instance\" is a hash, with the following symbolized key structure:\n#   :id (required) The ID used in the URL for this instance.\n#   :name (required) The name that differentiates this Redis instance from others.\n#   :url (required) The URL of the redis instance.\n#   :resource_links (optional) Quick links to resources related to this instance.\n#   :enabled (optional) Allows enabling per environment. Defaults to true.\n#\nRedisUiRails.configure do |config|\n  config.redis_instances = [\n    {\n      id: :local,\n      name: \"Local Queue and Cache\", # many apps share a queue and cache Redis locally\n      url: ENV[\"REDIS_URL\"],\n      enabled: Rails.env.development? || Rails.env.test?\n    },\n    {\n      id: :cache,\n      name: \"Cache\",\n      url: ENV.fetch(\"REDIS_CACHE_URL\"), # many apps have separate queue and cache Redis instances in production\n      resource_links: [\n        {\n          label: \"Custom Datadog Dashboard\",\n          url: \"https://myorg.datadoghq.com/path/to/your/dashhboard\"\n        }\n      ],\n      enabled: Rails.env.production?\n    }\n  ]\nend\n```\n\n## Local Development\n\n1. Requirements:\n\n- Ruby \u003e= 3.0\n- Direnv (don't forget your [rc file hook](https://direnv.net/docs/installation.html))\n\n2. Initial setup\n\n```\nbundle install\ncp .rspec.example .rspec\ncp .env.example .env\ndirenv allow\n```\n\n3. Run tests\n\n```\nbundle exec rspec spec\n```\n\n## Contributing\n\nWant to contribute? Awesome! Check out [our guidelines](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstitchfix%2Fredis_ui_rails","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstitchfix%2Fredis_ui_rails","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstitchfix%2Fredis_ui_rails/lists"}