README

在连接到 Dovecot 的 IMAP 时，提供 HTTP 客户端 IP，以 IMAP 标识符的形式进行适当的身份验证和处罚处理。

在反向代理配置中，如果请求来自受信任的代理，则解析实际客户端 IP。

安装

此插件可以通过 Composer 或手动安装。如果 Webmail 服务器允许出站请求，则 Composer 是更舒适的选择，因为它可以自动解决依赖关系并简化更新。

使用 Composer

⚠️ 注意，不建议以 root 运行 Composer。插件安装需要启用脚本支持，因为 RoundCube 安装程序需要将下载的插件移动到插件目录，并且可以选择自动启用插件。

1. 获取 Composer。
2. 在 RoundCube Webmail 根目录内，将插件添加为新依赖项。使用 dev-main 作为最新开发版本的版本约束。

   php composer.phar require 'takerukoushirou/roundcube-dovecot_client_ip:^1.0'
   

3. Composer 可能会询问是否启用插件。使用 y 确认。

要更新已安装的插件到最新版本，只需运行

php composer.phar update --no-dev

手动

1. 下载最新发布存档或检出最新发布分支。
2. 将内容提取到名为 roundcube_dovecot_client_ip 的文件夹中，该文件夹位于您的 RoundCube 安装中的 plugins 目录内。

没有外部依赖项。

重复手动安装以更新。建议在单独的文件夹中保留多个插件的多个版本，并使用从 plugins 目录到最新版本文件夹的名为 roundcube_dovecot_client_ip 的符号链接。

配置

要启用插件，请将 roundcube_dovecot_client_ip 添加到 RoundCube 配置文件中的 $config['plugins'] 数组。
当使用 Composer 时，安装程序将询问是否自动启用插件。

选项

在全新安装中，导航到插件目录并将 config.inc.php.dist 复制到 config.inc.php。
当使用 Composer 时，会自动创建副本。

根据需要编辑插件目录中的 config.inc.php。
所有选项及其接受的值均在 config.inc.php.dist 中描述。

Dovecot IMAP

以下设置需要应用于 Dovecot IMAP 服务器

1. 将您的 RoundCube Webmail 服务器 IP 地址或网络添加到 Dovecot IMAP 配置中的 login_trusted_networks 设置。这将禁用对配置的 Webmail 服务器 IP 的身份验证处罚处理，并启用处理由本插件提供的实际客户端 IP 的 X-Originating-IP 标识值。
2. 重新启动 Dovecot IMAP。

之后，Dovecot 连接日志应该在 rip（远程 IP）字段中显示用户的实际客户端 IP，而不是 Webmail 服务器 IP。

许可证

GNU 通用公共许可证 v3 或更高版本。有关详细信息，请参阅 LICENSE 文件。

本程序是自由软件：您可以按照自由软件基金会发布的 GNU 通用公共许可证的条款重新分发和/或修改它，许可证版本为 3 或更高版本（根据您的选择）。