datart Documentation

repository·master·Indexed 25 days ago

https://github.com/running-elephant/datart

An open data visualization platform for the agile creation of reports, dashboards, and data applications. datart features a pluggable ecosystem for custom chart extensions, supports integration into enterprise systems via SDKs, and provides augmented analytics. The platform supports deployment via Docker or local installation using JDK 1.8+ and MySQL 5.7+, with management scripts provided for server lifecycle control.

Tokens
38.2K
Snippets
38
Records
272
Agent score
80%

What's inside datart

  1. What is datart?

    master

    datart is a next-generation open data visualization platform designed for agile construction of reports, dashboards, large screens, analysis, and visual data applications. It aims to balance data and art by providing an open, integrable, and intelligent ecosystem.

    Key pillars of the platform include:

    • Openness: Standardized processes for Managed VizApp (Source > View > Chart > Visualization), standardized interaction capabilities (filtering, drilling, linking, etc.), and pluggable extensions via SDKs.
    • Integrability: Designed to be embedded or integrated into third-party systems via login/permission docking, Source layer docking, and Visualization layer SDKs.
    • Augmented Analytics: Provides extensible data augmentation capabilities to move beyond simple data inspection toward answering 'Why' through visual insights.
  2. Configure an external MySQL database in Docker

    master

    It is strongly recommended to use a MySQL database instead of the default H2. To do this, create a datart.conf file with your database credentials and server settings, then mount it into the container.

    Example datart.conf content:

    # 数据库连接配置
    datasource.ip=   
    datasource.port=
    datasource.database=
    datasource.username=
    datasource.password=
    
    # server
    server.port=8080
    server.address=0.0.0.0
    
    # datart config
    datart.address=http://127.0.0.1
    datart.send-mail=false
    datart.webdriver-path=http://127.0.0.1:4444/wd/hub

    Run command:

    docker run -d --name datart -v your_path/datart.conf:/datart/config/datart.conf -p 8080:8080 datart/datart
  3. Install Datart locally

    master

    You can install Datart either by unzipping the official package or by compiling from source.

    Option 1: Unzip official package

    unzip datart-server-1.0.0-beta.x-install.zip

    Option 2: Build from source

    git clone https://github.com/running-elephant/datart.git
    cd datart
    mvn clean package -Dmaven.test.skip=true
    # Copy the resulting zip to your deployment directory, then unzip it.
  4. Configure ChromeWebDriver for screenshots

    master

    To enable screenshot functionality, you can run a standalone Selenium Chrome container via Docker:

    1. Pull and run Selenium:
    docker pull selenium/standalone-chrome
    docker run -p 4444:4444 -d --name selenium-chrome --shm-size="2g" selenium/standalone-chrome
    1. Configure in application-config.yml:
    datart:
      screenshot:
        timeout-seconds: 60
        webdriver-type: CHROME
        webdriver-path: "http://youip:4444/wd/hub"
    docker run -p 4444:4444 -d --name selenium-chrome --shm-size="2g" selenium/standalone-chrome
  5. Configure external MySQL for local deployment

    master

    For production-ready local deployments, use MySQL 5.7 or higher.

    1. Create the database:
    CREATE DATABASE `datart` CHARACTER SET 'utf8' COLLATE 'utf8_general_ci';

    Note: For versions 1.0.0-beta.2 and above, the database initializes automatically on the first connection. Use a high-privilege account (like root) for the first connection to ensure initialization scripts succeed.

    1. Configure config/datart.conf: Edit the following keys:
    • datasource.ip: Database IP
    • datasource.port: Database port
    • datasource.database: Database name
    • datasource.username: Username
    • datasource.password: Password
    • server.port: Application port (default 8080)
    • server.address: Application binding IP (default 0.0.0.0)
    • datart.address: External accessible address (default http://127.0.0.1)
  6. Run Datart in standalone mode

    master

    After unzipping the installation package, you can start Datart in standalone mode. Note that standalone mode uses an embedded database, which is not recommended for production due to data security and migration limitations.

    Start command:

    ./bin/datart-server.sh start

    Default access: http://127.0.0.1:8080 (User: demo / Pass: 123456)

  7. Persist user files in Docker

    master

    By default, user files (avatars, file data sources, etc.) are stored in the files folder. To prevent data loss during upgrades, mount this directory to an external path using the -v flag.

    docker run -d --name datart -v your_path/datart.conf:/datart/config/datart.conf -v your_path/files:/datart/files -p 8080:8080 datart/datart