Skip to content

Commit dcd3c1f

Browse files
committed
Improving documentation
1 parent bd70660 commit dcd3c1f

File tree

3 files changed

+3
-147
lines changed

3 files changed

+3
-147
lines changed

README.md

Lines changed: 3 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,41 +2,9 @@
22

33
<p align="center">Plugin for integrating Sylius with LDAP.</p>
44

5-
**When using instead of the Sylius form login you will not be able to log in with existing users into Sylius.**
5+
**When using instead of the Sylius form login, you will not be able to log in with existing users into Sylius.**
66

7-
## Try it before installing
8-
9-
If yo want to see if this plugin works with your LDAP server, you can try it before integrating it into your project.
10-
This sylius-plugin comes with a dummy sylius installation inside the test folder that you can use to test the integration with your LDAP server.
11-
12-
Run the following commands in a local directory:
13-
14-
```bash
15-
$ git clone https://github.com/Sylius/SyliusLdapPlugin.git SyliusLdapPlugin
16-
$ cd SyliusLdapPlugin
17-
$ composer install
18-
$ (cd tests/Application && yarn install)
19-
$ (cd tests/Application && yarn build)
20-
$ (cd tests/Application && bin/console assets:install public -e test)
21-
```
22-
23-
To be able to setup a plugin's database, remember to configure you database credentials and LDAP configuration (see section "Configuration" below) in `tests/Application/.env.local`. After that is done, set up the database:
24-
25-
```bash
26-
$ (cd tests/Application && bin/console doctrine:database:create -e test)
27-
$ (cd tests/Application && bin/console doctrine:schema:create -e test)
28-
$ (cd tests/Application && bin/console sylius:fixtures:load -e dev)
29-
```
30-
When that is done, you can just start the symfony server:
31-
32-
```bash
33-
$ (cd tests/Application && bin/console server:run -d public -e dev)
34-
```
35-
36-
The server is now running, you can reach it at [http://127.0.0.1:8000/admin/](http://127.0.0.1:8000/admin/) and try to log in using your LDAP credentials.
37-
387
## Installation
39-
408
Run `composer require brille24/sylius-ldap-plugin` in your project-root.
419

4210
## Configuration
@@ -57,6 +25,8 @@ LDAP_USER_QUERY_DN='dc=example,dc=com'
5725
###< sylius/ldap-plugin ###
5826
```
5927

28+
To use this new method of authorizing users change the `form_login` in `config/packages/security.yaml` to `form_login_ldap`. For reference the plugin version of this configuration file is located under `tests/Application/config/packages/security.yaml`.
29+
6030
## Origin / Other Sources
6131

6232
This plugin is the result of the third sylius hackathon in oldenburg at brille24. It is based on `symfony/ldap`, so any guide for that package may also help you:

UPGRADE-1.3.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

UPGRADE-1.4.md

Lines changed: 0 additions & 86 deletions
This file was deleted.

0 commit comments

Comments
 (0)