Skip to content

Latest commit

 

History

History
206 lines (156 loc) · 12.6 KB

README-zh.md

File metadata and controls

206 lines (156 loc) · 12.6 KB
Raw

Agora Flat Server

项目 flat-server 是 Agora Flat 开源教室搭配使用的 Node.js 后端。主要是用于响应 Flat 前端的请求：

特性

  • 帐户系统
    • 微信登陆
    • Github 登陆
    • 谷歌登陆
  • 房间管理
    • 预定房间
    • 周期性房间
  • 互动白板、实时音视频（RTC）、即时消息（RTM）签名鉴权
  • 云端录制回放
  • 多媒体课件云存储（云盘）

本地开发

通过以下方式可以让 flat-server 在本地中运行起来：

安装

  1. 因涉及到 Github Action 等配置，请先右上方 Fork 此项目，然后再 git clone fork 出来的项目克隆到本地。
  2. 在项目根目录执行： 
    yarn install --frozen-lockfile

配置环境变量

  1. 创建两个文件 config/.env.development.local 和 config/.env.production.local。
  2. 按照文件 config/.env.default 的格式添加环境变量。

配置 MySQL、Redis

  1. 如果没有远程的 MySQL 和 Redis ，请先在本地安装 Docker。
  2. 安装好 Docker 之后，选一个合适的位置创建一个文件夹，如: mkdir -p ~/Data/Docker/MySQL ~/Data/Docker/Redis
  3. 根据上一步 .env.* 文件中 MySQL 和 Redis 相关的值来配置，比如以下方 .env.* 配置为例：
REDIS_HOST=127.0.0.1
REDIS_PORT=6379
# 你的自定义 Redis 密码
REDIS_PASSWORD=
# 也可以选择其他的 db
REDIS_DB=0

MYSQL_HOST=127.0.0.1
MYSQL_PORT=3306
MYSQL_USER=root
# 你的自定义 MySQL 密码
MYSQL_PASSWORD=
# 或其它自定义的表名
MYSQL_DB=flat_server

MySQL

  1. 控制台中输入：（注意末尾的分号不能删去） 
    cd ~/Data/Docker/MySQL
docker run -dit -p 3306:3306 --name mysql --restart always -v `pwd`/data:/var/lib/mysql -v `pwd`/conf.d:/etc/mysql/conf.d -e MYSQL_ROOT_PASSWORD=你在env里MYSQL_PASSWORD所填写的值  mysql
docker exec -it mysql bash
mysql -uroot -p 你在env里MYSQL_PASSWORD所填写的值
CREATE DATABASE 你在env里MYSQL_DB所填写的值;
  2. 在项目 src/v1/thirdPartyService/TypeORMService.ts 的 createConnection 配置参数对象中，添加属性: synchronize: true。这个选项是为了同步数据库表、字段到数据库中。
  3. 执行 node ./dist/index.js。
  4. 执行完成后，删除 synchronize: true。这个属性只有修改了数据库字段信息的时候才会需要。

Redis

打开控制台输入：

cd ~/Data/Docker/Redis
docker run -dit -p 6379:6379 --name redis -v `pwd`/data:/data -v `pwd`/conf:/usr/local/etc/redis --restart always redis --requirepass "你在env里REDIS_PASSWORD所填写的值"

运行项目

  1. 项目根目录执行： 
    yarn run start
  2. 打开另一个控制台，执行： 
    node ./dist/index.js

如果启动成功，那么控制台应该会出现 ready on http://0.0.0.0:80。

部署

本地开发不需要部署。如果需要上线，依据你习惯的方式部署，比如通过 Github Action：

  1. 如前面 fork 的仓库名为 你的用户名/flat-server 在 https://github.com/你的用户名/flat-server/settings/secrets/actions 中添加上面 .env.* 同样的内容。
  2. 同时额外加上下方 环境变量值参考 末尾的 DOCKERHUB_*、SSH_* 内容。

环境变量值参考

