简体中文
简体中文
English
联系我们
注册
登录
语言
简体中文
简体中文
English
联系我们
登录
注册
返回主站
layout空间导航
文档中心云开发SaaS 开发框架运行 SaaS 开发框架 Docker 镜像

运行 SaaS 开发框架 Docker 镜像

更新时间:2021-09-24 01:49:32下载pdf

SaaS 开发框架是基于涂鸦云 OpenAPI 开发的网页版 IoT SaaS 开发框架应用,以 Docker 镜像形式提供。通过 SaaS 开发框架,您可以实现资产管理、设备管理、设备控制等基本功能,快速部署至服务器。

前置条件

搭建 Docker 环境

该应用通过 Docker 镜像形式部署,需要 Docker 运行环境。如果您使用的是 PC 或 Mac,建议您根据 Docker 官方指引安装 Docker Desktop

创建云开发项目

创建项目详情参见 创建项目。创建项目过程中请注意以下项目配置信息。

  • 选择自定义开发开发方式
  • 在默认的配置 API 基础上添加行业通用权限管理邮件服务短信服务,完整API 列表如下。
    • 授权管理
    • 行业通用设备注册
    • 行业通用设备管理
    • 行业通用设备状态查询
    • 行业通用设备控制
    • 行业通用用户管理
    • 行业通用资产管理
    • 行业通用权限管理
    • 邮件服务
    • 短信服务

    说明: 开通 API 产品方法查看 管理 API

记录配置参数

  • Access ID 和 Access Secret:在云应用授权密钥获取。
  • 项目 ID:项目页面 URL 地址中的项目 ID,以小写字母 p 开头。

运行 SaaS 开发框架 Docker 镜像

镜像部署

  1. 在安装好 Docker Desktop 或其他 Docker 环境后,使用 Windows 的 CMD 工具或者 Mac/Linux 的终端工具,通过以下命令下载 Docker 镜像。

    docker pull iotportal/iot-suite:latest
    
  2. 在当前目录创建环境配置文件 iot-suite.env

    AK=
    SK=
    PC=
    PERMISSION_SPACE_OWNER=
    PERMISSION_SPACE_GROUP=
    PERMISSION_SPACE_CODE=
    REGION=
    SMS_TEMPLATEID_CN=
    SMS_TEMPLATEID_EN=
    MAIL_TEMPLATEID_CN=
    MAIL_TEMPLATEID_EN=
    

    环境变量释义如下。

    变量名 含义 示例 是否必需
    AK Access ID qyp5t3********vzp7b1
    SK Access Secret 1048e7f02****************55168
    PC 项目 ID p1616********7dmk
    PERMISSION_SPACE_OWNER 权限空间拥有人 tuyaSaas
    PERMISSION_SPACE_GROUP 权限空间分组(与projectCode项目ID一致 ) p1616********7dmk
    PERMISSION_SPACE_CODE 权限空间代码 iot-server
    REGION 可用区域,目前支持 CN、US、EU、IN CN
    SMS_TEMPLATEID_CN 中文短信模板ID SMS_458****330
    SMS_TEMPLATEID_EN 英文短信模板ID SMS_911****540
    MAIL_TEMPLATEID_CN 中文邮件模板ID MAIL_605****151
    MAIL_TEMPLATEID_EN 英文邮件模板ID MAIL_802****485

    说明: 其中短信模板 ID 和邮件模板 ID,可在涂鸦云开发的短信服务和邮件服务 API 产品里通过 API 调用申请,您可以使用 API Explorer 快速模拟调用。

  3. 镜像下载完成后,请通过以下命令运行镜像。

    docker run --name iot -d -p 80:80 --env-file ./iot-suite.env iotportal/iot-suite:latest
    
  4. 使用命令 docker start iot 启动,或者在 Docker Dashboard 中启动镜像。

  5. Docker 镜像运行后,在浏览器访问 http://localhost/login ,并使用以下信息登录。

    • 账号:admin@tuya.com
    • 密码:Admin123456

SaaS 开发框架使用说明

在当前版本的 SaaS 开发框架中,我们提供最基础的资产管理、设备管理、设备状态查询、设备控制功能。

资产管理

在开始添加涂鸦 IoT 设备前,您首先需要在资产管理下新增资产。资产是设备存在的空间位置,使用配套的小程序或 App 将设备添加到相应的资产下,即可在 SaaS 开发框架中对设备进行管理和控制。
运行 SaaS 开发框架 Docker 镜像

设备管理

在设备管理页面,您可以通过设备列表右上角展示的相应工具完成设备的添加。添加后的设备会出现在设备列表中。您可以打开设备的控制界面,查看设备最新状态,或对设备下发控制指令。
运行 SaaS 开发框架 Docker 镜像