An open API service indexing awesome lists of open source software.

https://github.com/dethdkn/ldap-nel

πŸ” Modern web interface for LDAP administration
https://github.com/dethdkn/ldap-nel

docker go ldap nuxt vue

Last synced: about 1 month ago
JSON representation

πŸ” Modern web interface for LDAP administration

Awesome Lists containing this project

README

          


Ldap-Nel

Ldap-Nel

πŸ” Modern web interface for LDAP administration




License


Gitmoji


rosa.dev.br

https://github.com/user-attachments/assets/2e3a476c-90e7-4969-ade3-3bf6ce6ec361

## ✨ Reason

At [CBPF](https://cbpf.br), where I work, we use LDAP Admin to make small adjustments to our OpenLDAP server. However, LDAP Admin is a Windows-only tool, which creates issues for team members who use macOS or Linux. To solve this, I developed Ldap-Nel, a web-based application that can be accessed from any platform, anywhereβ€”making LDAP management more accessible and convenient for the whole team.\
I also wanted to learn Go πŸ˜„

## πŸš€ Setup

1. **Install Docker and Docker Compose:**\
Follow the official [Docker installation](https://docs.docker.com/get-started/get-docker/) guide for your operating system.

2. **Create a `docker-compose.yaml` file:**\
Copy the contents from the [example](https://github.com/dethdkn/ldap-nel/blob/main/docker-compose.yaml) into your own `docker-compose.yaml`.\
or download it
```sh
curl -L -o docker-compose.yaml https://raw.githubusercontent.com/dethdkn/ldap-nel/main/docker-compose.yaml
# or
wget -O docker-compose.yaml https://raw.githubusercontent.com/dethdkn/ldap-nel/main/docker-compose.yaml
```

3. **Create a `.env` file:**\
Use the [`.env.example`](https://github.com/dethdkn/ldap-nel/blob/main/.env.example) as a starting point and adjust the values to match your environment.\
```sh
curl -L -o .env https://raw.githubusercontent.com/dethdkn/ldap-nel/main/.env.example
# or
wget -O .env https://raw.githubusercontent.com/dethdkn/ldap-nel/main/.env.example
```
πŸ”‘ JWT_SECRET: At least 32 characters\
πŸ” ENCRYPTION_KEY: This must be a base64-encoded string that decodes to 32 bytes (AES-256).

βœ… To generate a valid encryption key run:
```bash
openssl rand -base64 32
```

4. **Create the database folder:**\
Run the following command to create the required database volume directory (as defined in `docker-compose.yaml`):
```bash
mkdir ./database
```

5. **Pull and start the container:**
```bash
docker compose pull
docker compose up -d --force-recreate
```

6. **(Optional) Set up a reverse proxy:**\
For production use, you can put the Docker app behind an Nginx reverse proxy to serve it on ports 80 or 443.

## ⬆️ Upgrade

To upgrade `ldap-nel` to the latest version:

1. **Pull the latest image:**
```bash
docker compose pull
```

2. **Recreate and restart the containers:**
```bash
docker compose up -d --force-recreate
```

## πŸ“ License

Copyright Β© 2025 [Gabriel 'DethDKN' Rosa](https://github.com/dethdkn)\
This project is under [MIT license](https://github.com/dethdkn/ldap-nel/blob/main/LICENSE)