Skip to content

Commit

Permalink
Update docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
drupol committed Dec 3, 2019
1 parent 01ef9a7 commit 7db14c4
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 57 deletions.
52 changes: 2 additions & 50 deletions docs/pages/configuration.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,53 +3,5 @@
Configuration
=============

Example of configuration file in `config/packages/eulogin_cas.yaml`:

.. code:: yaml
cas:
base_url: https://webgate.ec.europa.eu/cas
protocol:
login:
path: /login
allowed_parameters:
- service
- renew
- gateway
serviceValidate:
allowed_parameters:
- format
- pgtUrl
- renew
- service
- ticket
- userDetails
path: /serviceValidate
default_parameters:
userDetails: "true"
format: XML
pgtUrl: cas_bundle_proxy_callback
logout:
path: /logout
allowed_parameters:
- service
default_parameters:
service: homepage
proxy:
path: /proxy
allowed_parameters:
- targetService
- pgt
proxyValidate:
path: /proxyValidate
allowed_parameters:
- format
- pgtUrl
- renew
- service
- ticket
- userDetails
default_parameters:
userDetails: "true"
format: XML
pgtUrl: cas_bundle_proxy_callback
.. literalinclude:: ../../Resources/config/packages/dev/cas_bundle.yaml
:language: yaml
24 changes: 17 additions & 7 deletions docs/pages/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,9 @@ Installation

This package does not yet have a Symfony Flex recipe. Installation steps must be done manually.

Default configuration files will be copied in the `dev` environment except for the file defining
the services.

Step 1
~~~~~~

Expand All @@ -17,29 +20,36 @@ The easiest way to install it is through Composer_
Step 2
~~~~~~

Edit the file `config/bundles.php` and add the line `drupol\\EuloginBundle\\EuloginBundle::class => ['all' => true],`.
Make sure that the bundle is enabled in `config/bundles.php`.

You should see a line that looks like the following:

.. code-block:: php
drupol\\EuloginBundle\\EuloginBundle::class => ['all' => true],
Step 3
~~~~~~

Recursively copy the content of the `Resources/config` folder in `config/` folder.
As this package depends on the package `drupol/cas-bundle`, you will need to copy
some configuration files from that package first.

.. code-block:: bash
cp -ar vendor/drupol/eulogin-bundle/Resources/config/* config/
cp -ar vendor/drupol/cas-bundle/Resources/config/* config/
As this package depends on the package `drupol/cas-bundle`, you will need to copy
some configuration files from that package as well.
Then, copy the configuration files from the bundle `drupol/eulogin-bundle` in your application

.. code-block:: bash
cp -ar vendor/drupol/cas-bundle/Resources/config/* config/
cp -ar vendor/drupol/eulogin-bundle/Resources/config/* config/
.. warning:: It is important to play those commands in the proper order.

Step 4
~~~~~~

Edit the configuration file `config/packages/eulogin_cas.yaml` and make the necessary changes to fit your needs.
Edit the configuration file `config/packages/dev/cas_bundle.yaml` and make the necessary changes to fit your needs.

See more on the dedicated :ref:`configuration` page.

Expand Down

0 comments on commit 7db14c4

Please sign in to comment.