GreptimeDB Dashboard

Dashboard is a data-visualization platform for GreptimeDB developed with Vue3, Vite, TypeScript and Arco Design.

Quick Start

You can try out our Dashboard in one of the following ways: (1) using GreptimeDB's binary, (2) using Docker, or (3) using the Desktop App.

With GreptimeDB's binary

• Download GreptimeDB's pre-built binary here.
• Start GreptimeDB normally.
• Visit http://localhost:4000/dashboard

With Docker

⭐We recommend using docker-compose to setup both greptimedb and dashboard.

1. Use the curl command to get the docker-compose configuration file

curl -O https://raw.githubusercontent.com/greptimeteam/dashboard/main/docker/docker-compose.yml

Tips: If you encounter network-related problems, you can download the docker-compose.yml file manually or simply copy and paste the contents into an empty yml file on your machine or server, based on what you need.

2. Launching the application

docker compose up

3. Open your browser and visit http://localhost:8080/dashboard/

• Follow getting started to create your table and insert some data
• Run a SELECT query and check the result as table or chart

We recommend using docker-compose to setup both greptimedb and dashboard.

curl -O https://raw.githubusercontent.com/greptimeteam/dashboard/main/docker/docker-compose.yml
docker compose up

Open you browser and visit http://localhost:8080/dashboard/

• Follow getting started to create your table and insert some data
• Run a SELECT query and check the result as table or chart -->

Dashboard Desktop App

With the desktop version of the Dashboard app, you can run it independently, connecting to a local or remote GreptimeDB instance.

• Download the Dashboard App from release page

Development Setup

• Install GreptimeDB
• Run ./greptime standalone start
• Clone this project git clone https://github.com/GreptimeTeam/dashboard.git
• Run pnpm install for dependencies
• Run pnpm run dev and visit the URL in output

Screenshot

Query - Result

Query - Explain

Contributing

• Please refer to contribution guidelines for more information.
• This is an early-stage version of our Dashboard. We're continuously adding new features, and we warmly welcome contributions of all kinds.

License

This project is open source under Apache 2.0 license