From 08678ce92951452aec7a093deed55e4874b45134 Mon Sep 17 00:00:00 2001 From: Deon George Date: Thu, 2 Mar 2023 21:40:22 +1100 Subject: [PATCH] Adding .dockerignore to trim the docker container, removing some redundant files and updated README --- .dockerignore | 8 +++++ INSTALL.md | 23 ------------- README.md | 88 +++++++++-------------------------------------- docker/Dockerfile | 2 +- index.php | 11 ------ server.php | 21 ----------- 6 files changed, 25 insertions(+), 128 deletions(-) create mode 100644 .dockerignore delete mode 100644 INSTALL.md delete mode 100644 index.php delete mode 100644 server.php diff --git a/.dockerignore b/.dockerignore new file mode 100644 index 0000000..99413e1 --- /dev/null +++ b/.dockerignore @@ -0,0 +1,8 @@ +.dockerignore +.editorconfig +.env.testing +.git* +package.json +phpunit.xml +webpack.mix.js +yarn.lock diff --git a/INSTALL.md b/INSTALL.md deleted file mode 100644 index e079b12..0000000 --- a/INSTALL.md +++ /dev/null @@ -1,23 +0,0 @@ -For install instructions in non-English languages, see the wiki: - http://phpldapadmin.sourceforge.net - -* Requirements - - phpLDAPadmin requires the following: - a. A web server (Apache, IIS, etc). - b. PHP 5.0.0 or newer (with LDAP support) - -* To install - - 1. Unpack the archive (if you're reading this, you already did that). - 2. Put the resulting 'phpldapadmin' directory somewhere in your webroot. - 3. Copy 'config.php.example' to 'config.php' and edit to taste (this is in the config/ directory). - 4. Then, point your browser to the phpldapadmin directory. - -* For additional help - - See the wiki: - http://phpldapadmin.sourceforge.net - - Join our mailing list: - https://lists.sourceforge.net/lists/listinfo/phpldapadmin-devel diff --git a/README.md b/README.md index 449b6e0..8bd0053 100644 --- a/README.md +++ b/README.md @@ -1,18 +1,26 @@ # phpLDAPadmin -phpLDAPadmin is a web based LDAP data management tool for system administrators. It is commonly known and referred by many as PLA. - -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. +phpLDAPadmin is a web based LDAP data management tool for system administrators. It is commonly known and referred by many as "PLA". PLA is designed to be compliant with LDAP RFCs, enabling it to be used with any LDAP server. 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. -## History -Initially created in 2002 by David Smith, it was taken over by Deon George (aka leenooks) in 2005. +For up to date information on PLA, please head to the [wiki](https://github.com/leenooks/phpLDAPadmin/wiki). -Since 2003 many things have changed - initial development was done in CVS and the project was hosted on Sourceforge. -In 2009, CVS was swapped out for GIT, and in around 2011 the project was moved to Github. +## Getting Help +The best place to get help with PLA (new and old) is on [Stack Overflow](https://stackoverflow.com/tags/phpldapadmin/info). -The PLA v1.2.x stream was created in July 2009. +## Found a bug? +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. + +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. + +*TIP*: Issues opened with: + +* details enabling the problem to be reproduced, +* including (if appropriate) an LDIF with the data that exhibits the problem, +* a patch (or a git pull request) to fix the problem + +will be looked at first :) ## THANK YOU Over the years, many, many, many people have supported PLA with either their time, their coding or with financial donations. @@ -20,69 +28,5 @@ I have tried to send an email to acknowledge each contribution, and if you haven Again, Thank You. -## Future -Web development, tools, approaches and technology has come along way since 2009 and some talented folks have created some fantastic tools. -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. - -Some of the creations planned to be used in v2 include: -* Laravel (https://laravel.com) -* directorytree/ldaprecord-laravel (https://ldaprecord.com/) -* JQuery (https://jquery.com) -* FancyTree (https://github.com/mar10/fancytree) -* ArchitectUI (https://architectui.com) -* Fontawesome Icons (https://fontawesome.com) - -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. - -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. - -If you like the cutting edge, feel free to try out `master`, but expect problems, bugs and missing functionality. -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. - -Alternatively, you can get take a peek at the work so far by using our docker container, which is built automatically after testing passes. -The [demo](http://demo.phpldapadmin.org) site, will also be running the same docker container. (See below for details.) - -In summary, for the time being, expect `master` to be buggy and broken, and I'll update this readme as enhancements progress. - -## Installation - -### Installation on your server - -#### Prerequisites -* A HTTP server (eg: Apache, Nginx) -* PHP (minimum version 7.2) https://www.php.net -* Composer https://getcomposer.org -* GIT - -#### Installation -1. Checkout the code from github - ```bash - git clone https://github.com/leenooks/phpLDAPadmin.git - ``` - -1. Install composer dependencies. - ```bash - composer install - ``` - -1. Edit your `.env` file as appropriate - - copy `.env.example` to `.env` as a start. - -1. Configure your webserver to have PLA's root in the `public` directory - -### Using Docker -Instructions to come. - -## Getting Help -The best place to get help with PLA (new and old) is on Stack Overflow (https://stackoverflow.com/tags/phpldapadmin/info) - -## Found a bug? -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. - -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. - -*TIP*: Issues opened with reproducible details accompanied with a patch (or a pull request) to fix the problem will be looked at first. - ## License [LICENSE](LICENSE) diff --git a/docker/Dockerfile b/docker/Dockerfile index 722657c..7a15511 100644 --- a/docker/Dockerfile +++ b/docker/Dockerfile @@ -7,4 +7,4 @@ RUN mkdir -p ${COMPOSER_HOME} && \ touch .composer.refresh && \ mv .env.example .env && \ FORCE_PERMS=1 NGINX_START=FALSE /sbin/init && \ - rm -rf ${COMPOSER_HOME}/* + rm -rf ${COMPOSER_HOME}/* .git* composer.lock diff --git a/index.php b/index.php deleted file mode 100644 index 716e607..0000000 --- a/index.php +++ /dev/null @@ -1,11 +0,0 @@ - diff --git a/server.php b/server.php deleted file mode 100644 index 5fb6379..0000000 --- a/server.php +++ /dev/null @@ -1,21 +0,0 @@ - - */ - -$uri = urldecode( - parse_url($_SERVER['REQUEST_URI'], PHP_URL_PATH) -); - -// This file allows us to emulate Apache's "mod_rewrite" functionality from the -// built-in PHP web server. This provides a convenient way to test a Laravel -// application without having installed a "real" web server software here. -if ($uri !== '/' && file_exists(__DIR__.'/public'.$uri)) { - return false; -} - -require_once __DIR__.'/public/index.php';