Skip to content

Commit

Permalink
Update documentation.
Browse files Browse the repository at this point in the history
(cherry picked from commit 4545d05)
  • Loading branch information
drupol committed Jun 9, 2020
1 parent c785751 commit 25addde
Show file tree
Hide file tree
Showing 6 changed files with 14 additions and 102 deletions.
16 changes: 0 additions & 16 deletions docs/_static/custom.css

This file was deleted.

59 changes: 0 additions & 59 deletions docs/_static/highlight.css

This file was deleted.

6 changes: 6 additions & 0 deletions docs/pages/development.rst
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ yet to disable this for testing purposes.

If you prefer to use your local machine, there are already `some documentation on Github`_.

If you want to test against `EU Login`_, make sure that your application respond on the ``localhost`` hostname, it's the
only domain for which it will work.
However, only basic authentication will work and it will not be possible to enable authentication with proxy because
the hostname ``localhost`` will not be accessible from the Internet.

Maintainers
-----------

Expand All @@ -31,3 +36,4 @@ See the `Github insights page`_.
.. _some documentation on Github: https://apereo.github.io/cas/developer/Build-Process.html
.. _MAINTAINERS.txt: https://github.com/ecphp/eu-login-bundle/blob/master/MAINTAINERS.txt
.. _Github insights page: https://github.com/ecphp/eu-login-bundle/graphs/contributors
.. _EU Login: https://ecas.ec.europa.eu/cas/
27 changes: 3 additions & 24 deletions docs/pages/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -56,29 +56,8 @@ See more on the dedicated :ref:`configuration` page.
Step 5
~~~~~~

This is the crucial part of your application's security configuration.

Edit the security settings of your application by edition the file `config/packages/security.yaml`.

.. code-block:: yaml
security:
firewalls:
main:
anonymous: ~
guard:
provider: eulogin
authenticators:
- cas.guardauthenticator
access_control:
- { path: ^/api, role: ROLE_CAS_AUTHENTICATED }
- { path: ^/admin, role: ROLE_CAS_AUTHENTICATED }
This configuration example will trigger the authentication on paths starting
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`_.
Read the `ecphp/cas-bundle documentation`_ to have more information on how to enable a firewall and protect your
application.

.. _Composer: https://getcomposer.org
.. _ecphp/cas-bundle documentation: https://cas-bundle.readthedocs.io/en/latest/pages/installation.html
5 changes: 2 additions & 3 deletions docs/pages/tests.rst
Original file line number Diff line number Diff line change
@@ -1,8 +1,7 @@
Tests, code quality and code style
==================================

Every time changes are introduced into the library, `Travis CI`_ and `Github Actions`_
run the tests written with `PHPSpec`_.
Every time changes are introduced into the library, `Github Actions`_ run the tests written with `PHPSpec`_.

`PHPInfection`_ is also triggered used to ensure that your code is properly
tested.
Expand Down Expand Up @@ -51,4 +50,4 @@ will check your code
.. _Github Actions: https://github.com/ecphp/cas-bundle/actions
.. _PHPSpec: http://www.phpspec.net/
.. _PHPInfection: https://github.com/infection/infection
.. _Grumphp: https://github.com/phpro/grumphp
.. _Grumphp: https://github.com/phpro/grumphp
3 changes: 3 additions & 0 deletions docs/pages/usage.rst
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
Usage
=====

Once the bundle installed and setup properly, browsing a secured path should redirect you to EU Login, straight for
authentication.

0 comments on commit 25addde

Please sign in to comment.