Perkeep应用环境变量配置详解

Perkeep应用环境变量配置详解

Perkeep作为一个分布式存储系统，提供了灵活的应用程序运行环境配置机制。本文将深入解析Perkeep应用运行时的关键环境变量设置，帮助开发者更好地理解和配置Perkeep应用环境。

核心环境变量解析

CAMLI_API_HOST

这个变量定义了Perkeep服务器的API前缀地址，应用将使用这个地址进行API调用。需要注意以下几点：

1. 地址必须以斜杠(/)结尾
2. 支持HTTP和HTTPS协议
3. 可以包含端口号
4. 示例格式：
   • HTTPS带端口：https://example.com:3178/pub/
   • HTTPS默认端口：https://example.com/pub/
   • HTTP本地地址：http://192.168.1.100/
   • HTTP自定义端口：http://localhost:1234/

CAMLI_APP_LISTEN

此变量指定应用监听的网络地址，格式为主机|IP:端口。其语法遵循Go语言标准库中的网络地址规范：

• 可以只指定端口，如:8080表示监听所有网络接口的8080端口
• 可以指定IP和端口，如127.0.0.1:8080
• 支持主机名，如example.com:8080

CAMLI_APP_CONFIG_URL

这个URL指向应用的JSON配置文件，应用在启动时会获取该配置。关键特性包括：

1. 应用仅在启动时获取一次
2. 使用CAMLI_AUTH进行身份验证
3. 响应内容对应于配置文件中的"appConfig"部分
4. 支持HTTPS确保配置传输安全

CAMLI_APP_MASTERQUERY_URL

此URL用于注册应用的主查询(Master Query)，具有以下特点：

1. 使用POST方法提交search.SearchQuery
2. 需要CAMLI_AUTH认证
3. 注册后所有后续搜索必须是主查询结果的子集
4. 支持refresh=1参数强制刷新缓存

CAMLI_AUTH

提供HTTP基本认证所需的用户名和密码，格式为username:password。安全注意事项：

1. 基本认证是明文传输的
2. 在生产环境中必须配合HTTPS使用
3. 本地测试环境可以使用HTTP
4. 密码应当妥善保管，避免泄露

实际应用建议

1. 开发环境配置：在本地开发时，可以使用HTTP协议和简单密码，但应确保网络环境安全
2. 生产环境安全：必须使用HTTPS，密码应当复杂且定期更换
3. 配置管理：建议将敏感配置如CAMLI_AUTH通过安全的方式注入，而非硬编码
4. 监听地址：生产环境建议明确指定监听IP，而非使用通配地址

常见问题解答

Q: 为什么我的应用无法连接到Perkeep服务器？ A: 首先检查CAMLI_API_HOST是否正确，包括协议、主机名、端口和结尾斜杠。其次确认CAMLI_AUTH是否设置正确。

Q: 如何确保配置传输安全？ A: 确保CAMLI_APP_CONFIG_URL使用HTTPS协议，并且服务器证书有效。

Q: 主查询有什么作用？ A: 主查询定义了应用可以访问的数据范围，所有后续查询都必须是这个范围的子集，这是一种安全机制。

通过合理配置这些环境变量，开发者可以灵活地控制Perkeep应用的行为，同时保证系统的安全性和可靠性。理解这些变量的作用对于开发和部署Perkeep应用至关重要。