Code development platform for open source projects from the European Union institutions

Verified Commit 6a578027 authored by Pol Dellaiera's avatar Pol Dellaiera
Browse files

docs: Update documentation accordingly.

parent 9017cf72
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -10,7 +10,7 @@

# EU Login API Authentication Bundle

A bundle for Symfony 5.
A bundle for Symfony.

Read more on the [dedicated documentation site][http readthedocs].

+1 −1
Original line number Diff line number Diff line
EU Login API Authentication Bundle
==================================

This Symfony 5 bundle provides the necessary to authenticate a request having a
This Symfony bundle provides the necessary to authenticate a request having a
specific ``Authorization`` HTTP header with a ``pop`` token.

Supported tokens are:
+6 −5
Original line number Diff line number Diff line
@@ -29,6 +29,7 @@ In order to do that, follow the following steps:

.. code-block:: yaml

    when@dev:
        services:
            EcPhp\EuLoginApiAuthenticationBundle\Service\LocalEuLoginApiCredentials:
                decorates: 'eu_login_api_authentication.service'
@@ -37,7 +38,7 @@ In order to do that, follow the following steps:
2. This will replace the `EU Login`_ authentication mechanism by another one
   which does not require any connection to `EU Login`_.

   .. warning:: Be extremely careful, do not enable that in production.
   .. warning:: Be extremely careful to not enable that for production environment.

3. Read the `official Symfony documentation`_ if you want to enable this only
   for a particular `environment`_.
+5 −9
Original line number Diff line number Diff line
@@ -47,26 +47,22 @@ Edit the security settings of your application by edition the file `config/packa
.. code-block:: yaml

    security:
        enable_authenticator_manager: true
        firewalls:
            dev:
                pattern: ^/(_(profiler|wdt)|css|images|js)/
                security: false
            main:
                anonymous: true
                stateless: true
                provider: eu_login_api_authentication
                guard:
                    authenticators:
                        - eu_login_api_authentication.guard
                custom_authenticators:
                    - 'eu_login_api_authentication.authenticator'

        access_control:
            - { path: ^/token, role: IS_AUTHENTICATED_ANONYMOUSLY }
            - { path: ^/user, role: IS_AUTHENTICATED_FULLY }

Feel free to change these configuration to fits your need. Have a look at
`the Symfony documentation about security and Guard authentication`_.
`the Symfony documentation about security and authentication`_.

.. _a Symfony Flex recipe: https://github.com/symfony/recipes-contrib/blob/master/ecphp/eu-login-api-authentication-bundle/1.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 Symfony documentation about security and authentication: https://symfony.com/doc/current/security/guard_authentication.html
.. _Symfony recipe: https://github.com/symfony/recipes-contrib/tree/master/ecphp/eu-login-api-authentication-bundle/1.0