diff --git a/docs/zh/04-get-started/03-package.mdx b/docs/zh/04-get-started/03-package.mdx index 86b534b0255a..89cfd1a4be9f 100644 --- a/docs/zh/04-get-started/03-package.mdx +++ b/docs/zh/04-get-started/03-package.mdx @@ -4,103 +4,19 @@ title: 使用安装包快速体验 TDengine TSDB description: 使用安装包快速体验 TDengine TSDB --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import PkgList from "/src/components/PkgList"; +import InstallationTabs from "../_installation_tabs.mdx"; +import StartTabs from "../_start_tabs.mdx"; + +import Getstarted from "./_get_started.mdx"; 为了能够快速体验 TDengine TSDB 的完整功能,推荐您使用 TDengine TSDB-Enterprise. 本节首先介绍如何通过安装包快速安装 TDengine TSDB-Enterprise, 然后介绍如何在 Linux 环境下体验 TDengine TSDB 的写入、查询、可视化管理、与 Grafana 集成和零代码数据写入等功能。如果您希望为 TDengine TSDB 贡献代码或对内部技术实现感兴趣,请参考 [TDengine TSDB GitHub 主页](https://github.com/taosdata/TDengine). ## 安装 - - - -1. 从列表中下载获得 tar.gz 安装包: - -2. 进入到安装包所在目录,使用 `tar` 解压安装包,以 x64 架构为例: - - ```bash tsdb-ee - tar -zxvf tdengine-tsdb-enterprise-{{VERSION}}-linux-x64.tar.gz - ``` - -3. 进入到安装包所在目录,先解压文件后,进入子目录,执行其中的 install.sh 安装脚本。 - - ```bash - sudo ./install.sh - ``` - - - - -1. 从列表中下载获得最新 Windows 安装程序: - -2. 运行安装程序,根据提示完成 TDengine 的安装。 - - - - -更多类型和版本的安装包,请前往 [TDengine 产品下载中心](https://www.taosdata.com/download-center?product=TDengine+TSDB-Enterprise) 下载。 + ## 启动 - - - -完成安装后,请在终端执行以下脚本,启动所有服务: - -```bash -start-all.sh -``` - -TDengine TSDB 的所有组件均使用 systemd 来进行服务管理,可以使用以下命令查看服务的状态: - -```bash -sudo systemctl status taosd -sudo systemctl status taosadapter -sudo systemctl status taoskeeper -sudo systemctl status taos-explorer -``` - -如果查看到服务的状态为 "Active: active (running) since ...", 则说明服务已经启动成功。 - - - - -安装完成后,请以管理员身份打开一个 cmd 窗口。`start-all.bat` 是统一入口脚本,无参数时默认执行启动,也支持 `status` 和 `stop` 子命令。 - -启动所有服务: - -```cmd -C:\TDengine\start-all.bat -``` - -查看服务状态: - -```cmd -C:\TDengine\start-all.bat status -``` - -停止所有服务: - -```cmd -C:\TDengine\start-all.bat stop -``` - -如果需要分别查看各个 Windows Service 的原始状态,可以使用以下命令: - -```cmd -sc query taosd -sc query taosadapter -sc query taosx -sc query taoskeeper -sc query taos-explorer -``` - -如果 `start-all.bat status` 中显示服务状态为 `running`,或者 `sc query` 输出中包含 `RUNNING`,则说明对应服务已经启动成功。 - - - - -import Getstarted from './_get_started.mdx' + diff --git a/docs/zh/08-operation/03-install.md b/docs/zh/08-operation/03-install.md index a5dc88c3b564..aa5b54d95524 100644 --- a/docs/zh/08-operation/03-install.md +++ b/docs/zh/08-operation/03-install.md @@ -4,9 +4,8 @@ title: 安装部署 toc_max_heading_level: 4 --- -import Tabs from "@theme/Tabs"; -import TabItem from "@theme/TabItem"; -import PkgList from "/src/components/PkgList"; +import InstallationTabs from "../_installation_tabs.mdx"; +import StartTabs from "../_start_tabs.mdx"; TDengine TSDB 完整的软件包包括服务端(taosd)、应用驱动(taosc)、用于与第三方系统对接并提供 RESTful 接口的 taosAdapter、命令行程序(TDengine CLI)和一些工具软件。目前 TDinsight 仅在 Linux 系统上安装和运行,后续将支持 Windows、macOS 等系统。TDengine 除了提供多种语言的连接器之外,还通过 [taosAdapter](../../reference/components/taosadapter/) 提供 [RESTful 接口](../../reference/connector/rest-api/)。 @@ -37,188 +36,11 @@ TDengine TSDB 完整的软件包包括服务端(taosd)、应用驱动(taos ::: - - - -1. 从列表中下载获得 tar.gz 安装包: - -2. 进入到安装包所在目录,使用 `tar` 解压安装包; - - ```bash tsdb - tar -zxvf tdengine-tsdb-oss-{{VERSION}}-linux-x64.tar.gz - ``` - -3. 进入到安装包所在目录,先解压文件后,进入子目录,执行其中的 install.sh 安装脚本。 - - ```bash - sudo ./install.sh - ``` - -:::info -install.sh 安装脚本在执行过程中,会通过命令行交互界面询问一些配置信息。如果希望采取无交互安装方式,那么可以运行 `./install.sh -e no`。运行 `./install.sh -h` 指令可以查看所有参数的详细说明信息。 -::: - - - - -1. 从列表中下载获得 deb 安装包: - -2. 进入到安装包所在目录,执行如下的安装命令: - - ```bash tsdb - sudo dpkg -i tdengine-tsdb-oss-{{VERSION}}-linux-x64.deb - ``` - - - - -1. 从列表中下载获得 rpm 安装包: - -2. 进入到安装包所在目录,执行如下的安装命令: - - ```bash tsdb - sudo rpm -ivh tdengine-tsdb-oss-{{VERSION}}-linux-x64.rpm - ``` - - - - -可以使用 `apt-get` 工具从官方仓库安装。 - -##### 配置包仓库 - -```bash -wget -qO - http://repos.taosdata.com/tdengine.key | sudo apt-key add - -echo "deb [arch=amd64] http://repos.taosdata.com/tdengine-stable stable main" | sudo tee /etc/apt/sources.list.d/tdengine-stable.list -``` - -如果安装 Beta 版需要安装包仓库: - -```bash -wget -qO - http://repos.taosdata.com/tdengine.key | sudo apt-key add - -echo "deb [arch=amd64] http://repos.taosdata.com/tdengine-beta beta main" | sudo tee /etc/apt/sources.list.d/tdengine-beta.list -``` - -##### 使用 `apt-get` 命令安装 - -```bash -sudo apt-get update -apt-cache policy tdengine-tsdb -sudo apt-get install tdengine-tsdb -``` - -:::tip -apt-get 方式只适用于 Debian 或 Ubuntu 系统。 -::: - - - - -1. 从列表中下载获得最新 Windows 安装程序: - -2. 运行可执行程序来安装 TDengine。 - -:::note - -- 从 TDengine TSDB 3.1.0.0 开始,只提供 Windows 客户端安装包。如果需要 Windows 服务端安装包,请联系 TDengine TSDB 销售团队升级为企业版。 - -- 目前 TDengine TSDB 在 Windows 平台上只支持 Windows Server 2016/2019 和 Windows 10/11。 - -- Windows 上需要安装 VC 运行时库,可在此下载安装 [VC 运行时库](https://learn.microsoft.com/zh-cn/cpp/windows/latest-supported-vc-redist?view=msvc-170),如果已经安装此运行库可忽略。 - -::: - - - - -1. 从列表中下载获得最新 macOS 安装包: - -2. 运行可执行程序来安装 TDengine。如果安装被阻止,可以右键或者按 Ctrl 点击安装包,选择 `打开`。 - - - + ## 启动 - - - -安装后,请使用 `systemctl` 命令来启动 TDengine TSDB 的服务进程。 - -```bash -systemctl start taosd -systemctl start taosadapter -systemctl start taoskeeper -systemctl start taos-explorer -``` - -你也可以直接运行 start-all.sh 脚本来启动上面的所有服务 - -```bash -start-all.sh -``` - -可以使用 systemctl 来单独管理上面的每一个服务 - -```bash -systemctl start taosd -systemctl stop taosd -systemctl restart taosd -systemctl status taosd -``` - -:::info - -- `systemctl` 命令需要 _root_ 权限来运行,如果您非 _root_ 用户,请在命令前添加 `sudo`。 -- `systemctl stop taosd` 指令在执行后并不会马上停止 TDengine TSDB 服务,而是会等待系统中必要的落盘工作正常完成。在数据量很大的情况下,这可能会消耗较长时间。 -- 如果系统中不支持 `systemd`,也可以用手动运行 `/usr/local/taos/bin/taosd` 方式启动 TDengine TSDB 服务。 -- 如果希望自定义 TDengine TSDB 服务参数,则参考 [使用 Systemd drop-in 文件自定义 taosd 启动参数](#使用-systemd-drop-in-文件自定义-taosd-启动参数)。 - -::: - - - - -安装后,可以在拥有管理员权限的 cmd 窗口执行 `sc start taosd` 或在 `C:\TDengine TSDB` 目录下,运行 `taosd.exe` 来启动 TDengine TSDB 服务进程。如需使用 http/REST 服务,请执行 `sc start taosadapter` 或运行 `taosadapter.exe` 来启动 taosAdapter 服务进程。 - - - - -安装后,在应用程序目录下,双击 TDengine TSDB 图标来启动程序,也可以运行 `sudo launchctl start` 来启动 TDengine TSDB 服务进程。 - -```bash -sudo launchctl start com.tdengine.taosd -sudo launchctl start com.tdengine.taosadapter -sudo launchctl start com.tdengine.taoskeeper -sudo launchctl start com.tdengine.taos-explorer -``` - -你也可以直接运行 `start-all.sh` 脚本来启动上面的所有服务 - -```bash -start-all.sh -``` - -可以使用 `launchctl` 命令管理上面提到的每个 TDengine TSDB 服务,以下示例使用 `taosd`: - -```bash -sudo launchctl start com.tdengine.taosd -sudo launchctl stop com.tdengine.taosd -sudo launchctl list | grep taosd -sudo launchctl print system/com.tdengine.taosd -``` - -:::info - -- `launchctl` 命令管理 `com.tdengine.taosd` 需要管理员权限,务必在前面加 `sudo` 来增强安全性。 -- `sudo launchctl list | grep taosd` 指令返回的第一列是 `taosd` 程序的 PID,若为 `-` 则说明 TDengine TSDB 服务未运行。 -- 故障排查: -- 如果服务异常请查看系统日志 `launchd.log` 或者 `/var/log/taos` 目录下 `taosdlog` 日志获取更多信息。 - -::: - - - + ## 使用 Systemd drop-in 文件自定义 taosd 启动参数 diff --git a/docs/zh/_installation_tabs.mdx b/docs/zh/_installation_tabs.mdx new file mode 100644 index 000000000000..8824c63395f8 --- /dev/null +++ b/docs/zh/_installation_tabs.mdx @@ -0,0 +1,108 @@ +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; +import PkgList from "/src/components/PkgList"; + + + + + +1. 从列表中下载获得 tar.gz 安装包: + +2. 进入到安装包所在目录,使用 `tar` 解压安装包; + + ```bash tsdb + tar -zxvf tdengine-tsdb-oss-{{VERSION}}-linux-x64.tar.gz + ``` + +3. 进入到安装包所在目录,先解压文件后,进入子目录,执行其中的 install.sh 安装脚本。 + + ```bash + sudo ./install.sh + ``` + +:::info +install.sh 安装脚本在执行过程中,会通过命令行交互界面询问一些配置信息。如果希望采取无交互安装方式,那么可以运行 `./install.sh -e no`。运行 `./install.sh -h` 指令可以查看所有参数的详细说明信息。 +::: + + + + + +方式一:离线方式 +1. 从列表中下载获得 deb 安装包: + +2. 进入到安装包所在目录,执行如下的安装命令: + + ```bash tsdb + sudo dpkg -i tdengine-tsdb-oss-{{VERSION}}-linux-x64.deb + ``` + +方式二:在线方式 +可以使用 `apt-get` 工具从官方仓库安装。 + +##### 配置包仓库 + +```bash +wget -qO - http://repos.taosdata.com/tdengine.key | sudo apt-key add - +echo "deb [arch=amd64] http://repos.taosdata.com/tdengine-stable stable main" | sudo tee /etc/apt/sources.list.d/tdengine-stable.list +``` + +如果安装 Beta 版需要安装包仓库: + +```bash +wget -qO - http://repos.taosdata.com/tdengine.key | sudo apt-key add - +echo "deb [arch=amd64] http://repos.taosdata.com/tdengine-beta beta main" | sudo tee /etc/apt/sources.list.d/tdengine-beta.list +``` + +##### 使用 `apt-get` 命令安装 + +```bash +sudo apt-get update +apt-cache policy tdengine-tsdb +sudo apt-get install tdengine-tsdb +``` + +:::tip +apt-get 方式只适用于 Debian 或 Ubuntu 系统。 +::: + + + + +1. 从列表中下载获得 rpm 安装包: + +2. 进入到安装包所在目录,执行如下的安装命令: + + ```bash tsdb + sudo rpm -ivh tdengine-tsdb-oss-{{VERSION}}-linux-x64.rpm + ``` + + + + + +1. 从列表中下载获得最新 macOS 安装包: + +2. 运行可执行程序来安装 TDengine。如果安装被阻止,可以右键或者按 Ctrl 点击安装包,选择 `打开`。 + + + + + +1. 从列表中下载获得最新 Windows 安装程序: + +2. 运行可执行程序来安装 TDengine。 + +:::note + +- 从 TDengine TSDB 3.1.0.0 开始,只提供 Windows 客户端安装包。如果需要 Windows 服务端安装包,请联系 TDengine TSDB 销售团队升级为企业版。 + +- 目前 TDengine TSDB 在 Windows 平台上只支持 Windows Server 2016/2019 和 Windows 10/11。 + +- Windows 上需要安装 VC 运行时库,可在此下载安装 [VC 运行时库](https://learn.microsoft.com/zh-cn/cpp/windows/latest-supported-vc-redist?view=msvc-170),如果已经安装此运行库可忽略。 + +::: + + + + \ No newline at end of file diff --git a/docs/zh/_start_tabs.mdx b/docs/zh/_start_tabs.mdx new file mode 100644 index 000000000000..c04fa4af69fc --- /dev/null +++ b/docs/zh/_start_tabs.mdx @@ -0,0 +1,82 @@ +import Tabs from "@theme/Tabs"; +import TabItem from "@theme/TabItem"; + + + + +安装后,可以直接运行以下脚本来启动所有服务: + +```bash +start-all.sh +``` + +也可以使用 `systemctl` 命令来启动 TDengine TSDB 的服务进程: + +```bash +systemctl start taosd +systemctl start taosadapter +systemctl start taoskeeper +systemctl start taos-explorer +``` + +可以使用 systemctl 来单独管理上面的每一个服务 + +```bash +systemctl start taosd +systemctl stop taosd +systemctl restart taosd +systemctl status taosd +``` + +:::info + +- `systemctl` 命令需要 _root_ 权限来运行,如果您非 _root_ 用户,请在命令前添加 `sudo`。 +- `systemctl stop taosd` 指令在执行后并不会马上停止 TDengine TSDB 服务,而是会等待系统中必要的落盘工作正常完成。在数据量很大的情况下,这可能会消耗较长时间。 +- 如果系统中不支持 `systemd`,也可以用手动运行 `/usr/local/taos/bin/taosd` 方式启动 TDengine TSDB 服务。 + +::: + + + + + +安装后,可以在拥有管理员权限的 cmd 窗口执行 `sc start taosd` 或在 `C:\TDengine TSDB` 目录下,运行 `taosd.exe` 来启动 TDengine TSDB 服务进程。如需使用 http/REST 服务,请执行 `sc start taosadapter` 或运行 `taosadapter.exe` 来启动 taosAdapter 服务进程。 + + + + + +安装后,在应用程序目录下,双击 TDengine TSDB 图标来启动程序,也可以运行 `sudo launchctl start` 来启动 TDengine TSDB 服务进程。 + +```bash +sudo launchctl start com.tdengine.taosd +sudo launchctl start com.tdengine.taosadapter +sudo launchctl start com.tdengine.taoskeeper +sudo launchctl start com.tdengine.taos-explorer +``` + +你也可以直接运行 `start-all.sh` 脚本来启动上面的所有服务 + +```bash +start-all.sh +``` + +可以使用 `launchctl` 命令管理上面提到的每个 TDengine TSDB 服务,以下示例使用 `taosd`: + +```bash +sudo launchctl start com.tdengine.taosd +sudo launchctl stop com.tdengine.taosd +sudo launchctl list | grep taosd +sudo launchctl print system/com.tdengine.taosd +``` + +:::info + +- `launchctl` 命令管理 `com.tdengine.taosd` 需要管理员权限,务必在前面加 `sudo` 来增强安全性。 +- `sudo launchctl list | grep taosd` 指令返回的第一列是 `taosd` 程序的 PID,若为 `-` 则说明 TDengine TSDB 服务未运行。 +- 如果服务异常请查看系统日志 `launchd.log` 或者 `/var/log/taos` 目录下 `taosdlog` 日志获取更多信息。 + +::: + + + \ No newline at end of file