LLM-Guard API部署中的认证问题解决方案

问题背景

在部署LLM-Guard项目的API服务时，部分用户遇到了无法访问/docs、/analyze/prompt和/analyze/output等关键端点的问题。这些端点对于API的测试和使用至关重要，特别是/docs端点提供的Swagger UI界面，是开发者了解和测试API功能的重要工具。

问题现象

当用户尝试访问这些端点时，系统会返回错误提示，导致无法正常使用API功能。这种情况通常发生在使用Docker容器部署llm_guard_api服务后。

根本原因分析

经过技术分析，这个问题主要源于API服务的认证配置。LLM-Guard API默认启用了认证机制，但用户在部署时可能没有正确配置认证令牌，导致系统拒绝访问请求。

解决方案

要解决这个问题，用户有两个选择：

1. 完全禁用认证：修改配置文件，移除auth相关配置项。这种方法适合在完全可信的内部网络环境中使用，可以简化API访问流程。

2. 配置认证令牌：

   • 设置AUTH_TOKEN环境变量，值为您选择的认证令牌
   • 在API请求的Header中添加Authorization: Bearer TOKEN，其中TOKEN替换为您设置的实际令牌值

最佳实践建议

对于生产环境，我们建议采用第二种方案，即配置并使用认证令牌。这可以确保API服务的安全性。具体实施时可以考虑：

1. 在Docker运行命令中通过-e参数设置环境变量：

   docker run -e AUTH_TOKEN=your_secure_token_here llm-guard-api
   

2. 或者使用Docker Compose文件配置环境变量

3. 对于开发环境，可以考虑使用第一种方案临时禁用认证，但务必记得在生产环境重新启用

后续验证

配置完成后，用户应该能够：

• 正常访问/docs端点查看API文档
• 使用/analyze/prompt端点分析提示词
• 使用/analyze/output端点分析输出内容

如果仍然遇到问题，建议检查Docker容器的日志输出，确认服务是否正常启动以及认证配置是否生效。