[//]: #@corifeus-header [](https://www.npmjs.com/package/p3x-redis-ui) [](https://paypal.me/patrikx3) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software) [](https://network.corifeus.com/status/31ad7a5c194347c33e5445dbaf8) # 📡 P3X Redis UI: A highly functional and convenient database GUI that fits in your pocket, accessible on both responsive web and desktop applications v2026.4.125 🌌 **Bugs are evident™ - MATRIX️** 🚧 **This project is under active development!** 📢 **We welcome your feedback and contributions.** ### NodeJS LTS is supported ### 🛠️ Built on NodeJs version ```txt v24.14.0 ``` # 📝 Description [//]: #@corifeus-header:end ## Minimum Node.js Engine Requirement ```txt v22.0.0 ``` **p3x-redis-ui** is a versatile Redis GUI that can function as either a backend server on the web or as a desktop application. This open-source software is particularly effective for managing JSON, featuring integration with JSONEditor and ACE. Explore a variety of options in the 'edit json' button dialog, which also supports uploading and downloading binary data. Additionally, it handles SSH, cluster, and sentinel configurations. ## 30-Second Docker Quick Start ```bash mkdir -p ./p3x-redis-ui-settings docker run -d \ --name p3x-redis-ui \ -p 7843:7843 \ -v $PWD/p3x-redis-ui-settings:/settings \ patrikx3/p3x-redis-ui ``` Open: `http://localhost:7843` Localization available in the UI: - English (`en`) - Bulgarian (`bg`) - Czech (`cs`) - German (`de`) - Greek (`el`) - Spanish (`es`) - French (`fr`) - Hungarian (`hu`) - Italian (`it`) - Japanese (`ja`) - Dutch (`nl`) - Polish (`pl`) - Portuguese (`pt-PT`) - Romanian (`ro`) - Russian (`ru`) - Slovak (`sk`) - Serbian (`sr`) - Swedish (`sv`) - Turkish (`tr`) - Ukrainian (`uk`) - Chinese (`zn`) You can switch language in `Settings`. ## Adoption Notes (Downloads vs Redis Commander) `redis-commander` has significantly more Docker pulls mostly due to age, historical tutorial coverage, and automation pull volume in CI/Kubernetes. `p3x-redis-ui` adoption is still strong, and growth can be improved with better discoverability and copy-paste-first docs. Detailed analysis and action plan: [Adoption and Growth Notes](artifacts/readme/adoption-growth.md) ## Features ### Configuration and Security - **Secure Configuration:** Setup is intricate due to its roots in shared web applications, ensuring that passwords and sensitive data are safeguarded with unique identifiers for both main and node configurations. Node-specific IDs enhance security measures for node passwords. ### Compatibility and Usage - **Redis Versions and TLS:** Supports Redis 6 with TLS, enhancing security and data integrity. - For TLS configuration details, visit [Configuring Redis TLS](https://spin.atomicobject.com/2021/08/05/configuring-redis-tls/). - **Pika Compatibility:** Compatible with Pika, though not perfectly optimized. - **SSH Tunneling:** Functional for single instances, cluster, and sentinel configurations. - **Environmental Customizations:** Customize the server port and home directory via `P3XRS_PORT` and `P3XRS_DOCKER_HOME` environment variables. ### Data Handling - **Binary Data Management:** Special care is needed when handling binary data to prevent issues. Use the download button for binary data; direct editing in text mode is not supported for binary content. - **Large Data Sets:** Handles values larger than 256 kB, indicated by `[object ArrayBuffer]`. For large values, utilize binary upload and download capabilities. - **Clipboard Operations:** Text copying is supported directly; binary data requires using the download functionality. ### User Interface and Experience - **Desktop Shortcuts:** Access menus in the desktop version by pressing ALT. - **Responsive Design:** Fully responsive, ensuring usability on phones and tablets. - **Themes:** Choose between Dark - Dracula and light themes for personalized visual comfort. - **Data Visualization and Management:** - Tree view settings allow adjustments to key count from a minimum of 100 to a maximum of 100,000 to prevent crashes. - Deferred rendering in the tree view enhances performance by rendering only what is visible in the viewport. ### Advanced Features - **Monitoring and Logging:** Monitor all channel messages on the console with a simple checkbox. Console history is stored indefinitely in local storage, keeping the last 20 entries accessible. - **Database Interaction:** Select databases via the console or a dropdown menu, which also indicates whether databases are empty or filled. - **Search Functionality:** - Client-side mode for searching small sets of keys. - Server-side mode for efficient searching within large sets of keys. - Search can be configured to start with a specific string or include a string within the keys. ### Network Setup and Extensions - **Sub-directory Support:** Utilize Nginx/Ingress to rewrite paths when used in a sub-directory. - For more information, see [Issue #43](https://github.com/patrikx3/redis-ui/issues/43). ### Contributions and Support - **Cluster Support:** Recently added and continuously improving. Contributions by [@devthejo](https://github.com/devthejo) have significantly enhanced this functionality. - **Community and Feedback:** As this tool evolves, feedback and issue reporting are highly valued to refine and improve the features. Redis UI provides a powerful interface for managing Redis databases with a focus on security, efficiency, and user experience. Whether you are dealing with small or large data sets, p3x-redis-ui offers robust solutions tailored to meet diverse operational needs. <!-- 👷 **The first full complete version was created in 20 days in September of 2018.** --> <!-- ## Donated-Ware features **Until further notice, all donated-ware features are enabled for free. Please, test out your use case, how the JSON editor is helping you. Let us know!** The `p3x-redis-ui+` version has additional features. The donation is $1/month. Please contact at [alabard@gmail.com](mailto:alabard@gmail.com) and can donate @ https://paypal.me/patrikx3 The features that are only working in the donated-ware version: * JSON editor * Cluster * Sentinel To check if your license is valid @ https://server.patrikx3.com/api/patrikx3/redis-ui/status/your-license-key #### New features Users, that donated, have a big chance that requests for new features will be implemented. ##### New features * SSH tunnel * Upload binary data ##### To write * Collapse/expand recursively on individual leafs #### Plus function problems Given, I do not have a full fledged server and to maintain the servers it costs money, it is possible, sometimes the server goes down. It is rare, but it will be back up probably in 5-10 minutes. If there is a problem that is longer, please contact me. ### Contributors license Contributors get plus donate license for free for a year. Contributors, that created features that are working only in the donate-ware version get a license for life. --> ## Important Notice To ensure accuracy and minimize errors, we strongly advise against manually creating the configuration `JSON` file using a text editor. Instead, utilize the GUI to generate the configuration, which can then be seamlessly integrated into systems like Kubernetes. ## Optional HTTP Basic Authentication The server can protect both HTTP routes and Socket.IO with HTTP Basic authentication. Config (`p3xrs.json`): ```json { "p3xrs": { "httpAuth": { "enabled": true, "username": "admin", "passwordHash": "$2b$10$..." } } } ``` Generate BCrypt password hash: ```bash node ./node_modules/p3x-redis-ui-server/bin/bcrypt-password.js -p myplainpass ``` Environment variables: - `HTTP_USER` - `HTTP_PASSWORD` - `HTTP_PASSWORD_HASH` - `HTTP_PASSWORD_HASH_FILE` - `HTTP_AUTH_ENABLED` (`true|false`) CLI options: - `--http-auth-enable` - `--http-auth-disable` - `--http-auth-username` - `--http-auth-password` - `--http-auth-password-hash` - `--http-auth-password-hash-file` Notes: - `passwordHash` is preferred over plain `password`. - Use HTTPS/reverse proxy TLS when HTTP auth is enabled. ## License Integration The app validates licenses through `network.corifeus.com` for product `p3x-redis-ui`. - Validation endpoint: `GET https://network.corifeus.com/public/license/check/:licenseKey` - Returned data is shown in `Settings -> License`: - tier - validity and status - reason - starts/expires/check timestamps - days left - enabled features - License key is never shown in full on the client; only masked form is displayed. - License state refresh runs every 60 minutes (server + client refresh flow). ### Tier Feature Policy - `free` - core Redis UI only; no SSH tunneling, no Readonly connection mode, no Cluster/Sentinel, no Edit JSON/Upload binary/Download binary. - Price: `0 HUF/month (€0/month)`. - `pro` - SSH tunneling, Readonly connection mode (including `--readonly-connections`/`-r`), Edit JSON, Upload binary, Download binary. - Base price: `1,200 HUF/month (€3/month)` or `12,000 HUF/year (€30/year)`. - Total with `27%` VAT: `1,500 HUF/month (€3.81/month)` or `15,200 HUF/year (€38.10/year)`. - `enterprise` - SSH tunneling, Cluster and Sentinel, plus Edit JSON, Upload binary, Download binary; `--readonly-connections`/`-r` also works. - Base price: `3,600 HUF/month (€9/month)` or `36,000 HUF/year (€90/year)`. - Total with `27%` VAT: `4,600 HUF/month (€11.43/month)` or `45,700 HUF/year (€114.30/year)`. - Yearly rule: yearly price is `10x` the monthly price. - Default license includes `5 seats`; if you need more seats, contact us at [`support@corifeus.com`](mailto:support@corifeus.com). - Enterprise trial: `10 days` free for anyone with a real existing email address (non-test email). - Billing info in e-mail: `Name, Billing e-mail, Country code, Postal code, City, Address, VAT ID (optional)`. - Payment note: PayPal payment is accepted only in `HUF` (Hungarian forint). - VAT note: VAT is added to paid plan prices (`27%` in Hungary). - Contact: [`support@corifeus.com`](mailto:support@corifeus.com). - Invoice/license e-mail communication is in English. Invoice currency is HUF. - This policy matches the Tier policy popup information shown at initialization. - Note: license validation requires internet access. Enforcement: - backend enforces tier rules on connection save/connect/test paths - backend enforces Pro+ for binary value writes (`key-set`, `key-new-or-set`) - frontend mirrors the rules in UI controls (hide/disable + localized messages) - `--readonly-connections` (`-r`) is effective when active license tier is `pro` or `enterprise` ### License Editing Policy (`p3xrs.json`) License editability is controlled by server config: - `p3xrs.licenseEditable` (recommended) - legacy fallback: `p3xrs.editableActive` - legacy fallback: `p3xrs.disabled` (inverted) If license editing is disabled: - the `Edit` button is disabled in the UI - the UI shows terminal-only notice (EN/ZH/RU) - server blocks license updates (`license_readonly`), so it cannot be bypassed from the browser/API Example: ```json { "p3xrs": { "licenseEditable": false } } ``` After changing `p3xrs.json`, restart the server. ### Awareness of AngularJs Security Risks For detailed information on potential vulnerabilities and mitigation strategies, please refer to our [dedicated documentation](artifacts/readme/angularjs.md). ## Access the Latest Online Version Explore the most current iteration of our project at [p3x.redis.patrikx3.com](https://p3x.redis.patrikx3.com) ### Operational Insights: - **Data Restoration:** Our Redis database automatically restores certain datasets every morning at CET, offering a fresh start daily. Feel free to experiment as needed. - **Application Stability:** You may notice brief downtime (about 1 second) in our test application, possibly due to automatic updates triggered by changes in the Git repository. - **Version Consistency:** Please be aware that the live snapshot might differ from the versions available on GitHub or NPM. Updates and new features are typically released monthly or as developments occur. ### Screenshots [Screenshots readme](artifacts/readme/screenshots.md) ## Change log [The change log readme](change-log.md) ## Releases / Downloadable installer https://github.com/patrikx3/redis-ui/releases ## MacOS Compatibility Our application supports builds for both Intel and Apple Silicon architectures. ### Handling Downloaded Files from GitHub Although I'm not an Apple expert, if you download the `zip` file for the `arm64` version, you'll need to execute the following command on the unzipped app to remove the quarantine attribute applied by macOS: ```bash sudo xattr -rd com.apple.quarantine P3X-Redis-UI.app ``` This command ensures that your system trusts the application, allowing it to run smoothly without security interruptions from macOS. ### Snap <!-- The main source installer is the `AppImage`, so, the themes are not implemented (the main menus). If you want the themes to be implemented (dark vs light), I suggest using the `AppImage` as it supports the themes natively. Besides, the auto self update function is not implemented in `Snap`, only in `AppImage` version. --> [](https://snapcraft.io/p3x-redis-ui#cory-non-external) ## Flathub You download from the releases page and install as: ```sh wget https://github.com/patrikx3/redis-ui/releases/download/v${VERSION}/P3X-Redis-UI-${VERSION}-x86_64.flatpak flatpak install ./P3X-Redis-UI-${VERSION}-x86_64.flatpak flatpak run com.patrikx3.redis_ui ``` Besides the menu is integrated. ### AppImage, dep, rpm AppImage, dep and rpm auto update itself. <!-- #### To integrate into the menu using AppImage Execute: ```bash sudo add-apt-repository ppa:appimagelauncher-team/stable sudo apt-get update sudo apt-get install appimagelauncher ``` --> #### After downloading the AppImage, make it an executable. ```bash mkdir -p $HOME/opt mv ~/Downloads/p3x-redis-ui-a.b.c-x86_64.AppImage $HOME/opt/ chmod +x $HOME/opt/p3x-redis-ui-a.b.c-x86_64.AppImage # Then you can run it $HOME/opt/p3x-redis-ui-a.b.c-x86_64.AppImage & ``` <!-- It then actually integrates itself into the menus and it will auto update itself. --> ### On ElectronJs The app can be found on [ElectronJs Apps](https://electronjs.org/apps) and search for `P3X`, you will find it. ### CLI Start up with a server or via a browser and NodeJs/NPM. [Start up with a server readme](artifacts/readme/start-up-server.md) [Some description about the config file readme](p3xrs.json) [Some description about the config connections readme](.p3xrs-conns.json) [Example of config connections](.p3xrs-conns-example.json) ### Docker https://hub.docker.com/r/patrikx3/p3x-redis-ui #### Compose https://github.com/patrikx3/redis-ui/blob/master/docker-compose.yml ```bash wget https://raw.githubusercontent.com/patrikx3/redis-ui/master/docker-compose.yml # You might want to tune the settings folder in the docker-compose.yml. # the /home/user/p3x-redis-ui-settings settings folder in yml should be set by yourself. docker-compose up ``` #### Bare ```bash # you can tune the settings folder # in the -v first part is where you can set your own folder mkdir -p ./p3x-redis-ui-settings docker run -v $PWD/p3x-redis-ui-settings:/settings -h docker-p3x-redis-ui -p 7843:7843 -t -i patrikx3/p3x-redis-ui ``` The GUI will be @ http://localhost:7843 ### Kubernetes A complete example of deployment `p3x-redis-ui` in kubernetes using raw manifests https://github.com/patrikx3/redis-ui/blob/master/k8s/manifests ```bash kubectl apply -f namespace.yaml # Do not forget to edit redis host and password configuration kubectl apply -f configmap.yaml kubectl apply -f deployment.yaml kubectl apply -f service.yaml kubectl apply -f ingress.yaml ``` Helm chart `p3x-redis-ui` deployment in kubernetes https://github.com/patrikx3/redis-ui/blob/master/k8s/chart ```bash helm template -f values.yaml release --namespace namespace . > generated.yaml kubectl apply -f generated.yaml ``` # Contributors [The contributors readme](contributors.md) # Solution Interestingly, this solution doesn't employ REST; it opts for Socket.IO instead! 😄 It might seem a bit unconventional, but I actually appreciate the choice. Using Socket.IO is expected to be more responsive, as it avoids the significant overhead associated with the HTTP protocol. This approach should provide a smoother and faster interaction experience. ## Reference for Socket.IO speed https://www.google.com/search?q=rest+vs+websocket+comparison+benchmarks # URL links [P3X Redis UI playground](https://www.patrikx3.com/en/front/playground/19/p3x-reds-ui#PG19) [Corifeus P3X Redis UI](https://corifeus.com/redis-ui/) [AlternativeTo Redis UI](https://alternativeto.net/software/p3x-redis-ui/) [NPM P3X Redis UI](https://www.npmjs.com/package/p3x-redis-ui) [Snap Store](https://snapcraft.io/p3x-redis-ui) [Github.IO Page](https://patrikx3.github.io/redis-ui/) [Web development coding](https://corifeus.eu/) [Webfejlesztés](https://corifeus.hu/) [//]: #@corifeus-footer --- ## 🚀 Quick and Affordable Web Development Services If you want to quickly and affordably develop your next digital project, visit [corifeus.eu](https://corifeus.eu) for expert solutions tailored to your needs. --- ## 🌐 Powerful Online Networking Tool Discover the powerful and free online networking tool at [network.corifeus.com](https://network.corifeus.com). **🆓 Free** Designed for professionals and enthusiasts, this tool provides essential features for network analysis, troubleshooting, and management. Additionally, it offers tools for: - 📡 Monitoring TCP, HTTP, and Ping to ensure optimal network performance and reliability. - 📊 Status page management to track uptime, performance, and incidents in real time with customizable dashboards. All these features are completely free to use. --- ## ❤️ Support Our Open-Source Project If you appreciate our work, consider ⭐ starring this repository or 💰 making a donation to support server maintenance and ongoing development. Your support means the world to us—thank you! --- ### 🌍 About My Domains All my domains, including [patrikx3.com](https://patrikx3.com), [corifeus.eu](https://corifeus.eu), and [corifeus.com](https://corifeus.com), are developed in my spare time. While you may encounter minor errors, the sites are generally stable and fully functional. --- ### 📈 Versioning Policy **Version Structure:** We follow a **Major.Minor.Patch** versioning scheme: - **Major:** 📅 Corresponds to the current year. - **Minor:** 🌓 Set as 4 for releases from January to June, and 10 for July to December. - **Patch:** 🔧 Incremental, updated with each build. **🚨 Important Changes:** Any breaking changes are prominently noted in the readme to keep you informed. --- [**P3X-REDIS-UI**](https://corifeus.com/redis-ui) Build v2026.4.125 [](https://www.npmjs.com/package/p3x-redis-ui) [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [](https://www.patrikx3.com/en/front/contact) [](https://www.facebook.com/corifeus.software) [//]: #@corifeus-footer:end