redsmin/proxy

Redsmin Proxy Docker镜像文档

镜像概述和主要用途

Redsmin Proxy Docker镜像提供了一种安全方式，用于将位于防火墙后或本地的Redis服务器连接到Redsmin（[***] GUI中远程管理无法直接访问的Redis实例，所有通信均通过TLS加密保障安全性。

!Build Status !Coverage Status !Support !Follow

!Docker Hub !Docker hub !NPM version !Downloads

!Redsmin Proxy

核心功能和特性

• 安全通信：通过TLS 1.2协议加密Redsmin与代理之间的所有数据传输
• 多环境支持：兼容Docker、Mac OS X、Debian/Ubuntu、Windows等多种平台
• 灵活连接：支持TCP连接、Unix socket、密码保护的Redis实例
• 配置灵活：可通过环境变量或配置文件进行参数设置
• 高可用性：支持Docker自动重启及多种进程管理工具（systemd、supervisord等）

使用场景和适用范围

• 管理本地运行的Redis服务器（localhost）
• 连接位于防火墙后的Redis实例
• 管理Docker容器中运行的Redis服务
• 需要通过Redsmin GUI远程监控和管理Redis的场景
• 多Redis实例同时连接管理需求

环境变量选项

注意：使用rediss://前缀作为REDIS_URI可通过TLS加密连接Redis

详细使用方法和配置说明

Docker部署示例

连接本地Redis服务器

Linux环境：

bash
docker run -it --rm --net=host --name redsmin-proxy -e REDSMIN_KEY=YOUR_REDSMIN_KEY -e REDIS_URI="redis://127.0.0.1:6379" redsmin/proxy

Mac OS X环境：

bash
docker run -it --rm --name redsmin-proxy -e REDSMIN_KEY=YOUR_REDSMIN_KEY -e REDIS_URI="redis://docker.for.mac.localhost:6379" redsmin/proxy

通用非Linux环境（需替换HOST_IP为实际主机IP）：

bash
docker run -it --rm --name redsmin-proxy -e REDSMIN_KEY=YOUR_REDSMIN_KEY -e REDIS_URI="redis://HOST_IP:6379" redsmin/proxy

连接网络Redis服务器

bash
docker run -it --rm --name redsmin-proxy -e REDSMIN_KEY=YOUR_REDSMIN_KEY -e REDIS_URI="redis://192.168.3.50:6379" redsmin/proxy

其中192.168.3.50:6379为Redis服务器的IP和端口，YOUR_REDSMIN_KEY为Redsmin连接密钥

连接Redis容器

1. 首先启动Redis容器：

bash
docker run --name my-redis --rm redis

2. 链接Redsmin Proxy容器到Redis容器：

bash
docker run -it --rm --name redsmin-proxy --link my-redis:local-redis -e REDSMIN_KEY=YOUR_KEY -e REDIS_URI="redis://local-redis:6379" redsmin/proxy

Docker自动重启

使用Docker的自动重启策略：

bash
docker run -it --restart=always --name redsmin-proxy -e REDSMIN_KEY=YOUR_REDSMIN_KEY -e REDIS_URI="redis://127.0.0.1:6379" redsmin/proxy

其他操作系统安装方法

MacOS、Debian/Ubuntu

bash
npm install redsmin --global
REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token" redsmin

Windows (PowerShell)

bash
npm install redsmin --global
$env:REDIS_URI="redis://127.0.0.1:6379"
$env:REDSMIN_KEY="redsmin-token"
redsmin

Windows (CMD.exe)

bash
npm install redsmin --global
set REDIS_URI=redis://127.0.0.1:6379
set REDSMIN_KEY=redsmin-token
redsmin

注意：Windows环境下设置环境变量时不要使用双引号

连接密码保护的Redis

MacOS、Debian/Ubuntu

bash
npm install redsmin --global
REDIS_URI="redis://127.0.0.1:6379" REDIS_AUTH="auth-pass" REDSMIN_KEY="redsmin-token" redsmin

Windows

bash
npm install redsmin --global
set REDIS_URI=redis://127.0.0.1:6379
set REDIS_AUTH=auth-pass
set REDSMIN_KEY=redsmin-token
redsmin

