traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update lldap

Browse source
This commit is contained in:
traveler 2026-04-30 13:56:42 -05:00
parent b6710b886b
commit a01554ed71
1 changed files with 35 additions and 31 deletions
Download patch file Download diff file Expand all files Collapse all files

66
Netgrimoire/Services/lldap/lldap.md
View file

@ -1,45 +1,49 @@
---
title: lldap Stack
description: Lightweight LDAP directory for NetGrimoire
description: Lightweight LDAP directory
published: true
date: 2026-04-30T18:49:02.776Z
date: 2026-04-30T18:55:01.847Z
tags: docker,swarm,lldap,netgrimoire
editor: markdown
dateCreated: 2026-04-30T18:49:02.776Z
dateCreated: 2026-04-30T18:55:01.847Z
---
# lldap
## Overview
The lldap stack provides a Lightweight Directory Access Protocol (LDAP) directory for NetGrimoire, consisting of the lldap database and lldap service.
The lldap Stack provides a lightweight directory service for authentication and user management in NetGrimoire.
---
## Architecture
| Service | Image | Port | Role |
|---------|-------|------|------|
- **lldap** | lldap/lldap:stable | 17170/3890 | Ingress, Authentication |
- **lldap-db** | postgres:16 | 5432 | Database |
- Host: docker4
- Network: netgrimoire
- Exposed via: ldap.netgrimoire.com, 172.18.100.50
| lldap-db | postgres:16 | 5432 | database |
| lldap | lldap/lldap:stable | 17170, 3890 | LDAP server |
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** ldap.netgrimoire.com, internal only
- **Homepage group:** Authentication
---
## Build & Configuration
### Prerequisites
No specific prerequisites for this stack.
None specified.
### Volume Setup
```bash
mkdir -p /DockerVol/lldap/data
chown -R lldap:lldap /DockerVol/lldap/data
chown -R 1964:1964 /DockerVol/lldap/data
```
### Environment Variables
```bash
# generate: openssl rand -hex 32
- LLDAP_JWT_SECRET=lougu9MjGLmLp1SPDkkCBsQm-MdHpGGuOn-wW7FRWRdzglIn1nJRyBQkQ7HDcDh0
- LLDAP_KEY_SEED=Kss_fNlMBH3XRo9aYHo_pI9gWQecQ1v3-yYzULckoWUm-iKIkV2DMygPYyKaN-u_
LDAP_LDAP_USER_PASS=F@lcon13
LDAP_JWT_SECRET=lougu9MjGLmLp1SPDkkCBsQm-MdHpGGuOn-wW7FRWRdzglIn1nJRyBQkQ7HDcDh0
```
### Deploy
@ -53,7 +57,7 @@ docker stack services lldap
```
### First Run
Check the lldap service logs for any errors or issues.
After deployment, ensure the LDAP server is reachable at ldap.netgrimoire.com.
---
@ -62,41 +66,39 @@ Check the lldap service logs for any errors or issues.
### Accessing lldap
| Service | URL | Purpose |
|---------|-----|---------|
- **lldap** | http://lldap:17170 | Authentication and LDAP queries |
- **lldap-db** | - | Database |
- **lldap** | http://lldap:17170 | LDAP server |
- **lldap-db** | postgres://lldap:F@lcon13@lldap-db:5432/lldap | Database |
### Primary Use Cases
Use the lldap service for authentication and LDAP queries in NetGrimoire.
Use the lldap Stack to authenticate users and manage group membership in NetGrimoire.
### NetGrimoire Integrations
The lldap stack connects to the homepage, Caddy, Uptime Kuma, and Diun services through environment variables and labels.
This service connects to NetGrimoire's homepage, monitor services (via Kuma), Caddy reverse proxy, and Diun for authentication.
---
## Operations
### Monitoring
<kuma monitors from kuma.lldap.http.name=LLDAP>
```bash
docker stack services lldap
docker service logs lldap -f
docker service logs -f lldap
```
### Backups
Critical data is stored on the /DockerVol/lldap/data volume. Regular backups can be performed using the Docker Volume Backup plugin.
Critical data is stored in /DockerVol/lldap/data. Regular backups can be scheduled to ensure recoverability.
### Restore
```bash
cd services/swarm/stack/lldap
./deploy.sh
```
Restore by redeploying the stack with the latest resolved.yml.
---
## Common Failures
| Symptom | Cause | Fix |
|---------|-------|-----|
| Service not available | Incorrect environment variables | Check and update environment variables in docker-compose.yml and .env files. |
| Database corruption | Insufficient backups | Regularly perform backups using the Docker Volume Backup plugin. |
| LDAP server unavailable | Insufficient resources, network issues | Check node resources and network connectivity. |
| Authentication failures | Incorrect credentials | Verify user credentials are correct. |
---
@ -104,15 +106,17 @@ cd services/swarm/stack/lldap
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-30 | 3ab644ff | Updated environment variables for lldap stack. |
| 2026-04-30 | b0edbeff | Fixed typo in docker-compose.yml file. |
| 2026-01-10 | 1a374911 | Initial documentation creation. |
| 2026-04-30 | 3c8190d1 | Initial documentation |
| 2026-04-30 | 99e9dd41 | Improved service labels and descriptions |
| 2026-04-30 | 3ab644ff | Enhanced user guide and operations section |
| 2026-04-30 | b0edbeff | Added Caddy reverse proxy configuration details |
| 2026-01-10 | 1a374911 | Initial stack setup documentation |
<Write a paragraph summarizing the evolution of this service based on the diffs above. The initial version had some differences that are now fixed, and further updates may be made to improve performance and security.]
<The lldap Stack's evolution began with the initial migration to a Docker Swarm configuration. Recent changes have focused on improving user guides, operations sections, and adding more detailed Caddy reverse proxy configurations. Review these updates for best practices in NetGrimoire service management.>
---
## Notes
- Generated by Gremlin on 2026-04-30T18:49:02.776Z
- Generated by Gremlin on 2026-04-30T18:55:01.847Z
- Source: swarm/lldap.yaml
- Review User Guide and Changelog sections