|
1 | 1 | # phpLDAPadmin
|
2 |
| -phpLDAPadmin is a web based LDAP data management tool for system administrators. It is commonly known and referred by many as PLA. |
3 |
| - |
4 |
| -A primary goal of PLA is to be as intuitive as possible - so it is certainly possible for end users to use it as well, for example, to manage their data in an LDAP server. |
| 2 | +phpLDAPadmin is a web based LDAP data management tool for system administrators. It is commonly known and referred by many as "PLA". |
5 | 3 |
|
6 | 4 | PLA is designed to be compliant with LDAP RFCs, enabling it to be used with any LDAP server.
|
7 | 5 | If you come across an LDAP server, where PLA exhibits problems, please open an issue with full details of the problem so that we can have it fixed.
|
8 | 6 |
|
9 |
| -## History |
10 |
| -Initially created in 2002 by David Smith, it was taken over by Deon George (aka leenooks) in 2005. |
11 |
| - |
12 |
| -Since 2003 many things have changed - initial development was done in CVS and the project was hosted on Sourceforge. |
13 |
| -In 2009, CVS was swapped out for GIT, and in around 2011 the project was moved to Github. |
14 |
| - |
15 |
| -The PLA v1.2.x stream was created in July 2009. |
16 |
| - |
17 |
| -## THANK YOU |
18 |
| -Over the years, many, many, many people have supported PLA with either their time, their coding or with financial donations. |
19 |
| -I have tried to send an email to acknowledge each contribution, and if you havent seen anything personally from me, I am sorry, but please know that I do appreciate all the help I get, in whatever form it is provided. |
20 |
| - |
21 |
| -Again, Thank You. |
22 |
| - |
23 |
| -## Future |
24 |
| -Web development, tools, approaches and technology has come along way since 2009 and some talented folks have created some fantastic tools. |
25 |
| -With that PLA is going under a major revamp in preparation for v2 and will aim to use those existing creations to help speed up the revamp effort. |
26 |
| - |
27 |
| -Some of the creations planned to be used in v2 include: |
28 |
| -* Laravel (https://laravel.com) |
29 |
| -* directorytree/ldaprecord-laravel (https://ldaprecord.com/) |
30 |
| -* JQuery (https://jquery.com) |
31 |
| -* FancyTree (https://github.com/mar10/fancytree) |
32 |
| -* ArchitectUI (https://architectui.com) |
33 |
| -* Fontawesome Icons (https://fontawesome.com) |
34 |
| - |
35 |
| -PLA v1.2.x will be archived into [BRANCH-1.2](https://github.com/leenooks/phpLDAPadmin/tree/BRANCH-1.2), and `master` will be changed to reflect the new v2 work and effort. |
36 |
| - |
37 |
| -If you plan to use PLA, and cannot use an installation from your OS package, please use [BRANCH-1.2](https://github.com/leenooks/phpLDAPadmin/tree/BRANCH-1.2) while progress is made in master for v2. |
38 |
| - |
39 |
| -If you like the cutting edge, feel free to try out `master`, but expect problems, bugs and missing functionality. |
40 |
| -If you have extended v2 and would like to contribute your extension, or if you find a way to fix something that is broken or missing please submit a pull request. |
41 |
| - |
42 |
| -Alternatively, you can get take a peek at the work so far by using our docker container, which is built automatically after testing passes. |
43 |
| -The [demo](http://demo.phpldapadmin.org) site, will also be running the same docker container. (See below for details.) |
44 |
| - |
45 |
| -In summary, for the time being, expect `master` to be buggy and broken, and I'll update this readme as enhancements progress. |
46 |
| - |
47 |
| -## Installation |
48 |
| - |
49 |
| -### Installation on your server |
50 |
| - |
51 |
| -#### Prerequisites |
52 |
| -* A HTTP server (eg: Apache, Nginx) |
53 |
| -* PHP (minimum version 7.2) https://www.php.net |
54 |
| -* Composer https://getcomposer.org |
55 |
| -* GIT |
56 |
| - |
57 |
| -#### Installation |
58 |
| -1. Checkout the code from github |
59 |
| - ```bash |
60 |
| - git clone https://github.com/leenooks/phpLDAPadmin.git |
61 |
| - ``` |
62 |
| - |
63 |
| -1. Install composer dependencies. |
64 |
| - ```bash |
65 |
| - composer install |
66 |
| - ``` |
67 |
| - |
68 |
| -1. Edit your `.env` file as appropriate |
69 |
| - |
70 |
| - copy `.env.example` to `.env` as a start. |
71 |
| - |
72 |
| -1. Configure your webserver to have PLA's root in the `public` directory |
73 |
| - |
74 |
| -### Using Docker |
75 |
| -Instructions to come. |
| 7 | +For up to date information on PLA, please head to the [wiki](https://github.com/leenooks/phpLDAPadmin/wiki). |
76 | 8 |
|
77 | 9 | ## Getting Help
|
78 |
| -The best place to get help with PLA (new and old) is on Stack Overflow (https://stackoverflow.com/tags/phpldapadmin/info) |
| 10 | +The best place to get help with PLA (new and old) is on [Stack Overflow](https://stackoverflow.com/tags/phpldapadmin/info). |
79 | 11 |
|
80 | 12 | ## Found a bug?
|
81 | 13 | If you have found a bug, and can provide detailed instructions so that it can be reproduced, please open an [issue](https://github.com/leenooks/phpLDAPadmin/issues) and provide those details.
|
82 | 14 |
|
83 | 15 | Before opening a ticket, please check to see if it hasnt already been reported, and if it has, please provide any additional information that will help it be fixed.
|
84 | 16 |
|
85 |
| -*TIP*: Issues opened with reproducible details accompanied with a patch (or a pull request) to fix the problem will be looked at first. |
| 17 | +*TIP*: Issues opened with: |
| 18 | + |
| 19 | +* details enabling the problem to be reproduced, |
| 20 | +* including (if appropriate) an LDIF with the data that exhibits the problem, |
| 21 | +* a patch (or a git pull request) to fix the problem |
| 22 | + |
| 23 | +will be looked at first :) |
| 24 | + |
| 25 | +## THANK YOU |
| 26 | +Over the years, many, many, many people have supported PLA with either their time, their coding or with financial donations. |
| 27 | +I have tried to send an email to acknowledge each contribution, and if you havent seen anything personally from me, I am sorry, but please know that I do appreciate all the help I get, in whatever form it is provided. |
| 28 | + |
| 29 | +Again, Thank You. |
86 | 30 |
|
87 | 31 | ## License
|
88 | 32 | [LICENSE](LICENSE)
|
0 commit comments