[
https://issues.apache.org/jira/browse/KNOX-3318?focusedWorklogId=1019674&page=com.atlassian.jira.plugin.system.issuetabpanels:worklog-tabpanel#worklog-1019674
]
ASF GitHub Bot logged work on KNOX-3318:
----------------------------------------
Author: ASF GitHub Bot
Created on: 11/May/26 11:59
Start Date: 11/May/26 11:59
Worklog Time Spent: 10m
Work Description: smolnar82 opened a new pull request, #1227:
URL: https://github.com/apache/knox/pull/1227
[KNOX-3318](https://issues.apache.org/jira/browse/KNOX-3318) - Add Knox LDAP
Server documentation to User Guide
## What changes were proposed in this pull request?
This pull request adds comprehensive documentation for the Knox LDAP Server
feature (introduced in KNOX-3247 and improved in KNOX-3277) to the official
Knox User Guide.
Changes include:
- Created knox-site/docs/service_ldap_server.md which provides:
- An architectural overview of the embedded ApacheDS-based LDAP
service.
- Detailed configuration instructions for both file and proxy
backends.
- Specific guidance for Active Directory (AD) integration, including
memberOf and sAMAccountName support.
- Troubleshooting tips regarding logs and lock files.
- Updated knox-site/mkdocs.yml to include the "LDAP Server" page in the
Client/User Guide navigation.
- Updated knox-site/docs/book_service-details.md to include the LDAP
Server in the master list of supported services.
## How was this patch tested?
- Manually verified the Markdown rendering and formatting of the new
documentation.
- Validated all internal and external (JIRA) links.
- Cross-referenced all configuration property names (e.g.,
`gateway.ldap.backend.proxy.*`) with the implementation in
`GatewayConfigImpl.java` and `LdapProxyBackend.java` to ensure accuracy.
## Integration Tests
N/A - This is a documentation-only change. No functional code was modified.
## UI changes
N/A
Issue Time Tracking
-------------------
Worklog Id: (was: 1019674)
Remaining Estimate: 0h
Time Spent: 10m
> Document Knox LDAP Server feature in the User Guide
> ---------------------------------------------------
>
> Key: KNOX-3318
> URL: https://issues.apache.org/jira/browse/KNOX-3318
> Project: Apache Knox
> Issue Type: Task
> Components: Document
> Affects Versions: 3.0.0
> Reporter: Sandor Molnar
> Assignee: Sandor Molnar
> Priority: Major
> Fix For: 3.0.0
>
> Time Spent: 10m
> Remaining Estimate: 0h
>
> Recent improvements in KNOX-3247 and KNOX-3277 implemented an embedded LDAP
> server/proxy within Knox. This task adds a comprehensive documentation page
> (service_ldap_server.md) to the knox-site module. The new documentation
> covers the service's architecture, configuration properties for both file and
> proxy backends, and specific optimizations for Active Directory integration.
> The page has been integrated into the "{{{}Client/User Guide{}}}" section of
> the official documentation.
--
This message was sent by Atlassian Jira
(v8.20.10#820010)
