ZincSearch配置文件详解

发布时间: 2025-04-08 10:46

↑

# ZincSearch配置文件详解

本文将详细介绍ZincSearch的配置选项，帮助您根据实际需求优化系统性能。

## 配置文件位置

ZincSearch支持多种配置方式：

1. 环境变量
2. 配置文件（YAML/JSON格式）
3. 命令行参数

默认配置文件路径：
- Linux/macOS: `/etc/zinc/config.yaml`
- Windows: `C:\ProgramData\zinc\config.yaml`

## 核心配置项

### 1. 服务器配置

```yaml
server:
  port: 4080                # 服务监听端口
  address: "0.0.0.0"        # 监听地址
  mode: "production"        # 运行模式：production/development
  path_prefix: "/"         # URL路径前缀
```

### 2. 数据存储配置

```yaml
storage:
  path: "./data"           # 数据存储路径
  max_segment_size: 1GB    # 最大段大小
  shard_num: 3            # 分片数量
```

### 3. 认证与安全

```yaml
auth:
  jwt_secret: "your-secret-key"   # JWT密钥
  token_duration: 24h             # Token有效期
  min_password_length: 8          # 最小密码长度

tls:
  enabled: false                  # 启用HTTPS
  cert_file: "path/to/cert.pem"   # 证书文件
  key_file: "path/to/key.pem"     # 密钥文件
```

### 4. 日志配置

```yaml
log:
  level: "info"            # 日志级别：debug/info/warn/error
  format: "json"           # 日志格式：json/text
  output: "stdout"         # 输出位置：stdout/file
  file_path: "zinc.log"    # 日志文件路径
```

### 5. 缓存配置

```yaml
cache:
  enabled: true            # 启用缓存
  size: "1GB"             # 缓存大小
  ttl: "1h"               # 缓存过期时间
```

### 6. 索引配置

```yaml
index:
  default_mapping:
    dynamic: true          # 动态映射
    index_analyzer: "standard"  # 默认分析器
  bulk_size: 10000         # 批量操作大小
  refresh_interval: "1s"   # 刷新间隔
```

## 高级配置

### 1. 集群配置

```yaml
cluster:
  enabled: false           # 启用集群模式
  name: "zinc-cluster"     # 集群名称
  nodes:
    - "http://node1:4080"
    - "http://node2:4080"
```

### 2. 监控配置

```yaml
metrics:
  enabled: true            # 启用监控
  port: 2112              # 监控端口
  path: "/metrics"         # 监控路径
```

### 3. API限流配置

```yaml
rate_limit:
  enabled: true            # 启用限流
  requests_per_second: 100 # 每秒请求数
  burst: 50               # 突发请求数
```

## 环境变量对照表

| 配置项 | 环境变量 | 默认值 |
|--------|----------|--------|
| 服务端口 | ZINC_SERVER_PORT | 4080 |
| 数据路径 | ZINC_DATA_PATH | ./data |
| 管理员用户名 | ZINC_FIRST_ADMIN_USER | admin |
| 管理员密码 | ZINC_FIRST_ADMIN_PASSWORD | Complexpass#123 |
| 日志级别 | ZINC_LOG_LEVEL | info |

## 配置最佳实践

1. 生产环境配置
   - 启用TLS加密
   - 配置合适的日志级别
   - 设置资源限制

2. 性能优化
   - 调整缓存大小
   - 优化批量操作大小
   - 设置合理的刷新间隔

3. 安全加固
   - 修改默认密码
   - 配置强密钥
   - 启用API限流

## 配置验证

启动服务时添加`--validate-config`参数可以验证配置文件：

```bash
zinc --validate-config
```

## 常见问题

1. 配置不生效
   - 检查配置文件权限
   - 验证配置文件格式
   - 确认环境变量优先级

2. 性能问题
   - 调整缓存配置
   - 优化索引设置
   - 检查系统资源

元素码农