https://github.com/divio/aldryn-sso

Single sign-on Integration for Divio Cloud
https://github.com/divio/aldryn-sso

addon cloud divio django python sso

Last synced: about 2 months ago
JSON representation

Single sign-on Integration for Divio Cloud

• Host: GitHub
• URL: https://github.com/divio/aldryn-sso
• Owner: divio
• License: other
• Created: 2015-09-27T04:19:25.000Z (over 9 years ago)
• Default Branch: master
• Last Pushed: 2024-05-22T08:38:43.000Z (8 months ago)
• Last Synced: 2024-10-28T22:27:04.427Z (3 months ago)
• Topics: addon, cloud, divio, django, python, sso
• Language: Python
• Homepage: https://www.divio.com
• Size: 719 KB
• Stars: 5
• Watchers: 15
• Forks: 6
• Open Issues: 5
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
==========

Aldryn SSO

==========

|pypi| |build| |coverage|

**Aldryn SSO** adds single-sign-on to Divio Cloud.

This addon still uses the legacy "Aldryn" naming. You can read more about this in our

`support section `_.

Contributing

============

This is a an open-source project. We'll be delighted to receive your

feedback in the form of issues and pull requests. Before submitting your

pull request, please review our `contribution guidelines

`_.

We're grateful to all contributors who have helped create and maintain this package.

Contributors are listed at the `contributors `_

section.

Documentation

=============

See ``REQUIREMENTS`` in the `setup.py `_

file for additional dependencies:

|python| |django|

Installation

------------

Nothing to do. ``aldryn-sso`` is part of the Divio Cloud.

Running Tests

-------------

You can run tests by executing::

    virtualenv env

    source env/bin/activate

    pip install -r tests/requirements.txt

    python setup.py test

.. |pypi| image:: https://badge.fury.io/py/aldryn-sso.svg

    :target: http://badge.fury.io/py/aldryn-sso

.. |build| image:: https://github.com/divio/aldryn-aldryn-sso/actions/workflows/default.yml/badge.svg?branch=master

    :target: https://github.com/divio/aldryn-sso/actions

.. |coverage| image:: https://codecov.io/gh/divio/aldryn-sso/branch/master/graph/badge.svg

    :target: https://codecov.io/gh/divio/aldryn-sso

.. |python| image:: https://img.shields.io/badge/python-3.8+-blue.svg

    :target: https://pypi.org/project/aldryn-sso/

.. |django| image:: https://img.shields.io/badge/django-3.2,%204.2,%205.0-blue.svg

    :target: https://www.djangoproject.com/

Sharing Links and Tokens

------------------------

Aldryn SSO supports a "test link" or "preview mode" feature to bypass the password protection of test environments. This is normally useful to share a test environment with other people without complicated setups and passwords, a link is enough.

The links are in the following form: `https://{aldryn_url}/?sharing_token={token}`, where the token is the value of the `SHARING_VIEW_ONLY_SECRET_TOKEN` environment variable.

This environment variable can bet set in the container as part of your build process. The argument name (`sharing_token`) can also be overridden by setting the `SHARING_VIEW_ONLY_TOKEN_KEY_NAME` environment variable to your desired value.