eqalpha/keydbmanager repository overview

⁠KeyDB Manager GUI

This is the KeyDB Manager GUI. It can be used to help monitor and manage KeyDB nodes. It allows additional visibility into your setup and enables you to manage your cluster.

⁠Run KeyDB Manager

Setup is easy, just run the docker container and go! Open a browser and connect to port 5000.

$ sudo docker run -p 0.0.0.0:5000:5000 eqalpha/keydbmanager

If you are running this container on the same server as your keydb node it is important to specify -p 0.0.0.0:5000:5000, however the 0.0.0.0 is not necessary if you are running on a different server. If you are connecting to a KeyDB node on the same server you launched keydbmanager, you should specify the server IP address, not loopback adapter.

⁠Set Password

Once you are connected you can enter your server password if set, to allow access to your nodes.

⁠Add Server Nodes

Under the Server Manager tab you can now add the KeyDB nodes you want to manage in the form :. If your connection is successful you will see the status of ‘Online’ along with information on the node you have just added.

⁠Cluster Management

Once you have added your server nodes you can switch to the Cluster Manager tab to manage your cluster, see status and add or remove nodes from the cluster easily right through the interface.

Use the “Add Node” button to inform the cluster node of its siblings, you will need to do this for each sibling server. When you are done the cluster status should say OK. You can also use this to remove cluster nodes. If a cluster node has slots assigned the tool will redistribute them to other nodes. In this way you can reduce the size of the cluster.

⁠Security Configuration

You will need to make sure the ports and ip addresses you need to connect to are available. This means making sure the computer you are using with your browser has access the ipaddress of the server your docker container is on at port 5000. You will also need to make sure keydbmanager has access to your KeyDB nodes and ports, otherwise it will not be able to see them.

⁠Development

This tool is in its early stages and visibility/features/functionality will continue to be added to it. If you have feature requests or functionality requests for this GUI please create or add to a topic in our community forum⁠