tinybirdco/tinybird-local repository overview

⁠Tinybird Local Docker Image

⁠What is Tinybird Local?

Tinybird Local is a tool that allows clients to run Tinybird locally.

For more information and documentation about Tinybird see https://tinybird.co⁠

⁠How to use this image

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

By default, the server will run and create a workspace automatically. The Tinybird server is running on port 7181, you can expose it locally using the port you prefer.

An example retrieving the workspace admin token and using it to auth through the CLI:

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

Once authenticated, the default workspace can be listed with the tb workspace ls CLI command:

tb workspace ls

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

⁠License

This Docker image is licensed under the Tinybird Self-Managed License (TSML). For details, see the included LICENSE file in the root folder.

As with all Docker images, this image likely contains other software components that may be licensed under different terms (e.g., Bash or other dependencies from the base distribution, as well as any direct or indirect dependencies of the primary software).

It is the responsibility of the image user to ensure that any use of this image complies with all relevant licenses for the software contained within. Users are encouraged to inspect the software and dependencies included in this image to ensure compliance with all applicable licenses.