Working after iterations
This commit is contained in:
94
CHANGELOG.md
Normal file
94
CHANGELOG.md
Normal file
@@ -0,0 +1,94 @@
|
||||
# Changelog
|
||||
|
||||
All notable changes to this project will be documented in this file.
|
||||
|
||||
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
|
||||
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
||||
|
||||
## [0.1.0] - 2025-01-XX
|
||||
|
||||
### Added
|
||||
- Initial release of LDAP Docker development tool
|
||||
- OpenLDAP 1.5.0 container with SSL/TLS support
|
||||
- phpLDAPadmin web interface for easy administration
|
||||
- Pre-configured test users and groups for testing.local domain
|
||||
- SSL certificate generation script using Python cryptography
|
||||
- Comprehensive CLI tool for managing LDAP server (`ldap-docker` command)
|
||||
- Makefile with convenient shortcuts for common operations
|
||||
- Interactive quickstart script (`quickstart.sh`) for guided setup
|
||||
- Example Python authentication script demonstrating LDAP integration
|
||||
- Support for custom dev-ca certificates
|
||||
- Persistent Docker volumes for data and configuration
|
||||
- Test suite for certificate generation
|
||||
- Comprehensive documentation:
|
||||
- README.md - Full project documentation
|
||||
- GETTING_STARTED.md - Beginner-friendly guide
|
||||
- QUICKREF.md - Quick command reference
|
||||
- certs/README.md - Certificate management guide
|
||||
- examples/README.md - Integration patterns and examples
|
||||
|
||||
### Test Data
|
||||
- 4 pre-configured test users (admin, jdoe, jsmith, testuser)
|
||||
- 3 test groups (admins, developers, users)
|
||||
- All test users use password: `password123`
|
||||
- Admin credentials: `cn=admin,dc=testing,dc=local` / `admin_password`
|
||||
|
||||
### Infrastructure
|
||||
- Docker Compose configuration for easy deployment
|
||||
- UV package manager integration for Python dependencies
|
||||
- Cross-platform support (MacOS, Linux, Windows)
|
||||
- Rancher Desktop and Docker Desktop compatibility
|
||||
|
||||
### Fixed
|
||||
- Updated `pyproject.toml` to use `dependency-groups.dev` instead of deprecated `tool.uv.dev-dependencies`
|
||||
- Added `tool.hatch.build.targets.wheel.packages` configuration to fix build errors
|
||||
- Removed obsolete `version` field from `docker-compose.yml` (Docker Compose v2+ compatibility)
|
||||
- Fixed LDAP user password hashes to use proper SSHA format generated by `slappasswd`
|
||||
- Fixed attribute type conversion in example scripts for uidNumber and gidNumber
|
||||
|
||||
### Technical Details
|
||||
- Base DN: `dc=testing,dc=local`
|
||||
- LDAP Port: 389 (standard)
|
||||
- LDAPS Port: 636 (SSL/TLS)
|
||||
- Web Admin Port: 8080
|
||||
- Python 3.9+ required
|
||||
- Docker/Rancher Desktop required
|
||||
|
||||
## [Unreleased]
|
||||
|
||||
### Planned Features
|
||||
- Additional integration examples (Node.js, Go, Ruby, etc.)
|
||||
- Health check endpoints
|
||||
- Automated backup scripts
|
||||
- Docker image with pre-built configuration
|
||||
- Kubernetes/Helm deployment examples
|
||||
- LDAP replication setup guide
|
||||
- Performance tuning guide
|
||||
- Security hardening options
|
||||
|
||||
---
|
||||
|
||||
## Release Notes
|
||||
|
||||
### Version 0.1.0
|
||||
This is the initial release providing a complete LDAP development environment suitable for:
|
||||
- Testing LDAP authentication in applications
|
||||
- Development and integration testing
|
||||
- Learning LDAP concepts
|
||||
- Prototyping LDAP-based systems
|
||||
|
||||
**Important Security Notes:**
|
||||
- This tool is for **DEVELOPMENT USE ONLY**
|
||||
- Default passwords are well-known and insecure
|
||||
- Self-signed certificates are not suitable for production
|
||||
- Never use this with real user data or in production environments
|
||||
|
||||
### Upgrade Instructions
|
||||
Not applicable for initial release.
|
||||
|
||||
### Breaking Changes
|
||||
Not applicable for initial release.
|
||||
|
||||
---
|
||||
|
||||
For support, issues, or feature requests, please refer to the project documentation or open an issue on the project repository.
|
||||
Reference in New Issue
Block a user