docs: refine documentation (#831)

README.md

@@ -7,6 +7,7 @@
 - [中文文档](https://tair-opensource.github.io/RedisShake/)
 - [English Documentation](https://tair-opensource.github.io/RedisShake/en/)
 
+![](./docs/demo.gif)
 ## Overview
 
 RedisShake is a tool designed for processing and migrating Redis data. It offers the following features:

cmd/redis-shake/main.go

@@ -166,7 +166,20 @@ Loop:
 func waitShutdown(cancel context.CancelFunc) {
 	quitCh := make(chan os.Signal, 1)
 	signal.Notify(quitCh, syscall.SIGINT, syscall.SIGTERM, syscall.SIGQUIT)
-	sig := <-quitCh
-	log.Infof("Got signal: %s to exit.", sig)
-	cancel()
+	sigTimes := 0
+	for {
+		sig := <-quitCh
+		sigTimes++
+		if sig != syscall.SIGINT {
+			log.Infof("Got signal: %s.", sig)
+		} else {
+			log.Infof("Got signal: %s to exit. Press Ctrl+C again to force exit.", sig)
+			if sigTimes >= 2 {
+				os.Exit(0)
+			}
+			cancel()
+		}
+
+	}
+
 }

docs/src/zh/reader/scan_reader.md

@@ -25,7 +25,7 @@ Scan Reader 有 SCAN 和 KSN 两个阶段，SCAN 阶段是全量同步，KSN 阶
 
 `ksn` 使用 [Redis keyspace notifications](https://redis.io/docs/manual/keyspace-notifications/)
 能力来订阅 Key 的变化。具体来说，RedisShake 会使用 `psubscribe` 命令订阅 `__keyevent@*__:*`，当 Key 发生变化时，RedisShake 会收到发生修改的 Key，之后使用 `DUMP` 与 `RESTORE` 命令来从源端读取 Key 的内容，并写入目标端。
-1. Redis 在默认情况下不会开启 `notify-keyspace-events` 配置，需要手动开启，保证值中含有 `E`。
+1. Redis 在默认情况下不会开启 `notify-keyspace-events` 配置，需要手动开启，保证值中含有 `AE`。
 2. 如果在 KSN 阶段出现源端将连接断开，考虑适当调高 `client-output-buffer-limit pubsub` 的值。[802](https://github.com/tair-opensource/RedisShake/issues/802)
 3. `Redis keyspace notifications` 不会感知到 `FLUSHALL` 与 `FLUSHDB` 命令，因此在使用 `ksn` 参数时，需要确保源端数据库不会执行这两个命令。
 

internal/client/redis.go

@@ -130,6 +130,9 @@ func getReplicaAddr(info string) RedisReplicaInfo {
 			replicas = append(replicas, replica)
 		}
 	}
+	if len(replicas) == 0 {
+		log.Panicf("no replica found, should not set `prefer_replica` to true")
+	}
 	best := replicas[0]
 	for _, replica := range replicas {
 		if replica.Offset > best.Offset {

shake.toml

@@ -6,11 +6,11 @@ cluster = false            # set to true if source is a redis cluster
 address = "127.0.0.1:6379" # when cluster is true, set address to one of the cluster node
 username = ""              # keep empty if not using ACL
 password = ""              # keep empty if no authentication is required
-tls = false
-sync_rdb = true # set to false if you don't want to sync rdb
-sync_aof = true # set to false if you don't want to sync aof
-prefer_replica = true # set to true if you want to sync from replica node
-try_diskless = false # set to true if you want to sync by socket and source repl-diskless-sync=yes
+tls = false                #
+sync_rdb = true            # set to false if you don't want to sync rdb
+sync_aof = true            # set to false if you don't want to sync aof
+prefer_replica = false     # set to true if you want to sync from replica node
+try_diskless = false       # set to true if you want to sync by socket and source repl-diskless-sync=yes
 
 #[scan_reader]
 #cluster = false            # set to true if source is a redis cluster
@@ -38,7 +38,7 @@ address = "127.0.0.1:6380" # when cluster is true, set address to one of the clu
 username = ""              # keep empty if not using ACL
 password = ""              # keep empty if no authentication is required
 tls = false
-off_reply = false       # ture off the server reply
+off_reply = false          # ture off the server reply
 
 [advanced]
 dir = "data"