astarte/astarte-dashboard

Astarte Dashboard

Astarte Dashboard是一个Web UI，用于可视化领域状态并执行管理任务，如安装接口和触发器、管理设备、管道和流程。

https://github.com/davidebriani/astarte/blob/docs/add-astarte-dashboard-documentation/doc/images/astarte-dashboard-realm-overview.png

目录

• 试用！
• 本地运行
  • 前提条件
  • 配置
  • 运行
• 贡献
  • 依赖项
  • 启动本地服务器
  • 测试
• 许可证

试用！

Astarte Dashboard默认部署在所有Astarte实例上。

当使用__docker-compose__本地部署时，访问http://localhost:4040%E3%80%82

在__Kubernetes__集群上，URL在Astarte Voyager入口控制器配置中指定。

或在Astarte Cloud上试用__Astarte即服务__。

本地运行

前提条件

开始前必须具备：

• https://docs.docker.com/get-docker/ 19.0或更高版本。
• 一个运行中的Astarte实例（本地或远程集群）。 如未部署，可参考Astarte 5分钟快速入门。

配置

Astarte Dashboard依赖配置文件设置Astarte API URL等参数。打开Dashboard时，会搜索包含以下键的config.json文件：

• astarte_api_url（必填）： Astarte API端点的基础URL。用于推导所有Astarte组件的端点：

  • AppEngine：api_url + /appengine
  • 领域管理：api_url + /realmmanagement
  • 配对：api_url + /pairing
  • 流程：api_url + /flow

  特殊字符串localhost会设置为Astarte 5分钟快速入门中使用的端点：

  • AppEngine：http://localhost:4002
  • 领域管理：http://localhost:4000
  • 配对：http://localhost:4003
  • 流程：http://localhost:4009

  在自定义部署中，这些URL可能不同，可通过以下可选键覆盖：

  • realm_management_api_url
  • appengine_api_url
  • pairing_api_url
  • flow_api_url

• default_realm（可选）： 默认登录的领域。

• enable_flow_preview（可选）： 要求Astarte集群已配置并运行Flow。启用（设为true）后，仪表板将显示Flow API状态及相关页面（如流程、管道和块）。

• auth（必填）： 可用的登录认证选项列表。

  支持的认证方式：直接令牌或OAuth2隐式授权

  • oauth： 遵循OAuth标准，仪表板会重定向到OAuth提供商登录，成功后重定向回仪表板。

  • token： 需要令牌来认证Astarte API。可使用https://github.com/astarte-platform/astartectl%E4%BB%8E%E9%A2%86%E5%9F%9F%E7%A7%81%E9%92%A5%E7%94%9F%E6%88%90%E4%BB%A4%E7%89%8C%E3%80%82

  如启用多个认证选项，用户可选择任一方式。

• default_auth（必填）： 尝试登录时显示的默认认证选项。

配置示例：

json
{
  "astarte_api_url": "https://api.example.com",
  "enable_flow_preview": true,
  "default_realm": "myrealm",
  "default_auth": "token",
  "auth": [
    {
      "type": "token"
    },
    {
      "type": "oauth",
      "oauth_api_url": "https://auth.example.com"
    }
  ]
}

运行

可使用Dockerhub公共 registry 中的官方Docker镜像轻松运行Astarte Dashboard。

例如，在本地端口4040运行：

sh
docker run \
  -p 4040:80 \
  -v /绝对路径/to/config.json:/usr/share/nginx/html/user-config/config.json \
  astarte/astarte-dashboard:snapshot

贡献

依赖项

Astarte Dashboard使用TypeScript和React框架开发，依赖npm管理包：

• node（10或更高版本）
• npm（6或更高版本）

启动本地服务器

1. 克隆本仓库到本地

   sh
   git clone git@github.com:astarte-platform/astarte-dashboard.git && cd astarte-dashboard
   

2. 安装项目依赖

   sh
   npm install
   

3. 将配置文件放在src/user-config/config.json
4. 启动开发服务器

   sh
   npm run start
   

5. 在浏览器中打开显示的URL，通常为http://localhost:8080

测试

测试使用Cypress，通过无头浏览器模拟用户交互。测试前需启动浏览器可访问的仪表板服务器，使用start-ci命令：

sh
npm run start-ci

服务器启动后，可通过test命令在CLI中运行测试：

sh
npm run test

如需测试特定页面或组件，可打开Cypress GUI：

sh
npm run cypress:open

其他常规测试包括格式检查和类型检查：

sh
 npm run check-format
 npm run check-types

许可证

采用Apache2.0许可证分发。详见LICENSE。