Skip to content

wynn5a/search-box

Repository files navigation

SearchBox

A powerful and modern web interface for managing multiple OpenSearch clusters

License: MIT Next.js TypeScript Tailwind CSS

✨ Features

  • 🌐 Multi-cluster Management

    • Manage and monitor multiple OpenSearch clusters from a single dashboard
    • Real-time cluster health monitoring
    • Comprehensive cluster statistics and metrics
  • 🔒 Advanced Security

    • Support for Basic Authentication
    • SSH tunneling capabilities for secure remote connections
    • Secure credential management
  • 📊 Powerful Monitoring

    • Real-time cluster health monitoring
    • Node status and statistics
    • Index metrics and shard distribution
    • Storage usage analytics
    • Custom dashboard with key metrics
  • 📑 Index Management

    • Create and delete indices
    • Modify index settings and mappings
    • Monitor index health and statistics
    • Manage index lifecycle
  • 🔍 Data Query Interface

    • Built-in query editor with syntax highlighting
    • Query templates support
    • Results visualization
    • Export capabilities
  • 🎨 Modern User Experience

    • Clean and intuitive interface
    • Responsive design for all devices
    • Dark/Light theme support
    • i18n support (English/Chinese)

🛠 Tech Stack

Frontend

Backend

  • API: Next.js API Routes
  • Database: Prisma with PostgreSQL
  • Authentication: NextAuth.js
  • OpenSearch Client: Official OpenSearch JavaScript Client
  • SSH Tunneling: SSH2

Developer Experience

  • Code Quality:
    • ESLint
    • Prettier
    • TypeScript strict mode

🚀 Getting Started

Prerequisites

  • Node.js 20+
  • npm or yarn
  • PostgreSQL (for production)

Installation

  1. Clone the repository:

    git clone https://github.com/yourusername/search-box.git
    cd search-box
  2. Install dependencies:

    yarn install
  3. Set up environment variables:

    cp .env.example .env

    Edit .env with your configuration

  4. Start the development server:

    npx prisma generate
    yarn dev
  5. Open http://localhost:3000 in your browser

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

📝 License

This project is licensed under the GNU GPLv3 License - see the LICENSE file for details

🙏 Acknowledgments

  • OpenSearch for the amazing search engine
  • Vercel for the excellent deployment platform
  • All our contributors and users

Built with ❤️ by the community

About

A GUI tool for OpenSearch/ElasticSearch management

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages