Devise LDAP Authenticatable 技术文档

1. 安装指南

在您的 Gemfile 文件中添加以下内容：

gem "devise_ldap_authenticatable"

如果您需要获取最新版本，可以直接从 GitHub 上拉取：

gem "devise_ldap_authenticatable", :git => "git://github.com/cschiewek/devise_ldap_authenticatable.git"

然后执行以下命令进行安装：

bundle install

2. 项目的使用说明

在使用该项目之前，请确保您已经安装了 Devise。接着执行以下命令：

rails generate devise:install
rails generate devise MODEL_NAME

之后，运行下面的命令来安装 devise_ldap_authenticatable：

rails generate devise_ldap_authenticatable:install [options]

该命令将安装 ldap.yml 文件，更新 devise.rb 初始化文件，以及更新您的用户模型。以下是可用的选项：

• --user-model=USER_MODEL：要更新的模型名称，默认为 user。
• --update-model：更新模型，将其从 database_authenticatable 更改为 ldap_authenticatable，默认为 true。
• --add-rescue：更新应用控制器，添加 rescue_from 用于 DeviseLdapAuthenticatable::LdapException，默认为 true。
• --advanced：添加高级配置选项到 Devise 初始化文件中。

3. 项目API使用文档

在您的用户模型中定义 ldap_before_save 方法来查询 LDAP 服务器上的其他属性：

def ldap_before_save
  self.email = Devise::LDAP::Adapter.get_ldap_param(self.username,"mail").first
end

4. 项目安装方式

以下为详细的项目安装步骤：

1. 确保您的项目中已安装 Devise。
2. 更新 Gemfile 文件，添加 devise_ldap_authenticatable。
3. 运行 bundle install 命令。
4. 使用 Devise 生成器创建用户模型。
5. 运行 devise_ldap_authenticatable:install 生成器来配置 LDAP 相关文件和设置。

确保在 config/initializers/devise.rb 文件中正确配置 LDAP 设置，包括但不限于 ldap_config 路径、ldap_create_user、ldap_update_password 等选项。

通过以上步骤，您应该能够成功地将 Devise LDAP Authenticatable 集成到您的 Rails 应用程序中。