docs

Logchef Documentation

Welcome to the Logchef documentation! This guide will help you understand, install, and make the most of Logchef - a modern, high-performance log analytics platform.

Documentation Structure

• Getting Started

  • Quick Installation
  • First Steps
  • Configuration Basics

• Core Concepts

  • Architecture Overview
  • Data Model
  • Query Interface
  • User Management

• Deployment

  • Docker Deployment
  • Binary Installation
  • Production Considerations
  • Security Best Practices

• Integration

  • Vector Integration
  • HTTP API Reference
  • Client Libraries
  • Example Configurations

• User Guide

  • Dashboard Overview
  • Writing Queries
  • Creating Visualizations
  • Setting up Alerts
  • User Management

• Development

  • Contributing Guidelines
  • Local Development Setup
  • Code Structure
  • Testing

Building the Documentation

This documentation is built using Starlight, a documentation framework powered by Astro.

To run the documentation locally:

# Install dependencies
npm install

# Start the development server
npm run dev

# Build the documentation
npm run build

The development server will start at localhost:4321.

Contributing

We welcome contributions to improve our documentation! Please feel free to:

1. Submit issues for any confusing or incorrect information
2. Create pull requests to fix typos or add missing content
3. Suggest new topics or improvements

For more information on contributing, see our Contributing Guidelines.