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.
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
# 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
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
Purpose: Build a STAC-compliant API using Lucenia Search
- FastAPI integration
- STAC endpoint implementation
- Geospatial search capabilities
- Sample data loading
Purpose: Learn to interact with Lucenia using Python
- Basic CRUD operations
- Search queries and filtering
- Aggregations
- Bulk operations
- Error handling
Purpose: Advanced geospatial search capabilities
- Complex geometric queries
- Spatial indexing
- Performance optimization
- Real-world use cases
Purpose: Document processing and search implementation
- Multi-node cluster configuration
- Ingest pipeline setup
- Document processing
- Search optimization
Purpose: Migrate from OpenSearch to Lucenia
- Step-by-step migration process
- Data validation
- Configuration mapping
- Best practices
Complete example applications demonstrating real-world implementations:
- Java Application: Enterprise search implementation
- Node.js Application: Modern web application integration
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
- Default credentials:
admin/MyStrongPassword123!
- Important: Change default passwords in production
- Keep your license file secure
- Follow security best practices in production deployments
For support, contact: [email protected]