Twich基于Web的聊天应用技术文档

1. 安装指南

环境准备

在安装Twich之前，您需要确保您的服务器已经安装了以下软件：

• Apache服务器
• PHP
• Node.js

安装步骤

1. 创建虚拟主机 在Apache服务器中创建一个新的虚拟主机，并将文档根目录指向www/文件夹。

2. 配置PHP环境 确保您的服务器启用了mod_rewrite模块，这对于应用的正向代理和URL重写至关重要。

3. 配置PHP脚本 将www/_config.php.sample复制为www/_config.php，并根据实际情况编辑以下配置项：

   var $port = 443; // Node服务器监听的端口
   var $domain = ''; // Node服务器的域名
   var $analyticsAccount = ''; // Google Analytics账户
   var $analyticsDomainName = ''; // Google Analytics域名
   

4. 配置重写规则 编辑.htaccess文件，将示例域名twich.me替换为您自己的域名。

5. 完成PHP配置 现在www/目录已经配置完毕。

6. 配置Node服务器 在node/目录下，编辑config.js文件。确保port配置项与_config.php中的$port一致。

7. 启动Node服务器 通过命令行进入node/目录，执行node server.js启动Node服务器。

2. 项目的使用说明

Twich是一个基于Web的聊天应用，用户可以通过浏览器访问http://yourdomain.com来加入聊天室。项目提供了一个简单的用户界面，用户可以输入昵称并选择聊天室。

用户操作

• 输入昵称：用户在进入聊天室前需要输入昵称。
• 选择聊天室：用户可以选择现有的聊天室或创建新的聊天室。
• 发送消息：用户在聊天室内可以发送文本消息。

管理员操作

• 监控聊天室：管理员可以监控所有聊天室的实时活动。
• 管理用户：管理员可以管理用户，包括踢出用户和封禁用户。

3. 项目API使用文档

Twich项目提供了一个简单的API，供开发者进行扩展和集成。

API端点

• /api/chatrooms：获取所有聊天室列表。
• /api/messages：发送或获取聊天消息。

API调用示例

• 获取聊天室列表

  GET /api/chatrooms
  

• 发送消息

  POST /api/messages
  {
    "chatroom_id": "123",
    "user": "user1",
    "message": "Hello!"
  }
  

• 获取聊天消息

  GET /api/messages?chatroom_id=123
  

4. 项目安装方式

Twich项目的安装方式主要是通过手动配置Apache和Node服务器，具体步骤请参考上述“安装指南”。

请确保您的服务器环境符合要求，并严格按照安装步骤进行配置，以确保项目能够顺利运行。