Skip to content

lucenia/lucenia-tutorials

Repository files navigation

Lucenia Tutorials

A comprehensive collection of tutorials and example projects demonstrating how to use Lucenia Search effectively. Each tutorial is designed to be self-contained and can be run independently using Docker containers.

Prerequisites

Before starting with any tutorial, ensure you have:

  • Docker and Docker Compose V2 installed
  • A valid Lucenia license file (trial.crt) - obtain from Lucenia's website
  • Git installed
  • Basic knowledge of search engines and APIs

Quick Start

# Clone the repository
git clone [email protected]:lucenia/lucenia-tutorials.git

# Navigate to desired tutorial (e.g., getting started)
cd lucenia-tutorials/1_getting-started

# Set up environment variables
source env.sh

# Copy your license file
cp ~/Downloads/trial.crt node/config/

# Start the container
docker compose up

Tutorial Structure

1. Getting Started with Lucenia Core

Purpose: Basic setup and configuration of a Lucenia Search node

  • Single-node cluster setup
  • Basic health checks and monitoring
  • Configuration best practices
  • Security setup and authentication

Get started with core →

2. STAC Catalog API

Purpose: Build a STAC-compliant API using Lucenia Search

  • FastAPI integration
  • STAC endpoint implementation
  • Geospatial search capabilities
  • Sample data loading

Build a STAC API →

3. Python Client

Purpose: Learn to interact with Lucenia using Python

  • Basic CRUD operations
  • Search queries and filtering
  • Aggregations
  • Bulk operations
  • Error handling

Python integration guide →

4. Ellipse Demo

Purpose: Advanced geospatial search capabilities

  • Complex geometric queries
  • Spatial indexing
  • Performance optimization
  • Real-world use cases

Explore geospatial features →

5. Document Ingest

Purpose: Document processing and search implementation

  • Multi-node cluster configuration
  • Ingest pipeline setup
  • Document processing
  • Search optimization

Document processing guide →

6. Migration Guide

Purpose: Migrate from OpenSearch to Lucenia

  • Step-by-step migration process
  • Data validation
  • Configuration mapping
  • Best practices

Migration guide →

Example Applications

Complete example applications demonstrating real-world implementations:

Development Setup

Each tutorial includes Docker Compose configurations for consistent environments:

# Navigate to specific tutorial
cd <tutorial-directory>

# Set up environment
source env.sh

# Start containers
docker compose up

Security Notes

  • Default credentials: admin/MyStrongPassword123!
  • Important: Change default passwords in production
  • Keep your license file secure
  • Follow security best practices in production deployments

Additional Resources


For support, contact: [email protected]

About

No description, website, or topics provided.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 4

  •  
  •  
  •  
  •