docs: switch installation instructions to PyPI
Some checks failed
CI - tests / Unit tests (make test) (push) Has been cancelled
Some checks failed
CI - tests / Unit tests (make test) (push) Has been cancelled
- Replace pkgmgr-based installation with pip install ldapsm - Document required system dependencies for python-ldap - Keep usage examples unchanged https://chatgpt.com/share/695d2615-d664-800f-b821-5705c631bfe8
This commit is contained in:
29
README.md
29
README.md
@@ -1,15 +1,31 @@
|
|||||||
# LDAP Schema Manager 🛠️
|
# LDAP Schema Manager 🛠️
|
||||||
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate)
|
[](https://github.com/sponsors/kevinveenbirkenbach) [](https://www.patreon.com/c/kevinveenbirkenbach) [](https://buymeacoffee.com/kevinveenbirkenbach) [](https://s.veen.world/paypaldonate)
|
||||||
|
|
||||||
|
|
||||||
A Python-based CLI tool for managing OpenLDAP schema snippets under `cn=config`, allowing you to create or update schema entries—including custom `olcAttributeTypes` and `olcObjectClasses`—via LDAPI.
|
A Python-based CLI tool for managing OpenLDAP schema snippets under `cn=config`, allowing you to create or update schema entries—including custom `olcAttributeTypes` and `olcObjectClasses`—via LDAPI.
|
||||||
|
|
||||||
## 🚀 Installation
|
## 🚀 Installation (PyPI)
|
||||||
|
|
||||||
You can install **ldapsm** easily using [Kevin's package manager](https://github.com/kevinveenbirkenbach/package-manager):
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
pkgmgr install ldapsm
|
python3 -m pip install --upgrade pip
|
||||||
|
python3 -m pip install ldapsm
|
||||||
|
```
|
||||||
|
|
||||||
|
### System dependencies (required for python-ldap)
|
||||||
|
|
||||||
|
`python-ldap` requires OpenLDAP development headers and SASL/SSL libraries.
|
||||||
|
|
||||||
|
Debian / Ubuntu:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo apt-get update
|
||||||
|
sudo apt-get install -y --no-install-recommends \
|
||||||
|
gcc python3-dev libldap2-dev libsasl2-dev libssl-dev
|
||||||
|
```
|
||||||
|
|
||||||
|
Arch Linux:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
sudo pacman -S --needed gcc openldap
|
||||||
```
|
```
|
||||||
|
|
||||||
## 📝 Usage
|
## 📝 Usage
|
||||||
@@ -20,8 +36,6 @@ After installation, run:
|
|||||||
ldapsm --help
|
ldapsm --help
|
||||||
```
|
```
|
||||||
|
|
||||||
to view all available commands and options.
|
|
||||||
|
|
||||||
### Example
|
### Example
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
@@ -42,6 +56,7 @@ For detailed usage and options, run:
|
|||||||
ldapsm --help
|
ldapsm --help
|
||||||
```
|
```
|
||||||
|
|
||||||
|
|
||||||
## 🛡️ Contributing
|
## 🛡️ Contributing
|
||||||
|
|
||||||
Contributions, issues, and feature requests are welcome! Feel free to check [issues](https://github.com/kevinveenbirkenbach/ldap-schema-manager/issues).
|
Contributions, issues, and feature requests are welcome! Feel free to check [issues](https://github.com/kevinveenbirkenbach/ldap-schema-manager/issues).
|
||||||
|
|||||||
Reference in New Issue
Block a user