P3X GitList

dc2f3005

[//]: #@corifeus-header

938d92ce

8af24a23

[![NPM](https://img.shields.io/npm/v/p3x-redis-ui.svg)](https://www.npmjs.com/package/p3x-redis-ui) [![Donate for Corifeus / P3X](https://img.shields.io/badge/Donate-Corifeus-003087.svg)](https://paypal.me/patrikx3) [![Contact Corifeus / P3X](https://img.shields.io/badge/Contact-P3X-ff9900.svg)](https://www.patrikx3.com/en/front/contact) [![Corifeus @ Facebook](https://img.shields.io/badge/Facebook-Corifeus-3b5998.svg)](https://www.facebook.com/corifeus.software) [![Uptime Robot ratio (30 days)](https://img.shields.io/uptimerobot/ratio/m780749701-41bcade28c1ea8154eda7cca.svg)](https://stats.uptimerobot.com/9ggnzcWrw)

dc2f3005

3288870e

dc2f3005

dde0390b

3dceff72

# 📡 P3X Redis UI is a very functional handy database GUI and works in your pocket on the responsive web or as a desktop app v2024.4.187

938d92ce

e40e5cb9

938d92ce

**Bugs are evident™ - MATRIX️**

50a75380

dc2f3005

efcbe1da

### NodeJS LTS is supported ### Built on NodeJs version

96634601

```txt

296b2bbe

v20.12.0

938d92ce

```

dc2f3005

938d92ce

# Description

dc2f3005

[//]: #@corifeus-header:end

25bfe903

`p3x-redis-ui` is a new Redis GUI which can serve as a backend server or as a desktop application.

eb8c4ff6

Some of the features are coming below.

4263a4de

The best use case for this Redis GUI, if you manage tons of JSON, as it includes JSONEditor and ACE. Check out the different options in the edit json button dialog, besides, you can upload and download binary data as well.

25bfe903

40bdf6b0

a4de9458

## Features

cb715f53

* Please, careful, the values can show, but if you want to use binary data, only save, when you uploaded, an it says `[object ArrayBuffer]`, as you save a text and it will not work anymore after you download the binary data

a4de9458

* Copying to the clipboard, it is only working with text. Binary data wil not work. Use the download binary button. * If you are using a value that is bigger than 0.5MB, it will say `[object ArrayBuffer]`, that is ok, for big values, use binary (upload binary, download binary) * You can download and upload binary files in string, hash, list, set and zset * The console history is kept indefinite in the local storage * Redis 6 with TLS is enabled with this information: * https://spin.atomicobject.com/2021/08/05/configuring-redis-tls/ * You can override the server port via an environment variable `P3XRS_PORT` * You can override the server home directory via an environment variable `P3XRS_DOCKER_HOME` * In the connections, you can enable read only mode, which means, the user will not be able to modify via gui and the console (only pub/sub monitor and select database is allowed) is disabled. * In a sub-directory, you can use Nginx/Ingress to rewrite your paths. * https://github.com/patrikx3/redis-ui/issues/43 * To show the menu in the desktop version, click ALT * There is a new feature in the settings/tree setting, which limits the received keys, the minimum is 100, the maximum is 100k, so there is no more crash, because of that * Since `v2020.4.189`, the tree can handle bigger key count, as of now, we are using deferred rendering for the tree - only rendering what is in the viewport, so it should be much faster versus rendering everything at once * Please, check out your Redis use case, if this program can cover your requirements

3dceff72

* **Does work with sentinel**, but it is new, so please file issues with errors, I will fix it quickly

a4de9458

* **Has cluster support** * Thanks so much for the awesome contribution by [@idetoile](https://github.com/idetoile) (now -> [@devthejo](https://github.com/devthejo)) of the cluster function. * Able to monitor all channel messages on the console by using a checkbox. * Works with multiple languages * Works as a backend * Works as a desktop via Electron * Linux * Windows * MacOS (Intel & Apple silicon) * Starts with no settings without config, or setup your own config * Able to create, test, save, delete multiple connections or a readonly connections setup, for shared usage* * Online you are able to choose the tree separator, for example :, /, -, space etc... or even empty separator * It is based on Redis-Commander and phpRedisAdmin * You can select the database via console or the drop down. * The database select drop down shows if the checked database is empty or filled, so you can always know which is filled * Save button to save the db * Full statistics pages, can be useful * This is just a New Kind on the Block in the Redis world, so, of course, there are advantages and disadvantages in the other Redis GUIs * Dark - Dracula / light themes * Search * Client side mode searching in keys - small key set * Server side mode searching in keys - large key set * Search mode * the search keys starts with a string key * the search keys includes a string in the key * The app is responsive, it works on a phone/tablet as well * There is a key sorting function, which has a penalty, because it sorts with natural-compare, which means it is more human display, then just raw characters, but up to 100k the keys is still ok. * For big key set to be usable paging should be a maximum 1000 keys / page, though for 250 is the sweetest spot

761955e6

<!--

1b52ce02

👷 **The first full complete version was created in 20 days in September of 2018.**

761955e6

-->

fab2a8a0

cf8263c1

<!--

4674e7e5

## Donated-Ware features

cf8263c1

**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!**

4674e7e5

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:

1b5a8e39

* JSON editor

2833c08c

* Cluster * AWS ElastiCache * Gcloud memorystore

d2cb6794

* Azure Redis

4674e7e5

5a4b3025

To check if your license is valid @

00fb1ffb

https://server.patrikx3.com/api/patrikx3/redis-ui/status/your-license-key

5a4b3025

7a808ec0

#### New features Users, that donated, have a big chance that requests for new features will be implemented. ##### Possible new features * SSH tunnel * Upload binary data

59ff64f3

* Collapse/expand recursively on individual leafs

7a808ec0

4674e7e5

#### 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.

73fee311

### Contributors license

1c53be20

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.

cf8263c1

-->

65bad552

## Warning

7829b6a5

It is not recommend to generate the configuration `JSON` via a text editor. The perfect solution is to generate the configuration in the GUI, then apply for example in Kubernetes.

9c8129d1

### AngularJs Vulnerabilities

c13505f5

[README and comments](artifacts/readme/angularjs.md)

9c8129d1

91878c5e

## The online current version

c4c51213

https://p3x.redis.patrikx3.com

ac6711fa

d5484249

This Redis database every day in the morning European time CET restores some data, so you may do whatever you want to do.

29a58777

Besides, you could experience the test app to exit for 1 second, because it could auto update itself. It auto updates itself when the code from Git changes.

91878c5e

8379ebf3

Third, it is a snapshot, it is possible, that the features are different from GitHub or NPM as the releases are usually monthly or as they happen.

d31a0baa

151ecda6

1ac99fb3

### Screenshots

c13505f5

[Screenshots readme](artifacts/readme/screenshots.md)

1ac99fb3

1b472fe4

## Change log [The change log readme](change-log.md)

60e6243e

## Releases / Downloadable installer

9233c5a5

https://github.com/patrikx3/redis-ui/releases

235436b9

### Snap

6ff9beca

<!--

e87dac90

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.

6ff9beca

-->

235436b9

[![LINK](https://snapcraft.io/static/images/badges/en/snap-store-black.svg)](https://snapcraft.io/p3x-redis-ui#cory-non-external)

3fc1bea9

## Flathub

d0978602

You download from the releases page and install as: ```sh

b0c76b67

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

3ffeec56

flatpak run com.patrikx3.redis_ui

d0978602

```

3fc1bea9

1f9de89a

Besides the menu is integrated.

3fc1bea9

5b1f78e8

### AppImage, dep, rpm

235436b9

1fd2b7ee

AppImage, dep and rpm auto update itself. #### To integrate into the menu using AppImage

b506cc39

Execute: ```bash

524cd365

sudo add-apt-repository ppa:appimagelauncher-team/stable sudo apt-get update sudo apt-get install appimagelauncher

b506cc39

```

54f4d238

#### After downloading the ```AppImage```, make it an executable.

82fb3264

```bash mkdir -p $HOME/opt

96df46d6

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

82fb3264

# Then you can run it

96df46d6

$HOME/opt/p3x-redis-ui-a.b.c-x86_64.AppImage &

82fb3264

```

b506cc39

448b1b37

<!--

82fb3264

It then actually integrates itself into the menus and it will auto update itself.

448b1b37

-->

82fb3264

419caced

### On ElectronJs The app can be found on [ElectronJs Apps](https://electronjs.org/apps) and search for `P3X`, you will find it.

519c9f09

### CLI Start up with a server or via a browser and NodeJs/NPM.

1ac99fb3

[Start up with a server readme](artifacts/readme/start-up-server.md)

26eb81be

1ac99fb3

[Some description about the config file readme](p3xrs.json)

1410a8a4

### Docker

8374beae

e68204c4

https://hub.docker.com/r/patrikx3/p3x-redis-ui

02be926f

#### Compose

0c0bf556

https://github.com/patrikx3/redis-ui/blob/master/docker-compose.yml

2c829153

eb0840cf

60bd8338

0c0bf556

```bash

1c86b334

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.

5df55285

# the /home/user/p3x-redis-ui-settings settings folder in yml should be set by yourself.

1c86b334

docker-compose up

0c0bf556

```

02be926f

#### 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 ```

eb0840cf

The GUI will be @ http://localhost:7843

fc09472e

### Kubernetes

2149a8b4

1d535924

A complete example of deployment `p3x-redis-ui` in kubernetes using raw manifests

2149a8b4

https://github.com/patrikx3/redis-ui/blob/master/k8s/manifests

fc09472e

```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 ```

2149a8b4

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 ```

38b36b09

4222cfb3

# Contributors

28dc38a8

[The contributors readme](contributors.md)

4222cfb3

505e7f6b

# Development

94e8f7b5

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.

505e7f6b

It creates a package that allows you to compose `p3x-redis-ui-server` and `p3x-redis-ui-material` into one: [Server on GitHub](https://github.com/patrikx3/redis-ui-server) [Client on GitHub](https://github.com/patrikx3/redis-ui-material)

2396bb87

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

b463ac9f

# terminal 1 git clone https://github.com/patrikx3/redis-ui-material.git cd redis-ui-material npm install npm run dev # terminal 2 git clone https://github.com/patrikx3/redis-ui-server.git cd redis-ui-server npm install npm run dev

6d3172c0

# if you are not working on Electron, at this point you can fire the browser # @ http://localhost:8080/

b463ac9f

# terminal 3

2396bb87

git clone https://github.com/patrikx3/redis-ui.git cd redis-ui npm install ./scripts/start-local.sh # or

e399aea6

.\scripts\start-local.cmd

2396bb87

```

40a322b4

### Development of the translations

505e7f6b

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 ...

792681ae

[English strings, for the web UI](https://github.com/patrikx3/redis-ui-material/blob/master/src/strings/en/strings.js)

d0cec6ac

[English strings, for the Electron](https://github.com/patrikx3/redis-ui/blob/master/src/strings/en/index.js) [JSON Editor, to incorporate a new language](https://github.com/patrikx3/redis-ui-material/blob/master/src/angular/dialog/p3xr-dialog-json-editor.js) [Moment a new language for Material (momentDateMap)](https://github.com/patrikx3/redis-ui-material/blob/master/src/core/settings.js) [Moment a new language for vendor (require moment/locale)](https://github.com/patrikx3/redis-ui-material/blob/master/src/vendor.js)

84048db4

For a new language:

d0cec6ac

Add into `redis-ui-material/src/main.js`.

84048db4

e34bf7b3

# Solution

2e5d48ea

This solution is not using REST at all, but instead uses Socket.IO 🤣, which is weird, but I like it, it is supposed to be more responsive, as there is no big overhead in the HTTP protocol.

e34bf7b3

## Reference for Socket.IO speed

01327058

https://www.google.com/search?q=rest+vs+websocket+comparison+benchmarks

5fe558e3

ee0324d3

# URL links

2880201c

[P3X Redis UI playground](https://www.patrikx3.com/en/front/playground/19/p3x-reds-ui#PG19)

96634601

[Corifeus P3X Redis UI](https://corifeus.com/redis-ui/)

ee0324d3

[AlternativeTo Redis UI](https://alternativeto.net/software/p3x-redis-ui/)

ee4dba38

[NPM P3X Redis UI](https://www.npmjs.com/package/p3x-redis-ui)

ee0324d3

51d9ec58

[Snap Store](https://snapcraft.io/p3x-redis-ui)

0204b642

[Github.IO Page](https://patrikx3.github.io/redis-ui/)

dc2f3005

[//]: #@corifeus-footer ---

7df22d73

🙏 This is an open-source project. Star this repository, if you like it, or even donate to maintain the servers and the development. Thank you so much! Possible, this server, rarely, is down, please, hang on for 15-30 minutes and the server will be back up. All my domains ([patrikx3.com](https://patrikx3.com) and [corifeus.com](https://corifeus.com)) could have minor errors, since I am developing in my free time. However, it is usually stable.

938d92ce

**Note about versioning:** Versions are cut in Major.Minor.Patch schema. Major is always the current year. Minor is either 4 (January - June) or 10 (July - December). Patch is incremental by every build. If there is a breaking change, it should be noted in the readme.

c34f1c46

6a4d4384

---

dc2f3005

3dceff72

[**P3X-REDIS-UI**](https://corifeus.com/redis-ui) Build v2024.4.187

dc2f3005

296b2bbe

[![NPM](https://img.shields.io/npm/v/p3x-redis-ui.svg)](https://www.npmjs.com/package/p3x-redis-ui) [![Donate for Corifeus / P3X](https://img.shields.io/badge/Donate-Corifeus-003087.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=QZVM4V6HVZJW6) [![Contact Corifeus / P3X](https://img.shields.io/badge/Contact-P3X-ff9900.svg)](https://www.patrikx3.com/en/front/contact) [![Like Corifeus @ Facebook](https://img.shields.io/badge/LIKE-Corifeus-3b5998.svg)](https://www.facebook.com/corifeus.software)

dc2f3005

938d92ce

994f7ed8

b133a4e6

[//]: #@corifeus-footer:end