Semaphore项目中使用BoltDB创建用户时的注意事项

问题背景

在使用Semaphore这一开源Ansible Web UI工具时，当采用Docker容器部署并选择BoltDB作为数据库时，用户可能会遇到两个典型问题：

1. 创建用户时无法使用大写字母
2. 在Docker容器中无法查询用户列表

这些问题通常表现为执行相关命令时出现"timeout"错误，并伴随panic堆栈信息。

技术原因分析

这些问题本质上源于BoltDB数据库的特性限制：

1. 并发访问限制：BoltDB是一个纯Go实现的键值存储，采用单文件设计，不支持多进程同时访问。当Semaphore容器运行时，数据库文件已被锁定，此时再尝试执行用户管理命令就会失败。

2. 大小写敏感问题：BoltDB本身对键名是大小写敏感的，但Semaphore可能在用户创建逻辑中对用户名做了统一小写处理，导致无法创建包含大写字母的用户名。

解决方案

正确添加用户的步骤

1. 配置数据卷：确保在docker-compose.yml中正确挂载数据库存储目录

   volumes:
     - semaphore_data:/var/lib/semaphore
   

2. 停止运行中的容器：避免数据库文件被锁定

   docker stop ansible_semaphore
   

3. 使用独立容器执行用户添加：

   docker run --rm \
   -v semaphore_data:/var/lib/semaphore \
   semaphoreui/semaphore:v2.13.14 \
   semaphore user add --admin --login admin --name Admin --email [e-mail] --password 123456
   

4. 重新启动服务容器：

   docker start ansible_semaphore
   

关于用户名大小写的说明

如果确实需要使用包含大写字母的用户名，可以考虑以下方法：

1. 检查Semaphore的配置文件，确认是否有相关的大小写转换设置
2. 直接在数据库文件中修改用户名（需要暂停服务）
3. 考虑使用MySQL或PostgreSQL等支持更灵活命名规则的数据库替代BoltDB

最佳实践建议

1. 数据库选择：对于生产环境，建议使用MySQL或PostgreSQL而非BoltDB，以获得更好的并发性能和功能支持。

2. 用户命名规范：遵循小写字母加数字的命名规则，避免潜在的大小写问题。

3. 备份策略：定期备份/var/lib/semaphore目录下的数据库文件，特别是使用BoltDB时。

4. 版本一致性：确保用户管理命令使用的Semaphore版本与服务版本一致，避免兼容性问题。

通过以上方法，可以有效解决Semaphore在Docker环境中使用BoltDB时的用户管理问题，确保系统的稳定运行。