Merge pull request #2 from wenlng/dev-v1.0.1

update config manager setup

Author: wenlng

.github/.github/docker.yml

@@ -68,8 +68,8 @@ jobs:
           platforms: linux/amd64,linux/arm64,linux/arm/v7,windows/amd64
           push: true
           tags: |
-            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:0.0.1
-            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:amd64-0.0.1
-            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:arm64-0.0.1
-            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:armv7-0.0.1
+            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:1.0.1
+            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:amd64-1.0.1
+            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:arm64-1.0.1
+            ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:armv7-1.0.1
             ${{ secrets.DOCKER_USERNAME }}/go-captcha-service:${{ github.ref_name }}

Makefile

@@ -2,7 +2,7 @@
 
 # Variables
 BINARY_NAME=go-captcha-service
-VERSION?=0.0.1
+VERSION?=1.0.1
 BUILD_DIR=build
 PLATFORMS=darwin/amd64 darwin/arm64 linux/amd64 linux/arm64 linux/arm/v7 windows/amd64
 DOCKER_IMAGE?=wenlng/go-captcha-service

README.md

@@ -531,6 +531,7 @@ Basic Configuration:
 * `HTTP_PORT`: HTTP service listening port.
 * `GRPC_PORT`: gRPC service listening port.
 * `API_KEYS`: API keys for authentication or authorization.
+* `LOG_LEVEL`: Log level.
 
 Cache Configuration:
 * `CACHE_TYPE`: Cache type (e.g., `redis`, `memcached`, `memory`, `etcd`).
@@ -883,7 +884,7 @@ The service uses two configuration files: `config.json` for service runtime para
 
 - `config_version` (integer): Configuration file version for distributed dynamic configuration management, default `1`.
 
-##### resources Field
+> resources
 
 - `version` (string): Resource configuration version to control CAPTCHA instance recreation, default `0.0.1`.
 - `char.languages.chinese` (string array): Chinese character set for click CAPTCHA text, default empty (uses built-in resources).
@@ -914,50 +915,50 @@ The service uses two configuration files: `config.json` for service runtime para
 
 <br/>
 
-##### builder Field
+> builder
 
 Defines CAPTCHA generation styles, including configurations for click, shape click, slide, drag, and rotate CAPTCHAs.
 
-###### click_config_maps
+#### click_config_maps
 
 Defines text click CAPTCHA configurations, supporting Chinese and English with light and dark themes. The key is the ID passed in the CAPTCHA API request, e.g., `api/v1/public/get-data?id=click-default-ch`.
 
 - `click-default-ch` (object): Default Chinese theme configuration.
