datamini/asktable-secure-tunnel repository overview

⁠AskTable Secure Tunnel (ATST) 用户使用手册

⁠1. 概述

AskTable Secure Tunnel (ATST) 是 AskTable⁠ 团队开发的一个安全工具，允许 AskTable 服务通过安全隧道与内部的本地数据库进行通信。这项服务确保数据源与 AskTable 之间的连接既安全又高效，非常适合需要保证数据通信安全性的企业环境。详见：Github⁠

您可以参考本文档，在您的私有网络中部署并运行 ATST。

⁠2. 开始使用 ATST

部署 ATST 非常简单，首先请按照如下要求准备一台服务器，然后执行一个Docker命令即可。

服务器要求：

1. 网络方面：确保 ATST 服务器可以访问 AskTable 服务和您的数据源。
2. 操作系统：Linux 或 macOS（M1/M2 ARM）
3. 处理器架构：x86 或 ARM
4. 运行环境：请确保您的服务器上已经安装了 Docker。
5. 服务器配置：不低于 2核 4G内存（不需要磁盘）

⁠2.1 下载 ATST 镜像

您可以通过以下命令下载 ATST Docker 镜像

docker pull datamini/asktable-secure-tunnel

⁠2.2 使用方法

启动 ATST 服务前，您需要一个唯一的 Secure Tunnel ID(securetunnel_id)来标识和启动您的 ATST：

1. 创建 securetunnel_id：

   docker run --rm -e ASKTABLE_TOKEN=<asktable_token> datamini/asktable-secure-tunnel create-id
   

   Copy

此命令将返回一个 securetunnel_id，请妥善保存此 ID，因为它是获取您当前 ATST 配置信息的唯一凭证。

1. 启动 ATST 服务：

   docker run  -e ASKTABLE_TOKEN=<asktable_token> \
       [-e SECURETUNNEL_ID=<securetunnel_id>] datamini/asktable-secure-tunnel
   

   Copy

• 如果环境变量中包含securetunnel_id，使用该ID启动。（推荐）
• 如果环境变量中不包含securetunnel_id，自动创建一个ID并启动。（不推荐，因为每次启动都会生成一个新的ID，绑定原ID的数据源将无法访问）

启动后，ATST 将自动从 AskTable 获取配置信息并开始运行，同时定期自动更新。一个 ATST 可以共享给多个数据源使用。

⁠2.3 环境变量配置

• ASKTABLE_API_URL： AskTable 服务的 API 地址，默认为 https://api.asktable.com，无需更改。
• ASKTABLE_TOKEN： AskTable 服务的 API Token，从AskTable网站⁠获取。
• SECURETUNNEL_ID： ATST 的唯一标识。

⁠3. 注册数据源

要让 AskTable 通过 ATST 访问您的内部数据源，您需要注册数据源并指定 securetunnel_id：

from asktable import AskTable
at = AskTable()
at.datasources.register(
    type='mysql', 
    access_config={
        'host': '10.1.2.3', 'port': 3306, 'user': 'xx', 'password': 'xx', 
        'securetunnel_id': 'xxx'
    }
)

在 access_config 配置信息中增加 securetunnel_id 字段，将其设置为您的 securetunnel_id，从而使 AskTable 能够通过 ATST 访问您的数据源。更多信息请参考：AskTable Python Library⁠.

⁠4. 维护和管理 ATST 服务【非常重要】

请不要随意关闭 ATST 服务，否则 AskTable 将无法访问您的数据源。

如果需要重启、升级或迁移 ATST 服务，请确保securetunnel_id不变，以保证数据源的正常访问。

为了保证securetunnel_id的安全性，我们建议您在启动 ATST 服务时使用环境变量来传递securetunnel_id，而不是让 ATST 自动生成。