Skip to content

README.md

Latest commit

 

History

History
178 lines (124 loc) · 4.82 KB

README.md

File metadata and controls

178 lines (124 loc) · 4.82 KB
Raw

RocketMQ-Rust Dashboard (Tauri)

A RocketMQ-Rust Dashboard GUI implemented with Tauri.

Features

  • Native desktop application with web-based UI
  • Cross-platform support (Linux, macOS, Windows)
  • Backend written in Rust
  • Frontend built with modern web technologies:
    • React - UI Library
    • Vite - Build Tool
    • Tailwind CSS & Radix UI - Styling and UI Components
    • Recharts - Data Visualization
  • Small bundle size and low resource usage
  • Secure with minimal attack surface

UI Preview & Feature Status

Dashboard UI Preview

Note: The features shown in the sidebar menu are currently under development.

Feature Development Roadmap

Category Feature Status
Platform NameServer 🚧 In Development
Dashboard 🚧 In Development
Proxy 🚧 In Development
Cluster 🚧 In Development
Messaging Topic 🚧 In Development
Consumer 🚧 In Development
Producer 🚧 In Development
Message 🚧 In Development
MessageTrace 🚧 In Development
DLQMessage 🚧 In Development
Advanced ACL Management 🚧 In Development

Installation

Prerequisites

  • Rust toolchain (1.77.2 or later)
  • Node.js and npm
  • Platform-specific dependencies:
    • Windows: WebView2
    • macOS: No additional dependencies
    • Linux: webkit2gtk, libssl, and other dependencies (see Tauri prerequisites)

Build from source

Using NPM

# Clone the repository
git clone https://github.com/mxsm/rocketmq-rust.git
cd rocketmq-rust/rocketmq-dashboard/rocketmq-dashboard-tauri

# Install frontend dependencies
npm install

# Build the application
npm run tauri build

Using Cargo

If you prefer using Cargo, you can install the Tauri CLI:

cargo install tauri-cli

Then build the project:

# Install frontend dependencies (still required)
npm install

# Build the application
cargo tauri build

The binary will be available in src-tauri/target/release/.

Quick Start

Default Login Credentials

⚠️ Note: This is a temporary authentication implementation. A more comprehensive authentication system with additional security features (password change UI, multi-user support, role-based access control) will be implemented in future versions.

When you first run the application, a default configuration will be created with the following credentials:

  • Username: admin
  • Password: admin123

⚠️ Security Notice: Please change the default password after your first login!

The authentication configuration is stored at:

  • Windows: %APPDATA%\com.rocketmqrust.dashboard\auth_config.json
  • macOS: ~/Library/Application Support/com.rocketmqrust.dashboard/auth_config.json
  • Linux: ~/.config/rocketmq-rust-dashboard/auth_config.json

For more details on authentication and security, see AUTH_CONFIG.md.

Development Mode

Using NPM

# Install dependencies
npm install

# Start the development server
npm run tauri dev

Using Cargo

# Install dependencies
npm install

# Start the development server
cargo tauri dev

Build for Production

# Using NPM
npm run tauri build

# OR Using Cargo
cargo tauri build

With Logging

Development mode includes debug logging by default. Check the console for logs.

Project Structure

rocketmq-dashboard-tauri/
├── src/                     # Frontend source code
├── src-tauri/              # Rust backend
│   ├── src/
│   │   ├── main.rs        # Application entry point
│   │   └── lib.rs         # Library exports
│   ├── Cargo.toml         # Rust dependencies
│   ├── tauri.conf.json    # Tauri configuration
│   └── icons/             # Application icons
├── package.json            # Node.js dependencies
└── README.md

Scripts

  • npm run dev - Start frontend development server
  • npm run build - Build frontend for production
  • npm run tauri dev - Start Tauri development mode
  • npm run tauri build - Build application for production

License

Licensed under either of:

at your option.

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.