Skip to content

[#1296] Document LDIF backend configuration and proxy suffix limitations - #1298

Merged
vharseko merged 2 commits into
OpenIdentityPlatform:masterfrom
vharseko:docs/1296-ldif-backend
Nov 16, 2026
Merged

vharseko merged 2 commits into
OpenIdentityPlatform:masterfrom
vharseko:docs/1296-ldif-backend

Conversation

@vharseko

Copy link
Copy Markdown
Member

Summary

Add the missing administration-guide procedure for configuring and operating the built-in LDIF backend. The chapter covers its in-memory reads and file rewrites, single base DN, backing-file path, enablement, write policy, and limited custom-control support. It includes a minimal LDIF file, dsconfig create-backend --type ldif, verification steps, and a safe procedure for editing and reloading static data.

Explain how a local LDIF parent suffix coexists with subordinate proxy backends. A subtree search that reaches an unavailable child route still returns UNAVAILABLE (52), even when some entries have already been returned or the LDIF file contains copies of child base entries. The chapter makes the boundaries of runtime fallback, result reconciliation, and federation explicit.

Validation

  • Documentation unit suite: 26 tests passed; Antora page-title suite: 10 tests passed, with no failures, errors, or skips.
  • AsciiDoc attribute check and cross-guide check: 604 file references across 74 pages.
  • Administration Guide PDF and Antora generation passed.
  • Isolated-server smoke test passed for the documented create/get commands, both sample entries, disabled/enabled LDAP writes, file persistence, and disable/edit/enable reload. The temporary server was stopped afterward.
  • git diff --check passed.

Fixes #1296

Related to #1292 and discussion #554.

@vharseko vharseko added docs backend Storage backends (JE, PDB, memory) and their database behaviour labels Nov 16, 2026
@vharseko
vharseko requested a review from maximthomas November 16, 2026 14:15
@vharseko
vharseko merged commit cdee550 into OpenIdentityPlatform:master Nov 16, 2026
4 checks passed
@vharseko
vharseko deleted the docs/1296-ldif-backend branch November 16, 2026 14:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

backend Storage backends (JE, PDB, memory) and their database behaviour docs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document LDIF backend configuration and proxy suffix limitations

2 participants