变量名 描述 备注
SERVER_PORT 服务公开暴露的端口 如 8087
REDIS_HOST Redis 连接地址 如 127.0.0.1
REDIS_PORT Redis 连接端口 如 6379
REDIS_PASSWORD Redis 连接密码
REDIS_DB Redis 连接 db 名 如 0
MYSQL_HOST MySQL 连接地址 如 127.0.0.1
MYSQL_PORT MySQL 连接端口 如 3306
MYSQL_USER MySQL 用户名 如 root
MYSQL_PASSWORD MySQL 密码
MYSQL_DB MySQL 要连接的数据库名 推荐: flat_server
JWT_SECRET JWT 秘钥
JWT_ALGORITHMS JWT 加密算法 见: Algorithms supported
CLOUD_STORAGE_CONCURRENT 云盘同一时间上传文件数 默认: 3
CLOUD_STORAGE_SINGLE_FILE_SIZE 云盘上传单个文件大小最大值 默认: 524288000（500M）
CLOUD_STORAGE_TOTAL_SIZE 云盘总量最大值 默认: 2147483648（2G）
CLOUD_STORAGE_PREFIX_PATH 云盘上传路径的前缀 默认: cloud-storage，前后不能有 /
CLOUD_STORAGE_ALLOW_FILE_SUFFIX 云盘支持上传的文件扩展名 默认：ppt,pptx,doc,docx,pdf,png,jpg,jpeg,gif
WEB_WECHAT_APP_ID 微信开放平台 App ID 见 网站应用 里 AppID
WEB_WECHAT_APP_SECRET 微信开放平台 App 密钥 见 网站应用 里 AppSecret
MOBILE_WECHAT_APP_ID 微信开放平台 App ID 见 移动应用 里 AppID
MOBILE_WECHAT_APP_SECRET 微信开放平台 App 秘钥 见 移动应用 里 AppSecret
GITHUB_CLIENT_ID Github Client ID 见 Authorizing OAuth Apps
GITHUB_CLIENT_SECRET Github Client Secret 见 Authorizing OAuth Apps
AGORA_APP_ID Agora App ID 用于 RTC 与 RTM。见: Use an App ID for authentication
AGORA_APP_CERTIFICATE Agora App Certificate 见: Enable the App Certificate
AGORA_RESTFUL_ID Agora RESTful ID 用于课程回放。见: Restful Authentication
AGORA_RESTFUL_SECRET Agora RESTful Secret 见: Restful Authentication
AGORA_OSS_VENDOR Agora 云端录制 OSS 配置 用于云端录制存储用户音视频。见: Cloud Recording Start -> Schema -> clientRequest -> storageConfig
AGORA_OSS_ACCESS_KEY_ID Agora 云端录制 OSS 配置 同上
AGORA_OSS_ACCESS_KEY_SECRET Agora 云端录制 OSS 配置 同上
AGORA_OSS_REGION Agora 云端录制 OSS 配置 同上
AGORA_OSS_BUCKET Agora 云端录制 OSS 配置 同上
AGORA_OSS_FOLDER Agora 云端录制 OSS 配置 同上
AGORA_OSS_PREFIX Agora 云端录制 OSS 配置 同上
NETLESS_ACCESS_KEY Netless 白板 AK 见: Projects and permissions
NETLESS_SECRET_ACCESS_KEY Netless 白板 SK 见: Projects and permissions
ALIBABA_CLOUD_OSS_ACCESS_KEY 阿里云 OSS AK 用于云盘，存储多媒体课件资源。见: 访问秘钥
ALIBABA_CLOUD_OSS_ACCESS_KEY_SECRET 阿里云 OSS SK 同上
ALIBABA_CLOUD_OSS_BUCKET 阿里云 OSS bucket 见: 存储空间
ALIBABA_CLOUD_OSS_REGION 阿里云 OSS region 见: 地域

如果需要远程部署，需额外添加以下变量

变量名 描述 备注
DOCKERHUB_USERNAME 你的 hub.docker.com 的账户名
DOCKERHUB_TOKEN 在 hub.docker 的 设置页面 生成的 token
SSH_HOST 部署的 SSH 地址
SSH_USERNAME SSH 用户名
SSH_KEY SSH 秘钥 由 ssh-keygen -t rsa -b 4096 生成的秘钥（以: -----BEGIN OPENSSH PRIVATE KEY----- 开头）。然后需要进入到服务器里，把 ssh 公钥追加到 ~/.ssh/authorized_keys 里
SSH_PORT SSH 连接端口

技术选型