Skip to content

Commit 69aa205

Browse files
committed
Readme title rename, and a big warning notice about how this tool is not complete yet.
1 parent d0c701b commit 69aa205

File tree

1 file changed

+18
-1
lines changed

1 file changed

+18
-1
lines changed

README.md

Lines changed: 18 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,28 @@
1-
# LDAP group sync script for Gitlab-CE
1+
# LDAP users and groups sync script for Gitlab-CE
22

33
This nifty little PHP-CLI tool will synchronise users and user groups from an LDAP server to Gitlab community edition instance(s).
44

55
Though this functionality is available out of the box with Gitlab enterprise edition the pricing model is completely infeasible for teams of hobbyists working on non-revenue based projects but need to use a centralised authentication base.
66

77
As a bonus it can also do a light rake of LDAP users not currently in Gitlab, so those that haven't signed in for their first time can still have projects and permissions assigned to them. **This may make the tool unsuitable git Gitlab-EE as this would certainly impact its licensing fees!**
88

9+
## **THIS TOOL IS NOT COMPLETED YET. DO NOT USE IT IN A PRODUCTION ENVIRONMENT.**
10+
11+
**Seriously. Only use this on test Gitlab CE instances.**
12+
13+
What is complete:
14+
15+
* Reading users from LDAP
16+
* Reading groups from LDAP
17+
* Synchronising groups to Gitlab
18+
19+
What is left to-do:
20+
21+
* Synchronising users to Gitlab
22+
* Synchronising group memberships to Gitlab
23+
24+
**For now always use the dry run `-d` option to prevent writing to Gitlab. You have been warned.**
25+
926
## Getting Started
1027

1128
These instructions will get you a copy of the project up and running on your local machine for development, testing, and live purposes.

0 commit comments

Comments
 (0)