tinybirdco/tinybird-local

Tinybird Local Docker镜像

镜像概述和主要用途

Tinybird Local是一款允许客户端在本地运行Tinybird的工具，提供了在本地环境部署和使用Tinybird的能力。通过该Docker镜像，用户可快速搭建本地Tinybird服务，无需依赖云环境即可进行Tinybird功能的开发、测试和使用。有关Tinybird的更多信息和官方文档，请访问 [***]

核心功能和特性

• 本地部署支持：通过Docker容器化方式，一键启动本地Tinybird服务，简化环境配置流程。
• 工作区自动创建：服务启动时自动创建默认工作区，无需手动初始化。
• 端口灵活映射：默认使用7181端口提供服务，支持通过Docker端口映射自定义本地访问端口。
• CLI认证集成：支持通过工作区管理员token进行CLI工具认证，实现本地命令行操作。
• 工作区管理：可通过Tinybird CLI命令查看和管理本地工作区信息。

使用场景和适用范围

• 本地开发环境：开发人员在本地开发Tinybird数据源、管道或API时，无需连接远程服务即可测试功能。
• 离线环境使用：在无法访问互联网的离线环境中，通过本地部署使用Tinybird核心功能。
• 功能验证测试：快速验证Tinybird功能特性，或进行本地环境下的兼容性测试。

使用方法和配置说明

基本部署命令

通过以下Docker命令启动Tinybird Local服务：

bash
docker run --platform linux/amd64 -p 7181:7181 -e COMPATIBILITY_MODE=1 --name tinybird-local -d tinybirdco/tinybird-local:latest

参数说明：

• --platform linux/amd64：指定运行平台为linux/amd64。
• -p 7181:7181：端口映射，将容器内7181端口映射到本地7181端口（本地端口可自定义，如-p 8080:7181）。
• -e COMPATIBILITY_MODE=1：设置兼容性模式环境变量。
• --name tinybird-local：指定容器名称为tinybird-local。
• -d：后台运行容器。
• tinybirdco/tinybird-local:latest：使用最新版本的Tinybird Local镜像。

获取工作区管理员Token

服务启动后，可通过以下命令获取工作区管理员token（需安装jq工具解析JSON）：

bash
TOKEN=$(curl -s http://localhost:7181/tokens | jq -r ".workspace_admin_token")

CLI认证与使用

1. 通过CLI认证：使用获取的token通过Tinybird CLI进行本地服务认证：

   bash
   tb --host http://localhost:7181 --token $TOKEN auth
   

2. 查看工作区列表：认证成功后，可通过以下命令查看默认工作区信息：

   bash
   tb workspace ls
   

   示例输出：

   ** Workspaces:
   --------------------------------------------------------------------------------------------
   | name                   | id                                   | role  | plan   | current |
   --------------------------------------------------------------------------------------------
   | Tinybird_Local_Testing | 7afc6330-3aae-4df5-8712-eaad216c5d7d | admin | Custom | True    |
   --------------------------------------------------------------------------------------------
   

许可证信息

本Docker镜像基于Tinybird自管理许可证（TSML）授权。详细信息请参见镜像根目录下的LICENSE文件。

与所有Docker镜像一样，本镜像可能包含其他软件组件（例如基础发行版中的Bash或其他依赖项，以及主要软件的直接或间接依赖项），这些组件可能采用不同的许可条款。镜像用户有责任确保对本镜像的任何使用均符合其中包含的所有软件的相关许可。鼓励用户检查本镜像中包含的软件和依赖项，以确保符合所有适用许可。