The official documentation website for LdapRecord - a fully-featured Active Record ORM that makes working with LDAP directories a breeze.
LdapRecord is a PHP package that provides you with a full ActiveRecord implementation for working with your LDAP server. Each LDAP object type has a corresponding "Model" which is used to interact with that type. An LDAP object type is determined by its object classes.
- 🚀 Up and Running Fast - Connect to your LDAP servers and start running queries in minutes
- 🔥 Supercharged Active Record - Create and modify LDAP objects with minimal code
- 🔧 Framework Agnostic - Works with any PHP framework or standalone applications
- 🎯 Laravel Integration - Seamless Laravel integration with authentication and user sync
- 📚 Comprehensive Documentation - Extensive guides and examples for all use cases
- LdapRecord Core - The foundation package for any PHP application
- LdapRecord-Laravel - Laravel integration with authentication and user synchronization
This documentation site is built with Next.js and Tailwind CSS.
Install the dependencies:
npm installStart the development server:
npm run devOpen http://localhost:3000 in your browser to view the website.
/src/app/docs/- Documentation content organized by package and version/src/components/- Reusable React components/src/lib/- Utility functions and navigation configuration/src/mdx/- MDX processing and search functionality
The documentation includes a powerful search feature powered by FlexSearch. Access it by:
- Clicking the search input in the navigation
- Using the
⌘K(Mac) orCtrl+K(Windows/Linux) keyboard shortcut
The search automatically indexes all documentation pages and provides instant results.
The site supports multiple versions of both LdapRecord Core and LdapRecord-Laravel packages, with easy switching between versions via the navigation.
Built-in dark mode support with automatic system preference detection.
We welcome contributions to improve the documentation! Here's how you can help:
- Fork the repository
- Create a feature branch (
git checkout -b improve-docs) - Make your changes - Edit MDX files in
/src/app/docs/ - Test locally - Run
npm run devto preview changes - Submit a pull request
- Use clear, concise language
- Include code examples where helpful
- Follow the existing structure and formatting
- Test all code examples before submitting
This documentation site is built with modern web technologies:
- Next.js 15 - React framework with App Router
- Tailwind CSS - Utility-first CSS framework
- MDX - Markdown with React components
- FlexSearch - Full-text search
- Framer Motion - Animation library
- Headless UI - Unstyled, accessible UI components
- Shiki - Syntax highlighting
- LdapRecord Core Repository
- LdapRecord-Laravel Repository
- Documentation Website
- Issue Tracker
- Sponsor the Project
The LdapRecord packages are open-sourced software licensed under the MIT license.