-    - `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
-      $
-    - `language` (string): Language, matches defined `char.languages`, e.g., `chinese` for Chinese.
-    - `master` (object): Main CAPTCHA image configuration.
-        - `image_size.width` (integer): Main image width, default `300`.
-        - `image_size.height` (integer): Main image height, default `200`.
-        - `range_length.min` (integer): Minimum number of CAPTCHA points, default `6`.
-        - `range_length.max` (integer): Maximum number of CAPTCHA points, default `7`.
-        - `range_angles` (object array): Text rotation angle ranges (degrees).
-            - Example: `{"min": 20, "max": 35}` for 20°-35°.
-        - `range_size.min` (integer): Minimum text size (pixels), default `26`.
-        - `range_size.max` (integer): Maximum text size, default `32`.
-        - `range_colors` (string array): Text color list (hexadecimal).
-            - Example: `"#fde98e"`.
-        - `display_shadow` (boolean): Display text shadow, default `true`.
-        - `shadow_color` (string): Shadow color, default `#101010`.
-        - `shadow_point.x` (integer): Shadow offset X coordinate, default `-1` (auto-calculated).
-        - `shadow_point.y` (integer): Shadow offset Y coordinate, default `-1`.
-        - `image_alpha` (float): Image opacity (0-1), default `1`.
-        - `use_shape_original_color` (boolean): Use original shape color, default `true`.
-    - `thumb` (object): Thumbnail (prompt text) configuration.
-        - `image_size.width` (integer): Thumbnail width, default `150`.
-        - `image_size.height` (integer): Thumbnail height, default `40`.
-        - `range_verify_length.min` (integer): Minimum verification points, default `2`.
-        - `range_verify_length.max` (integer): Maximum verification points, default `4`.
-        - `disabled_range_verify_length` (boolean): Disable verification point limit, default `false`.
-        - `range_text_size.min` (integer): Minimum text size, default `22`.
-        - `range_text_size.max` (integer): Maximum text size, default `28`.
-        - `range_text_colors` (string array): Text color list.
-        - `range_background_colors` (string array): Background color list.
-        - `is_non_deform_ability` (boolean): Disable deformation effect, default `false`.
-        - `background_distort` (integer): Background distortion level, default `4`.
-        - `background_distort_alpha` (float): Background distortion opacity, default `1`.
-        - `background_circles_num` (integer): Number of background circle interference points, default `24`.
-        - `background_slim_line_num` (integer): Number of background slim line interferences, default `2`.
+- `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
+$
+- `language` (string): Language, matches defined `char.languages`, e.g., `chinese` for Chinese.
+- `master` (object): Main CAPTCHA image configuration.
+- `image_size.width` (integer): Main image width, default `300`.
+- `image_size.height` (integer): Main image height, default `200`.
+- `range_length.min` (integer): Minimum number of CAPTCHA points, default `6`.
+- `range_length.max` (integer): Maximum number of CAPTCHA points, default `7`.
+- `range_angles` (object array): Text rotation angle ranges (degrees).
+- Example: `{"min": 20, "max": 35}` for 20°-35°.
+- `range_size.min` (integer): Minimum text size (pixels), default `26`.
+- `range_size.max` (integer): Maximum text size, default `32`.
+- `range_colors` (string array): Text color list (hexadecimal).
+- Example: `"#fde98e"`.
+- `display_shadow` (boolean): Display text shadow, default `true`.
+- `shadow_color` (string): Shadow color, default `#101010`.
+- `shadow_point.x` (integer): Shadow offset X coordinate, default `-1` (auto-calculated).
+- `shadow_point.y` (integer): Shadow offset Y coordinate, default `-1`.
+- `image_alpha` (float): Image opacity (0-1), default `1`.
+- `use_shape_original_color` (boolean): Use original shape color, default `true`.
+- `thumb` (object): Thumbnail (prompt text) configuration.
+- `image_size.width` (integer): Thumbnail width, default `150`.
+- `image_size.height` (integer): Thumbnail height, default `40`.
+- `range_verify_length.min` (integer): Minimum verification points, default `2`.
+- `range_verify_length.max` (integer): Maximum verification points, default `4`.
+- `disabled_range_verify_length` (boolean): Disable verification point limit, default `false`.
+- `range_text_size.min` (integer): Minimum text size, default `22`.
+- `range_text_size.max` (integer): Maximum text size, default `28`.
+- `range_text_colors` (string array): Text color list.
+- `range_background_colors` (string array): Background color list.
+- `is_non_deform_ability` (boolean): Disable deformation effect, default `false`.
+- `background_distort` (integer): Background distortion level, default `4`.
+- `background_distort_alpha` (float): Background distortion opacity, default `1`.
+- `background_circles_num` (integer): Number of background circle interference points, default `24`.
+- `background_slim_line_num` (integer): Number of background slim line interferences, default `2`.
 
 - `click-dark-ch` (object): Chinese dark theme configuration, similar to `click-default-ch`, but `thumb.range_text_colors` uses brighter colors for dark backgrounds.
 
@@ -967,69 +968,69 @@ Defines text click CAPTCHA configurations, supporting Chinese and English with l
 
 <br/>
 
-###### click_shape_config_maps
+#### click_shape_config_maps
 
 Defines shape click CAPTCHA configurations.
 
 - `click-shape-default` (object): Default shape click configuration, similar to `click_config_maps` `master` and `thumb` but for shape images instead of text.
 
 <br/>
 
-###### slide_config_maps
+#### slide_config_maps
 
 Defines slide CAPTCHA configurations.
 
 - `slide-default` (object):
-    - `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
-    - `master` (object): Main CAPTCHA image configuration.
-        - `image_size.width` (integer): Main image width, default `300`.
-        - `image_size.height` (integer): Main image height, default `200`.
-        - `image_alpha` (float): Image opacity (0-1), default `1`.
-    - `thumb` (object): Slider configuration.
-        - `range_graph_size.min` (integer): Minimum slider graphic size (pixels), default `60`.
-        - `range_graph_size.max` (integer): Maximum slider graphic size, default `70`.
-        - `range_graph_angles` (object array): Slider graphic rotation angle ranges (degrees).
-            - Example: `{"min": 20, "max": 35}`.
-        - `generate_graph_number` (integer): Number of slider graphics to generate, default `1`.
-        - `enable_graph_vertical_random` (boolean): Enable vertical random offset, default `false`.
-        - `range_dead_zone_directions` (string array): Slider dead zone directions, default `["left", "right"]`.
+- `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
+- `master` (object): Main CAPTCHA image configuration.
+- `image_size.width` (integer): Main image width, default `300`.
+- `image_size.height` (integer): Main image height, default `200`.
+- `image_alpha` (float): Image opacity (0-1), default `1`.
+- `thumb` (object): Slider configuration.
+- `range_graph_size.min` (integer): Minimum slider graphic size (pixels), default `60`.
+- `range_graph_size.max` (integer): Maximum slider graphic size, default `70`.
+- `range_graph_angles` (object array): Slider graphic rotation angle ranges (degrees).
+- Example: `{"min": 20, "max": 35}`.
+- `generate_graph_number` (integer): Number of slider graphics to generate, default `1`.
+- `enable_graph_vertical_random` (boolean): Enable vertical random offset, default `false`.
+- `range_dead_zone_directions` (string array): Slider dead zone directions, default `["left", "right"]`.
 
 <br/>
 
