linagora/esn-sabre

OpenPaaS ESN SabreDAV前端

镜像概述和主要用途

OpenPaaS ESN SabreDAV前端是为SabreDAV开发的OpenPaaS前端组件。它为OpenPaaS实例添加日历和地址簿功能，并允许通过CalDAV和CardDAV标准客户端（如Lightning）访问这些功能。

核心功能和特性

• 标准协议支持：兼容CalDAV（日历）和CardDAV（地址簿）协议，支持主流客户端访问
• 跨域配置：可通过webserver.allowOrigin配置CORS（跨域资源共享） headers
• 灵活配置：支持通过配置文件或生成脚本自定义服务参数，适配不同部署环境
• 数据库集成：与MongoDB集成，分别存储SabreDAV数据和OpenPaaS ESN数据
• Docker化部署：提供Docker镜像，支持容器化构建、运行和测试，简化部署流程
• 测试支持：包含单元测试和代码风格检查工具，确保代码质量

使用场景和适用范围

适用于需要为OpenPaaS实例扩展日历和地址簿功能的企业或团队环境。支持用户通过标准CalDAV/CardDAV客户端（如Thunderbird Lightning、macOS日历等）访问和管理OpenPaaS中的日历与联系人数据，提升协作效率。

使用方法和配置说明

环境设置

以下步骤基于Ubuntu系统，其他Linux发行版可参考对应操作。

安装esn-sabre

bash
cd /var/www/html
git clone https://ci.linagora.com/linagora/lgs/openpaas/esn-sabre.git

通过https://getcomposer.org/管理依赖，执行以下命令安装/更新依赖：

bash
cd esn-sabre
composer update

可重复执行上述命令更新依赖包版本。

创建配置文件

配置文件可通过示例文件创建：

bash
cp config.json.default config.json

或运行生成脚本：

bash
sh ./scripts/generate_config.sh > config.json

创建后需根据部署环境修改配置参数：

• webserver.baseUri
  访问esn.php文件的URL本地部分。

  • Apache环境：若通过http://YOUR_ESN_SABRE_IP/esn-sabre/esn.php访问，baseUri为/esn-sabre/esn.php
  • Docker环境：baseUri仅为/

• webserver.allowOrigin
  配置CalDAV服务器返回的CORS headers。可设置为ESN服务器主机名或保留*（允许所有来源）。

• database.esn
  用于访问ESN数据存储的配置。

• database.sabre
  CalDAV服务器存储数据的配置。

• esn.apiRoot
  CalDAV服务器访问OpenPaaS ESN API的URL。

• mail
  CalDAV服务器发送邮件的配置。

系统与Apache环境

esn-sabre需Apache服务器支持，需安装以下组件：

安装PHP支持

Ubuntu系统：

bash
apt-get install libapache2-mod-php5

Ubuntu 16.04：

bash
apt install php5.6 php5.6-bcmath libapache2-mod-php5.6

安装PHP扩展

安装MongoDB和curl支持：

bash
apt-get install php5-mongo php5-curl

Ubuntu 16.04：

bash
apt-get install php5.6-mongo php5.6-curl

若composer update报错，需通过PECL安装Mongo扩展：

bash
apt-get install php5-dev php-pear && pecl install mongo

Ubuntu 16.04：

bash
apt-get install php5.6-dev php-pear && pecl install mongo

根据Linux版本，可能需要在php.ini中添加扩展：

bash
extension=mongo.so
extension=mbstring.so

重启Apache

bash
/etc/init.d/apache2 restart

测试环境

通过浏览器访问esn.php文件测试环境：
http://your.server.example.com/esn-sabre/esn.php

在OpenPaaS ESN中启用Caldav支持

需在配置集合中创建文档，指定Caldav服务器地址：

json
{
    "_id": "davserver",
    "backend": {
        "url": "http://192.168.7.6/esn-sabre/esn.php"  // 替换为本地ESN服务器地址，供ESN服务端访问
    },
    "frontend": {
        "url": "http://my-caldav-server.example.com/esn-sabre/esn.php"  // 替换为本地地址，供用户浏览器访问
    }
}

单元测试和代码风格

项目提供Makefile简化测试和代码风格检查，支持以下命令：

bash
make test                        # 运行所有测试
make test TARGET=tests/CalDAV/   # 仅运行指定测试（如tests/CalDAV/目录）
make test-report                 # 运行测试并生成覆盖率报告（输出至tests/report目录）

make lint                        # 检查整个项目代码风格
make lint TARGET=lib/            # 检查指定文件/目录代码风格

Docker部署

构建镜像

bash
docker build -t linagora/esn-sabre .

运行容器

运行时需配置ESN和MongoDB访问参数，支持以下环境变量（均为可选，有默认值）：

示例：

bash
docker run -d -p 8001:80 -e "SABRE_MONGO_HOST=192.168.0.1" -e "ESN_MONGO_HOST=192.168.0.1" docker.xuanyuan.run/linagora/esn-sabre

上述命令启动容器，映射主机8001端口至容器80端口，配置MongoDB主机为192.168.0.1。

容器内测试

单元测试依赖MongoDB容器，先启动MongoDB：

bash
docker run --name mongo -d docker.xuanyuan.run/mongo:3.2.0

运行测试（使用linagora/esn-sabre镜像，自动更新composer依赖）：

bash
docker run -a docker.xuanyuan.run/stdout -i -t -v $PWD:/var/www --link mongo:mongo linagora/esn-sabre make

（如需最新依赖，可能需要重新构建镜像）