Skip to content

Commit

Permalink
Symfony recipe is live, update installation steps.
Browse files Browse the repository at this point in the history
  • Loading branch information
drupol committed Jun 28, 2020
1 parent 388a3db commit 115d4f2
Showing 1 changed file with 4 additions and 33 deletions.
37 changes: 4 additions & 33 deletions docs/pages/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,10 +3,9 @@
Installation
============

This package does not yet have a Symfony Flex recipe. Installation steps must be done manually.
This package has `a Symfony Flex recipe`_ that will install configuration files for you.

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

Step 1
~~~~~~
Expand All @@ -20,40 +19,11 @@ The easiest way to install it is through Composer_
Step 2
~~~~~~

Make sure that the bundle is enabled in `config/bundles.php`.

You should see a line that looks like the following:

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

As this package depends on the package `ecphp/cas-bundle`, you will need to copy
some configuration files from that package first.

.. code-block:: bash
cp -ar vendor/ecphp/cas-bundle/Resources/config/* config/
Then, copy the configuration files from the bundle `ecphp/eu-login-bundle` in your application

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

Step 4
~~~~~~

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.

Step 5
Step 3
~~~~~~

This is the crucial part of your application's security configuration.
Expand Down Expand Up @@ -81,6 +51,7 @@ with `/api` or `/admin`, therefore make sure that at least such paths exists.
Feel free to change these configuration to fits your need. Have a look at
`the Symfony documentation about security and Guard authentication`_ and `the configuration reference`_.

.. _a Symfony Flex recipe: https://github.com/symfony/recipes-contrib/blob/master/ecphp/eu-login-bundle/2.0/manifest.json
.. _Composer: https://getcomposer.org
.. _the Symfony documentation about security and Guard authentication: https://symfony.com/doc/current/security/guard_authentication.html
.. _the configuration reference: https://symfony.com/doc/current/reference/configuration/security.html

0 comments on commit 115d4f2

Please sign in to comment.