连接Unix Socket的Redis

MacOS、Debian/Ubuntu

bash
npm install redsmin --global
REDIS_URI="/tmp/redis.sock" REDSMIN_KEY="5517e20046f4c7530d000357" redsmin

Windows

bash
npm install redsmin --global
set REDIS_URI=/tmp/redis.sock
set REDSMIN_KEY=5517e20046f4c7530d000357
redsmin

注意：访问Unix socket可能需要sudo权限

使用配置文件

1. 创建JSON配置文件（如/etc/redsmin.json）：

json
{
  "key": "redsmin-token",
  "redis": "redis://127.0.0.1:6379",
  "auth": ""
}

2. 启动Redsmin Proxy：

MacOS、Debian/Ubuntu

bash
CONFIG_FILE="/etc/redsmin.json" redsmin

Windows

bash
set CONFIG_FILE="/etc/redsmin.json"
redsmin

连接多个Redis实例

MacOS、Debian/Ubuntu

bash
REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token1" redsmin &
REDIS_URI="redis://127.0.0.1:6380" REDSMIN_KEY="redsmin-token2" redsmin &
REDIS_URI="redis://127.0.0.1:6381" REDSMIN_KEY="redsmin-token3" redsmin &
REDIS_URI="redis://127.0.0.1:6382" REDSMIN_KEY="redsmin-token4" redsmin &

Windows

bash
set REDIS_URI=redis://127.0.0.1:6379
set REDSMIN_KEY=redsmin-token1
START /B redsmin

set REDIS_URI=redis://127.0.0.1:6380
set REDSMIN_KEY=redsmin-token2
START /B redsmin

set REDIS_URI=redis://127.0.0.1:6381
set REDSMIN_KEY=redsmin-token3
START /B redsmin

set REDIS_URI=redis://127.0.0.1:6382
set REDSMIN_KEY=redsmin-token4
START /B redsmin

保持Redsmin Proxy持续运行

使用nohup

shell
echo '#!/usr/bin/env bash' >> redsmin-proxy.sh
echo 'while true; do REDSMIN_KEY=YOUR_REDSMIN_TOKEN redsmin; sleep 1; done;' >> redsmin-proxy.sh
chmod +x redsmin-proxy.sh
nohup ./redsmin-proxy.sh &

查看日志：tail -f nohup.out

使用nohup（单行命令）

bash
nohup bash -c "while true; do REDSMIN_KEY=YOUR_REDSMIN_TOKEN redsmin; sleep 1; done" &

使用screen

bash
# 启动screen
screen
# 启动Redsmin Proxy
REDIS_URI="redis://127.0.0.1:6379" REDSMIN_KEY="redsmin-token1" redsmin
# 按Ctrl+A+D分离会话
# 重新连接会话：screen -r

使用进程管理器

systemd

创建服务文件/etc/systemd/system/redsmin.service：

ini
[Unit]
Description = Redsmin Proxy
After = network.target

[Service]
Type = simple
Environment = REDIS_URI=redis://127.0.0.1:6379 REDSMIN_KEY=your-token-here
ExecStart = /usr/bin/redsmin
TimeoutStartSec = infinity
Restart = on-abort

[Install]
WantedBy = multi-user.target

重新加载并启动服务：

bash
systemctl daemon-reload
systemctl start redsmin

supervisord

创建配置文件：

ini
[program:redsmin]
command = /usr/bin/redsmin
autostart = true
autorestart = true
environment = REDIS_URI="redis://127.0.0.1:6379",REDSMIN_KEY="your-token-here"

重新加载配置：

bash
supervisorctl reread && supervisorctl update

防火墙规则配置

Redsmin Proxy需要连接到ssl.redsmin.com的993端口（TLS加密连接），请确保防火墙允许出站连接到该地址和端口。

卸载Redsmin Proxy

MacOS、Debian/Ubuntu

bash
npm uninstall redsmin -g

故障排除

Ready check failed: NOAUTH Authentication required.

此错误表示Redis服务器需要密码认证，但Redsmin Proxy未配置密码。解决方法：启动时设置REDIS_AUTH环境变量指定Redis密码。