-###### drag_config_maps
+#### drag_config_maps
 
 Defines drag CAPTCHA configurations.
 
 - `drag-default` (object):
-    - `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
-    - `master` (object): Main CAPTCHA image configuration.
-        - `image_size.width` (integer): Main image width, default `300`.
-        - `image_size.height` (integer): Main image height, default `200`.
-        - `image_alpha` (float): Image opacity (0-1), default `1`.
-    - `thumb` (object): Drag graphic configuration.
-        - `range_graph_size.min` (integer): Minimum drag graphic size (pixels), default `60`.
-        - `range_graph_size.max` (integer): Maximum drag graphic size, default `70`.
-        - `range_graph_angles` (object array): Drag graphic rotation angle ranges (degrees).
-            - Example: `{"min": 0, "max": 0}` for no rotation.
-        - `generate_graph_number` (integer): Number of drag graphics to generate, default `2`.
-        - `enable_graph_vertical_random` (boolean): Enable vertical random offset, default `true`.
-        - `range_dead_zone_directions` (string array): Drag dead zone directions, default `["left", "right", "top", "bottom"]`.
+- `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
+- `master` (object): Main CAPTCHA image configuration.
+- `image_size.width` (integer): Main image width, default `300`.
+- `image_size.height` (integer): Main image height, default `200`.
+- `image_alpha` (float): Image opacity (0-1), default `1`.
+- `thumb` (object): Drag graphic configuration.
+- `range_graph_size.min` (integer): Minimum drag graphic size (pixels), default `60`.
+- `range_graph_size.max` (integer): Maximum drag graphic size, default `70`.
+- `range_graph_angles` (object array): Drag graphic rotation angle ranges (degrees).
+- Example: `{"min": 0, "max": 0}` for no rotation.
+- `generate_graph_number` (integer): Number of drag graphics to generate, default `2`.
+- `enable_graph_vertical_random` (boolean): Enable vertical random offset, default `true`.
+- `range_dead_zone_directions` (string array): Drag dead zone directions, default `["left", "right", "top", "bottom"]`.
 
 <br/>
 
-###### rotate_config_maps
+#### rotate_config_maps
 
 Defines rotate CAPTCHA configurations.
 
 - `rotate-default` (object):
-    - `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
-    - `master` (object): Main CAPTCHA image configuration.
-        - `image_square_size` (integer): Main image square side length (pixels), default `220`.
-    - `thumb` (object): Rotate graphic configuration.
-        - `range_angles` (object array): Rotation angle ranges (degrees).
-            - Example: `{"min": 30, "max": 330}` for 30°-330°.
-        - `range_image_square_sizes` (integer array): Rotate image square side length list, default `[140, 150, 160, 170]`.
-        - `image_alpha` (float): Image opacity (0-1), default `1`.
+- `version` (string): Configuration version to control CAPTCHA instance recreation, default `0.0.1`.
+- `master` (object): Main CAPTCHA image configuration.
+- `image_square_size` (integer): Main image square side length (pixels), default `220`.
+- `thumb` (object): Rotate graphic configuration.
+- `range_angles` (object array): Rotation angle ranges (degrees).
+- Example: `{"min": 30, "max": 330}` for 30°-330°.
+- `range_image_square_sizes` (integer array): Rotate image square side length list, default `[140, 150, 160, 170]`.
+- `image_alpha` (float): Image opacity (0-1), default `1`.
 
 <br/>
 <br/>
@@ -1040,6 +1041,8 @@ Hot reloading for `gocaptcha.json` is determined by the `version` field of each
 Hot-reloadable fields in `config.json` include:
 * `cache_type`
 * `cache_addrs`
+* `cache_username`
+* `cache_password`
 * `cache_ttl`
 * `cache_key_prefix`
 * `api_keys`
@@ -1053,7 +1056,7 @@ Hot-reloadable fields in `config.json` include:
 - Verification Logic: Test handling of different inputs.
 - Service Discovery: Simulate Etcd/Nacos/Zookeeper/Consul.
 - Caching: Test Memory/Redis/Etcd/Memcache.
-- Dynamic Configuration: Test Nacos configuration updates.
+- Dynamic Configuration: Test Etcd|Nacos|Zookeeper|Consul configuration updates.
 
 <br/>
 <br/>

README_zh.md

@@ -24,7 +24,6 @@
 </div>
 
 <br/>
-<hr/>
 <br/>
 
 ## 周边项目
@@ -56,7 +55,7 @@
 - **分布式缓存**：支持 Memory、Redis、Etcd 和 Memcache，优化验证码数据存储。
 - **分布式动态配置**：通过 Etcd、Nacos、Zookeeper 或 Consul 实时更新配置。
 - **高可配置性**：支持自定义文本、字体、图片资源、验证码尺寸、生成规则等配置。
-- **高性能**：基于 Go 的并发模型，适合高流量场景，同时结合分布式架构部署，确保服务处于高可用、高性能、高响应的状态。
+- **高性能**：基于 Go 的并发模型，适合高流量场景，同时结合分布式架构部署，确保服务处于高可用、高性能的状态。
 - **跨平台**：支持二进制、命令行、PM2、Docker 和 Docker Compose 部署。
 
 <br/>
@@ -119,13 +118,15 @@ PM2 是 Node.js 进程守护管理工具，可用于管理 Go 服务，提供进
          SERVICE_NAME: 'go-captcha-service',
          CACHE_TYPE: 'redis',
          CACHE_ADDRS: 'localhost:6379',
+         LOG_LEVEL: 'error',
        },
        env_production: {
          CONFIG: 'config.json',
          GO_CAPTCHA_CONFIG: 'gocaptcha.json',
          SERVICE_NAME: 'go-captcha-service',
          CACHE_TYPE: 'redis',
          CACHE_ADDRS: 'localhost:6379',
+         LOG_LEVEL: 'error',
        }
      }]
    };
@@ -534,6 +535,7 @@ server {
 * HTTP_PORT: HTTP 服务监听端口。
 * GRPC_PORT: gRPC 服务监听端口。
 * API_KEYS: API 密钥，用于认证或授权。
+* `LOG_LEVEL`: Log level.
 
 缓存配置：
 * CACHE_TYPE: 缓存类型（如 redis、memcached、memory、etcd）。
@@ -881,11 +883,11 @@ server {
 ```
 <br/>
 
