143 lines
5.8 KiB
Markdown
143 lines
5.8 KiB
Markdown
---
|
||
title: taosExplorer 参考手册
|
||
sidebar_label: taosExplorer
|
||
toc_max_heading_level: 4
|
||
---
|
||
|
||
taosExplorer 是一个为用户提供 TDengine 实例的可视化管理交互工具的 web 服务。本节主要讲述其安装和部署。它的各项功能都是基于简单易上手的图形界面，可以直接尝试，如果有需要也可以考高级功能和运维指南中的相关内容。
|
||
|
||
## 安装
|
||
|
||
taosEexplorer 无需单独安装，从 TDengine 3.3.0.0 版本开始，它随着 TDengine Enterprise Server 安装包一起发布，安装完成后，就可以看到 `taos-explorer` 服务。
|
||
|
||
## 配置
|
||
|
||
在启动 taosExplorer 之前，请确保配置文件中的内容正确。
|
||
|
||
```TOML
|
||
# listen port
|
||
port = 6060
|
||
|
||
# listen address for IPv4
|
||
addr = "0.0.0.0"
|
||
|
||
# listen address for IPv4
|
||
#ipv6 = "::1"
|
||
|
||
# log level. Possible: error,warn,info,debug,trace
|
||
log_level = "info"
|
||
|
||
# taosAdapter address.
|
||
cluster = "http://localhost:6041"
|
||
|
||
# taosX gRPC address
|
||
x_api = "http://localhost:6050"
|
||
|
||
# GRPC endpoint for "Agent"s.
|
||
grpc = "http://localhost:6055"
|
||
|
||
# CORS configuration switch, it allows cross-origin access
|
||
cors = false
|
||
|
||
# Enable ssl: if the following two files exist, enable ssl protocol
|
||
[ssl]
|
||
# SSL certificate
|
||
#certificate = "/path/to/ca.file"
|
||
# SSL certificate key
|
||
#certificate_key = "/path/to/key.file"
|
||
```
|
||
|
||
说明：
|
||
|
||
- `port`：taosExplorer 服务绑定的端口。
|
||
- `addr`：taosExplorer 服务绑定的 IPv4 地址，默认为 `0.0.0.0`。如需修改，请配置为 `localhost` 之外的地址以对外提供服务。
|
||
- `ipv6`：taosExplorer 服务绑定的 IPv6 地址，默认不绑定 IPv6 地址。
|
||
- `log_level`：日志级别，可选值为 "error", "warn", "info", "debug", "trace"。
|
||
- `cluster`：TDengine 集群的 taosAdapter 地址。
|
||
- `x_api`：taosX 的 gRPC 地址。
|
||
- `grpc`: taosX 代理向 taosX 建立连接的 gRPC 地址.
|
||
- `cors`：CORS 配置开关，默认为 `false`。当为 `true` 时，允许跨域访问。
|
||
- `ssl.certificate`: SSL 证书（如果同时设置了 certificate 与 certificate_key 两个参数，则启用 HTTPS 服务，否则不启用）。
|
||
- `ssl.certificate_key`: SSL 证书密钥。
|
||
|
||
## 启动停止
|
||
|
||
然后启动 taosExplorer，可以直接在命令行执行 taos-explorer 或者使用 systemctl 命令：
|
||
|
||
```bash
|
||
systemctl start taos-explorer # Linux
|
||
sc.exe start taos-explorer # Windows
|
||
```
|
||
|
||
相应地，用如下命令停止
|
||
```shell
|
||
systemctl stop taos-explorer # Linux
|
||
sc.exe stop taos-explorer # Windows
|
||
```
|
||
|
||
## 问题排查
|
||
|
||
1. 当通过浏览器打开 Explorer 站点遇到“无法访问此网站”的错误信息时，请通过命令行登录 taosExplorer 所在机器，并使用命令 `systemctl status taos-explorer` 检查服务的状态，如果返回的状态是 `inactive`，请使用命令`systemctl start taos-explorer` 启动服务。
|
||
2. 如果需要获取 taosExplorer 的详细日志，可通过命令 `journalctl -u taos-explorer`。
|
||
3. 当使用 Nginx 或其他工具进行转发时，注意进行 CORS 设置或在配置文件中使用 `cors = true`。
|
||
|
||
这是一个 Nginx 配置文件 CORS 设置的例子：
|
||
|
||
```conf
|
||
http {
|
||
server {
|
||
listen 6060;
|
||
location ~* {
|
||
proxy_pass http://explorer;
|
||
|
||
if ($request_method = 'OPTIONS') {
|
||
add_header 'Access-Control-Allow-Origin' '*';
|
||
|
||
add_header 'Access-Control-Allow-Credentials' 'true';
|
||
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
|
||
|
||
add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
|
||
|
||
add_header 'Access-Control-Max-Age' 86400;
|
||
add_header 'Content-Type' 'text/plain charset=UTF-8';
|
||
add_header 'Content-Length' 0;
|
||
return 204; break;
|
||
}
|
||
|
||
if ($request_method = 'POST') {
|
||
add_header 'Access-Control-Allow-Origin' '*';
|
||
add_header 'Access-Control-Allow-Credentials' 'true';
|
||
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
|
||
add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
|
||
}
|
||
if ($request_method = 'GET') {
|
||
add_header 'Access-Control-Allow-Origin' '*';
|
||
add_header 'Access-Control-Allow-Credentials' 'true';
|
||
add_header 'Access-Control-Allow-Methods' 'GET, POST, OPTIONS';
|
||
add_header 'Access-Control-Allow-Headers' 'DNT,X-CustomHeader,Keep-Alive,User-Agent,X-Requested-With,If-Modified-Since,Cache-Control,Content-Type';
|
||
}
|
||
|
||
proxy_set_header Host $host:$server_port;
|
||
proxy_set_header X-Real-IP $remote_addr;
|
||
|
||
#proxy_http_version 1.1;
|
||
proxy_read_timeout 60s;
|
||
proxy_next_upstream error http_502 http_500 non_idempotent;
|
||
}
|
||
}
|
||
upstream explorer{
|
||
ip_hash;
|
||
server 192.168.1.65:6060 ;
|
||
server 192.168.1.68:6060 ;
|
||
}
|
||
}
|
||
```
|
||
|
||
## 注册登录
|
||
|
||
安装好，打开浏览器，默认访问`http://ip:6060`来访问 taos-explorer 服务。如果还没有注册过，则首先进入注册界面。输入手机号获取验证码，输入正确的验证码后，即可注册成功。
|
||
|
||
登录时，请使用数据库用户名和密码登录。首次使用，默认的用户名为 `root`，密码为 `taosdata`。登录成功后即可进入`数据浏览器`页面，您可以使用查看数据库、 创建数据库、创建超级表/子表等管理功能。
|
||
|
||
其他功能页面，如`数据写入-数据源`等页面，为企业版特有功能，您可以点击查看和简单体验，并不能实际使用。
|