https://github.com/sohalt/pretix-ldap

LDAP authentication backend for pretix
https://github.com/sohalt/pretix-ldap

ldap ldap-authentication pretix

Last synced: about 2 months ago
JSON representation

LDAP authentication backend for pretix

• Host: GitHub
• URL: https://github.com/sohalt/pretix-ldap
• Owner: Sohalt
• License: other
• Created: 2019-12-27T15:55:33.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2024-04-15T12:20:43.000Z (about 1 year ago)
• Last Synced: 2025-04-14T08:09:18.764Z (about 2 months ago)
• Topics: ldap, ldap-authentication, pretix
• Language: Python
• Size: 36.1 KB
• Stars: 4
• Watchers: 3
• Forks: 7
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
pretix LDAP

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

LDAP authentication plugin for `pretix`_.

Installation

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

You can install the plugin using ::

  $ pip install pretix-ldap

You need to enable the plugin by including ``pretix_ldap.LDAPAuthBackend`` in the ``auth_backends`` option in your ``pretix.cfg`` (see https://docs.pretix.eu/en/latest/admin/config.html).

You also need to add a ``[ldap]`` section in your ``pretix.cfg`` to configure the connection to the ldap server.

Options are:

``bind_url``

    The url of the ldap server (required)

    Example: ``ldap://ldap.example.com``

``bind_dn``

    The dn of the account to use to query the ldap server (required)

    Example: ``cn=readonly,dc=example,dc=com``

``bind_password``

    The password of the account to use to query the ldap server (required)

    Example: ``changeme``

``search_base``

    The search base (required)

    Example: ``ou=people,dc=example,dc=com``

``search_filter``

    Filter to search for users. You can use placeholders in curly braces, which will get populated from form fields of the same name.

    Default: ``(&(objectClass=inetOrgPerson)(mail={email}))``

    Example: ``(&(objectClass=inetOrgPerson)(memberOf=cn=pretix,ou=groups,dc=example,dc=com)(mail={email}))``

``email_attr``

    The name of an attribute that can be used to retrieve the user's email address

    Default: ``mail``

``unique_attr``

    The name of a stable attribute that can be used to uniquely identify a user

    Default: ``dn``

    Example: ``entryUUID``

Example Deployment

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

An example deployment using ``docker-compose`` can be found in the ``example`` folder.

After running ``docker-compose up`` you should be able to log in at ``http://localhost:80/control`` using the email "[email protected]" and password "password".

Development setup

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

1. Make sure that you have a working `pretix development setup`_.

2. Clone this repository, eg to ``local/pretix-ldap``.

3. Activate the virtual environment you use for pretix development.

4. Execute ``python setup.py develop`` within this directory to register this application with pretix's plugin registry.

5. Restart your local pretix server. You can now use the plugin from this repository for your events by enabling it in

   the 'plugins' tab in the settings.

Running CI linter and tests locally

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

1. `Install nix`_

2. Enter devshell: `nix develop`

3. Build package::

    python -m build

4. Run linter::

    flake8

5. Run tests::

    cp -r dist tests

    cd tests

    pytest

License

-------

Copyright 2019 sohalt

Released under the terms of the Apache License 2.0

.. _pretix: https://github.com/pretix/pretix

.. _pretix development setup: https://docs.pretix.eu/en/latest/development/setup.html

.. _Install nix: https://github.com/DeterminateSystems/nix-installer