File: index.rst

package info (click to toggle)
django-otp-yubikey 1.0.0.post1-1.1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 152 kB
  • sloc: python: 445; makefile: 131
file content (68 lines) | stat: -rw-r--r-- 1,177 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
django-otp-yubikey
==================

.. include:: ../../README.rst


Installation
------------

django-otp-yubikey can be installed via pip::

    pip install django-otp-yubikey


Once installed it should be added to INSTALLED_APPS after django_otp core::

    INSTALLED_APPS = [
        ...
        'django_otp',
        'django_otp.plugins.otp_totp',
        'django_otp.plugins.otp_hotp',
        'django_otp.plugins.otp_static',

        'otp_yubikey',
    ]


Local Verification
------------------

.. autoclass:: otp_yubikey.models.YubikeyDevice
    :members:


Remote Verification
-------------------

.. autoclass:: otp_yubikey.models.ValidationService
    :members:

.. autoclass:: otp_yubikey.models.RemoteYubikeyDevice
    :members:


Admin
-----

The following :class:`~django.contrib.admin.ModelAdmin` subclasses are
registered with the default admin site. We recommend their use with custom admin
sites as well:

.. autoclass:: otp_yubikey.admin.YubikeyDeviceAdmin

.. autoclass:: otp_yubikey.admin.ValidationServiceAdmin

.. autoclass:: otp_yubikey.admin.RemoteYubikeyDeviceAdmin


Changes
-------

:doc:`changes`


License
=======

.. include:: ../../LICENSE