-##### 顶级字段
+> 顶级字段
 
 - `config_version` (整数)：配置文件版本号，用于分布动态配置管理，默认 `1`。
 
-##### resources 字段
+> resources 字段
 
 - `version` (字符串)：资源配置版本号，用于控制重新创建新的验证码实例，默认 `0.0.1`。
 - `char.languages.chinese` (字符串数组)：中文字符集，用于点击验证码的文本内容，默认空（默认取内置的资源）。
@@ -916,12 +918,12 @@ server {
 
 <br/>
 
-##### builder 字段
+#### builder 字段
 
 定义验证码生成样式，包含点击、形状点击、滑动、拖拽和旋转验证码的配置。
 
 
-###### click_config_maps
+#### click_config_maps
 
 定义文本点击验证码的配置，支持中英文和明暗主题，key为ID，在请求验证码API时传递，例如：`api/v1/public/get-data?id=click-default-ch`。
 
@@ -969,15 +971,15 @@ server {
 
 <br/>
 
-###### click_shape_config_maps
+#### click_shape_config_maps
 
 定义形状点击验证码的配置。
 
 - `click-shape-default` (对象)：默认形状点击配置，参数与 `click_config_maps` 的 `master` 和 `thumb` 类似，但针对形状图片而非文本。
 
 <br/>
 
-###### slide_config_maps
+#### slide_config_maps
 
 定义滑动验证码配置。
 
@@ -998,7 +1000,7 @@ server {
 
 <br/>
 
-###### drag_config_maps
+#### drag_config_maps
 
 定义拖拽验证码配置。
 
@@ -1019,7 +1021,7 @@ server {
 
 <br/>
 
-###### rotate_config_maps
+#### rotate_config_maps
 
 定义旋转验证码配置。
 
@@ -1043,14 +1045,16 @@ server {
 `gocaptcha.json` 热重载以每个配置项的 version 字段决定是否生效。
 
 `config.json` 热重载有效的字段如下：
-* cache_type
-* cahce_addrs
-* cache_ttl
-* cache_key_prefix
-* api_keys
-* log_level
-* rate_limit_qps
-* rate_limit_burst
+* `cache_type`
+* `cache_addrs`
+* `cache_username`
+* `cache_password`
+* `cache_ttl`
+* `cache_key_prefix`
+* `api_keys`
+* `log_level`
+* `rate_limit_qps`
+* `rate_limit_burst`
 
 
 ### 测试：
@@ -1059,7 +1063,7 @@ server {
 - 验证逻辑：测试不同输入的处理。
 - 服务发现：模拟 Etcd/Nacos/Zookeeper/Consul。
 - 缓存：测试 Memory/Redis/Etcd/Memcache。
-- 动态配置：测试 Nacos 配置更新。
+- 动态配置：测试 Etcd|Nacos|Zookeeper|Consul 配置更新。
 
 
 <br/>