Quick Start

Install

git clone https://github.com/oqtopus-team/qdash.git

Initial Setup

Create the environment file from the example.

cp .env.example .env

Start the Application

docker compose up -d

You can now access the application at localhost:5714 .

Create account

Now, your data is not setup yet. You need to initialize the database with your data.

Setup devcontainer

docker compose -f compose.devcontainer.yaml up -d

Install QDash CLI

docker compose -f compose.devcontainer.yaml exec devcontainer sh -c "pip install -e ."

Initialize the Database

docker compose -f compose.devcontainer.yaml exec devcontainer sh -c "qdash init-all-data --username <your-username> --chip-id <your-chip-id>"

You can now access the application at localhost:5714 .

Remote access (Cloudflare Tunnel)

You can share QDash securely without opening extra ports by using Cloudflare Tunnel.

1. Create a tunnel in the Cloudflare dashboard and copy the issued TUNNEL_TOKEN.
2. Add the token to your .env file (e.g. TUNNEL_TOKEN=...).
3. Start the tunnel with docker compose --profile tunnel up -d tunnel.
4. Confirm in the Cloudflare dashboard that the tunnel status is “Connected”.

Once connected, the hostname provided by Cloudflare (for example https://your-tunnel.example.com) will serve the same UI experience as http://localhost:5714, including charts and figures.