📡 P3X Redis UI: A highly functional and convenient database GUI that fits in your pocket, accessible on both responsive web and desktop applications
npm install p3x-redis-ui[//]: #@corifeus-header
    
🌌 Bugs are evident™ - MATRIX️
🚧 This project is under active development!
📢 We welcome your feedback and contributions.
``txt`
v24.10.0
[//]: #@corifeus-header:end
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.
and P3XRS_DOCKER_HOME environment variables.$3
- 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.$3
- 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.$3
- 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.$3
- Sub-directory Support: Utilize Nginx/Ingress to rewrite paths when used in a sub-directory.
- For more information, see Issue #43.$3
- Cluster Support: Recently added and continuously improving. Contributions by @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.
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.$3
For detailed information on potential vulnerabilities and mitigation strategies, please refer to our dedicated documentation.Access the Latest Online Version
Explore the most current iteration of our project at p3x.redis.patrikx3.com$3
- 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.
$3
Screenshots readme
Change log
The change log readme
Releases / Downloadable installer
https://github.com/patrikx3/redis-ui/releases MacOS Compatibility
Our application supports builds for both Intel and Apple Silicon architectures.
$3
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.
$3

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.
$3
AppImage, dep and rpm auto update itself.
#### 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 &
`
$3
The app can be found on ElectronJs Apps and search for P3X, you will find it.$3
Start up with a server or via a browser and NodeJs/NPM.
Start up with a server readmeSome description about the config file readme
Some description about the config connections readme
$3
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
$3
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 readmeDevelopment
For file names do not use camelCase, but use kebab-case. Folder should be named as kebab-case as well. As you can see, all code filenames are using it like that, please do not change that.
Please apply the
.editorconfig settings in your IDE.It creates a package that allows you to compose
p3x-redis-ui-server and p3x-redis-ui-material into one:Server on GitHub
Client on GitHub
If you develop on this app, you are required to test, that all JS you code write is working with Electron (as the embedded Electron NodeJs version is usually below the real NodeJs). Once the server and client is running as above, you clone this repo and test like this:
`bash
terminal 1
git clone https://github.com/patrikx3/redis-ui-material.git
cd redis-ui-material
npm install
npm run devterminal 2
git clone https://github.com/patrikx3/redis-ui-server.git
cd redis-ui-server
npm install
npm run devif you are not working on Electron, at this point you can fire the browser
@ http://localhost:8080/
terminal 3
git clone https://github.com/patrikx3/redis-ui.git
cd redis-ui
npm install
./scripts/start-local.sh
or
.\scripts\start-local.cmd
`$3
By default, only English is created, but given all strings are from a
JS` file, it is very quick to spawn another language eg. German, French, Spanish etc ...For a new language
English strings, for the web UI
English strings, for the Electron
Moment a new language for vendor (require moment/locale)
JSON Editor, to incorporate a new language
Moment a new language for Material (momentDateMap)
Humanize duration
P3X Redis UI playground
Corifeus P3X Redis UI
AlternativeTo Redis UI
Github.IO Page
Web development coding
Webfejlesztés
[//]: #@corifeus-footer
---
If you want to quickly and affordably develop your next digital project, visit corifeus.eu for expert solutions tailored to your needs.
---
Discover the powerful and free online networking tool at 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.
---
---
---
🚨 Important Changes: Any breaking changes are prominently noted in the readme to keep you informed.
---
P3X-REDIS-UI Build v2025.10.110
   
[//]: #@corifeus-footer:end