Skip to content
Snippets Groups Projects
Commit 37161638 authored by Jérémy Bobbio (Lunar)'s avatar Jérémy Bobbio (Lunar)
Browse files

Invert symlink and content for the README file

GitLab will display the content of the README file when browsing the
repository. But in case the file is a symlink, it will display the
path pointed by the symlink. There is a 6 year old issue about this:
https://gitlab.com/gitlab-org/gitlab/-/issues/15093

We can workaround the issue by having the content at the root of the
repository and a symlink to this file in the `docs/` directory.

Tested in swh/devel/swh-py-template!27
parent 3544998c
No related branches found
No related tags found
No related merge requests found
Pipeline #1124 passed
docs/README.rst
\ No newline at end of file
Software Heritage - Authentication
==================================
``swh-auth`` is a set of utility libraries related to user authentication
in applications and services based on the use of `Keycloak`_ and `OpenID Connect`_.
`Keycloak`_ is an open source software enabling single sign-on (SSO) with identity
and access management.
`OpenID Connect`_ (OIDC) is an authentication layer on top of `OAuth 2.0`_, widely
used in modern web applications and services.
``swh-auth`` notably offers the following features:
- the ``swh.auth.keycloak.KeycloakOpenIDConnect`` class to ease the
interaction with a Keycloak server
- a ``pytest`` plugin with the ``keycloak_oidc`` fixture to mock Keycloak
responses in unit tests
- generic backends, views and middlewares to easily plug OpenID Connect authentication
in any `Django`_ or `Django REST framework`_ application
.. _Keycloak: https://www.keycloak.org/
.. _OpenID Connect: https://openid.net/connect/
.. _OAuth 2.0: https://oauth.net/2/
.. _Django: https://www.djangoproject.com/
.. _Django REST framework: https://www.django-rest-framework.org/
\ No newline at end of file
Software Heritage - Authentication
==================================
``swh-auth`` is a set of utility libraries related to user authentication
in applications and services based on the use of `Keycloak`_ and `OpenID Connect`_.
`Keycloak`_ is an open source software enabling single sign-on (SSO) with identity
and access management.
`OpenID Connect`_ (OIDC) is an authentication layer on top of `OAuth 2.0`_, widely
used in modern web applications and services.
``swh-auth`` notably offers the following features:
- the ``swh.auth.keycloak.KeycloakOpenIDConnect`` class to ease the
interaction with a Keycloak server
- a ``pytest`` plugin with the ``keycloak_oidc`` fixture to mock Keycloak
responses in unit tests
- generic backends, views and middlewares to easily plug OpenID Connect authentication
in any `Django`_ or `Django REST framework`_ application
.. _Keycloak: https://www.keycloak.org/
.. _OpenID Connect: https://openid.net/connect/
.. _OAuth 2.0: https://oauth.net/2/
.. _Django: https://www.djangoproject.com/
.. _Django REST framework: https://www.django-rest-framework.org/
\ No newline at end of file
../README.rst
\ No newline at end of file
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment