add README

This commit is contained in:
fram3d 2024-04-08 00:26:13 +02:00
parent a1a2bf34b3
commit e15c309e71
Signed by: fram3d
GPG Key ID: 938920E709EEA32A

30
README.md Normal file
View File

@ -0,0 +1,30 @@
# LGit (pronounced "legit")
python library that allows to use LDAP user database, based on luser project with git-like functions
Examples:
Following script copies changes made on 192.168.1.13 LDAP server to the 192.168.1.21 server
```
import lgit
server1 = lgit.ldapserver("192.168.1.13", "cn=admin,dc=example,dc=com", "adminpass", "ou=Users,dc=example,dc=com")
server2 = lgit.ldapserver("192.168.1.21", "ou=bob,ou=Users,dc=example,dc=com", "pasSw0rd", "ou=Users,dc=example,dc=com")
server1.pull(server2)
```
Following script pulls all user changes from both servers to each other
```
import lgit
server1 = lgit.ldapserver("192.168.1.13", "cn=admin,dc=example,dc=com", "adminpass", "ou=Users,dc=example,dc=com")
server2 = lgit.ldapserver("192.168.1.21", "ou=bob,ou=Users,dc=example,dc=com", "pasSw0rd", "ou=Users,dc=example,dc=com")
lg = lgit.lgit()
lg.sync()
```