ViMbAdmin 技术文档

1. 安装指南

1.1 环境要求

• PHP 版本：建议使用 PHP 7.x 或更高版本。
• 数据库：支持 MySQL、PostgreSQL 或 SQLite。
• Web 服务器：Apache 或 Nginx。
• Composer：用于管理 PHP 依赖。

1.2 安装步骤

1. 克隆项目：

   git clone https://github.com/opensolutions/ViMbAdmin.git
   cd ViMbAdmin
   

2. 安装依赖：

   composer install
   

3. 配置数据库：

   • 复制 application/configs/application.ini.dist 为 application/configs/application.ini。
   • 编辑 application.ini 文件，配置数据库连接信息。

4. 初始化数据库：

   php bin/doctrine2-cli.php orm:schema-tool:create
   

5. 配置 Web 服务器：

   • 配置 Apache 或 Nginx，将文档根目录指向 public/ 目录。

6. 访问应用：

   • 打开浏览器，访问 http://your-domain.com，进入 ViMbAdmin 管理界面。

2. 项目的使用说明

2.1 登录与管理

• 首次访问时，系统会提示创建管理员账户。
• 登录后，您可以管理域名、邮箱账户和别名。

2.2 管理域名

• 在“域名管理”页面，您可以添加、编辑或删除域名。
• 每个域名可以配置多个邮箱账户和别名。

2.3 管理邮箱账户

• 在“邮箱账户管理”页面，您可以添加、编辑或删除邮箱账户。
• 每个邮箱账户可以设置密码、配额等属性。

2.4 管理别名

• 在“别名管理”页面，您可以添加、编辑或删除邮箱别名。
• 别名用于将邮件转发到其他邮箱地址。

3. 项目API使用文档

3.1 API 概述

ViMbAdmin 提供了一套 RESTful API，用于管理域名、邮箱账户和别名。

3.2 API 认证

• 使用 API 时，需要通过 HTTP Basic Auth 进行认证。
• 用户名和密码为管理员账户的凭据。

3.3 API 示例

• 获取所有域名：

  GET /api/domains
  

• 创建新域名：

  POST /api/domains
  {
    "name": "example.com"
  }
  

• 获取邮箱账户：

  GET /api/mailboxes
  

• 创建新邮箱账户：

  POST /api/mailboxes
  {
    "username": "user1",
    "domain": "example.com",
    "password": "password123"
  }
  

4. 项目安装方式

4.1 手动安装

• 按照上述“安装指南”中的步骤进行手动安装。

4.2 使用 Vagrant

• 项目提供了 Vagrant 配置文件，可以使用 Vagrant 快速部署开发环境。
• 安装 Vagrant 和 VirtualBox，然后运行：

  vagrant up
  

4.3 使用 Docker

• 项目也支持 Docker 部署，具体步骤请参考项目 Wiki 中的 Docker 部分。

通过以上步骤，您可以顺利安装并使用 ViMbAdmin 进行虚拟邮箱管理。