Dashpub Documentation

Welcome to the comprehensive documentation for Dashpub - A modern, high-performance dashboard system built with Node.js, Express, React, and Vite, designed to display Splunk data with real-time updates, caching, and comprehensive visualization support.

🚀 Quick Start

Get up and running in minutes:

# Clone the repository
git clone <repository-url>
cd dashpub-v2-testing

# Initialize a new project
node cli/cli.js init

# Navigate to the app directory
cd app

# Install dependencies
npm install

# Start development server
npm run dev:full

📚 Documentation Structure

Getting Started

Installation Guide - Step-by-step installation instructions
Quick Start - Get started in 5 minutes
Configuration - Environment variables and settings

Features

Dashboard System - Creating and managing dashboards
Caching System - Performance optimization with caching
Tab Rotation - Automatic tab rotation for kiosk displays
Screenshots - Dashboard screenshot generation
Breadcrumb Navigation - Navigation enhancements
Loading States - Professional loading indicators

Development

Developer Guide - Development setup and workflows
API Reference - Complete API documentation
Architecture - System architecture deep dive

Deployment

Docker Deployment - Container-based deployment
Production Setup - Production best practices
CI/CD - Continuous integration and deployment

🎯 Key Features

✨ Modern Stack

Frontend: React 18 + Vite 6
Backend: Node.js + Express.js
Dashboard Engine: @splunk/dashboard-core
Visualizations: @splunk/visualizations

🚀 Performance

Intelligent Caching: Reduces Splunk API calls by 90%+
On-Demand Data: No scheduled exports required
Optimized Loading: Lazy loading and code splitting

🎨 User Experience

Professional UI: Splunk UI components for consistency
Breadcrumb Navigation: Easy navigation between dashboards
Loading Indicators: Splunk WaitSpinner for professional loading states
Responsive Design: Works on desktop, tablet, and mobile

🔒 Security

Optional Authentication: JWT-based authentication
Rate Limiting: IP-based rate limiting
Endpoint Protection: Protects Splunk deployment URLs

📊 Feature Comparison

Feature	Splunk Enterprise	Dashpub
High Level View	❌	✅ Homepage with all dashboards
On-Demand Data	❌	✅ With intelligent caching
Tab Rotation	❌	✅ Automatic rotation
Screenshot Generation	❌	✅ Automated screenshots
Custom Visualizations	❌	✅ Full support
Rate Limiting	❌ Basic	✅ Advanced IP-based

🤝 Contributing

We welcome contributions! Please see our Contributing Guide for details.

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🔗 Resources

Need Help? Check out our Troubleshooting Guide or open an issue on GitHub.