1. Project Overview

Etcd Workbench

A beautiful, lightweight, and privately deployable ETCD V3 client that supports SSL and SSH Tunnel connections, as well as multi-account session management.

2. Open Source License

Licensed under Apache-2.0

3. Screenshots

Screenshot

This tool provides both dark and light themes.

Cluster Management 

Key Management 

Tree View Support 

Key Editor 

Version Comparison Support 

User Management 

Role Management  

4. Feature Overview

Why Choose This Tool?

1. Official client tools offer limited functionality and poor online editing experiences. This tool provides SSH tunnel connections, online code editing, version comparison, quick copying, and other features to make configuration center management more efficient!

2. Most useful third-party tools require payment.

3. This tool is completely open source and free!

5. Tech Stack

Private Deployment

First, ensure that your local environment has JDK 11 or later installed. Download the latest JAR package from the releases page and execute:

java -jar etcd-workbench.jar

Visit [http://localhost:8002](http://localhost:8002) in your browser.

Private Deployment Documentation

Configuration File

Deployment configuration is simple. Only one configuration file is required, and it contains very few settings.

etcd-workbench.conf

[server]
# Configure the port the service will run on.
port = 8002
# Configure the timeout for executing instructions to ETCD server, in milliseconds.
etcdExecuteTimeoutMillis = 3000
# Configure data storage directory.
dataDir = ./data
# If Authentication is turned on, in order to ensure that user data is not easily cracked,
# configure the data signature key to encrypt and protect it. It must be 16 characters.
configEncryptKey = etcdWorkbench@*?

[auth]
# If set to true, user must log in to use etcd workbench, and add the user field to configure the user.
# If set to false, all connection data can be used and shared by anyone!!!
enable = false
# If enabled authentication, add username and password with `user` field.
# Supports repeatedly adding multiple `user` fields.
user = username1:password1
user = username2:password2

[log]
# Base log level
level = INFO
# Customize the log level of the specified path.
levels = io.netty:INFO,io.grpc:INFO
# Configure log storage directory.
file = ./logs
# Configure log file name.
fileName = etcd-workbench
# Configure the log file rolling size. When this size is exceeded, a new file will be created to store the log.
# Unit MB
fileLimitSize = 10
# Support: `std` and `file`
printers = std,file

Local Deployment

First, ensure that your local environment has JDK 11+ installed. Download the latest JAR package from the releases page, then place the configuration file etcd-workbench.conf in the same directory as the JAR package for it to take effect. Then execute the startup command:

java -jar etcd-workbench.jar

Visit [http://localhost:8002](http://localhost:8002) in your browser.

Deployment with Docker

Pull the Docker Image

docker pull tzfun/etcd-workbench

Start the Container

docker run \
    --name my-etcd-workbench \
    -p 8002:8002 \
    -v ./etcd-workbench.conf:/usr/tzfun/etcd-workbench/etcd-workbench.conf \
    -d \
    tzfun/etcd-workbench:latest

The image's working directory is /usr/tzfun/etcd-workbench, with the following directory structure.

/usr/tzfun/etcd-workbench # tree
├── bin
├── data
├── logs
├── temp
├── etcd-workbench.conf
└── etcd-workbench.jar