File tree Expand file tree Collapse file tree 4 files changed +34
-12
lines changed
Expand file tree Collapse file tree 4 files changed +34
-12
lines changed Original file line number Diff line number Diff line change @@ -58,11 +58,18 @@ This enables asyncpg to have easy-to-use support for:
5858Installation
5959------------
6060
61- asyncpg is available on PyPI and has no dependencies.
62- Use pip to install::
61+ asyncpg is available on PyPI. When not using GSSAPI/SSPI authentication it
62+ has no dependencies. Use pip to install::
6363
6464 $ pip install asyncpg
6565
66+ If you need GSSAPI/SSPI authentication, use::
67+
68+ $ pip install 'asyncpg[gssauth]'
69+
70+ For more details, please `see the documentation
71+ <https://magicstack.github.io/asyncpg/current/installation.html> `_.
72+
6673
6774Basic Usage
6875-----------
Original file line number Diff line number Diff line change @@ -724,7 +724,7 @@ cdef class CoreProtocol:
724724 import gssapi
725725 except ModuleNotFoundError:
726726 raise apg_exc.InterfaceError(
727- ' gssapi module not found; please install asyncpg[gssapi ] to '
727+ ' gssapi module not found; please install asyncpg[gssauth ] to '
728728 ' use asyncpg with Kerberos/GSSAPI/SSPI authentication'
729729 ) from None
730730
@@ -736,7 +736,7 @@ cdef class CoreProtocol:
736736 import sspilib
737737 except ModuleNotFoundError:
738738 raise apg_exc.InterfaceError(
739- ' sspilib module not found; please install asyncpg[gssapi ] to '
739+ ' sspilib module not found; please install asyncpg[gssauth ] to '
740740 ' use asyncpg with Kerberos/GSSAPI/SSPI authentication'
741741 ) from None
742742
Original file line number Diff line number Diff line change 44Installation
55============
66
7- **asyncpg ** has no external dependencies and the recommended way to
8- install it is to use **pip **:
7+ **asyncpg ** has no external dependencies when not using GSSAPI/SSPI
8+ authentication. The recommended way to install it is to use **pip **:
99
1010.. code-block :: bash
1111
1212 $ pip install asyncpg
1313
14+ If you need GSSAPI/SSPI authentication, the recommended way is to use
1415
15- .. note ::
16+ .. code-block :: bash
17+
18+ $ pip install ' asyncpg[gssauth]'
19+
20+ This installs SSPI support on Windows and GSSAPI support on non-Windows
21+ platforms. SSPI and GSSAPI interoperate as clients and servers: an SSPI
22+ client can authenticate to a GSSAPI server and vice versa.
23+
24+ On Linux installing GSSAPI requires a working C compiler and Kerberos 5
25+ development files. The latter can be obtained by installing **libkrb5-dev **
26+ package on Debian/Ubuntu or **krb5-devel ** on RHEL/Fedora. (This is needed
27+ because PyPI does not have Linux wheels for gssapi. See `here for the details
28+ <https://github.com/pythongssapi/python-gssapi/issues/200#issuecomment-1032934269> `_.)
29+
30+ It is also possible to use GSSAPI on Windows:
1631
17- It is recommended to use ** pip ** version ** 8.1 ** or later to take
18- advantage of the precompiled wheel packages. Older versions of pip
19- will ignore the wheel packages and install asyncpg from the source
20- package. In that case a working C compiler is required .
32+ * ` pip install gssapi `
33+ * Install ` Kerberos for Windows < https://web.mit.edu/kerberos/dist/ >`_.
34+ * Set the `` gsslib `` parameter or the `` PGGSSLIB `` environment variable to
35+ ` gssapi ` when connecting .
2136
2237
2338Building from source
Original file line number Diff line number Diff line change @@ -35,7 +35,7 @@ dependencies = [
3535github = " https://github.com/MagicStack/asyncpg"
3636
3737[project .optional-dependencies ]
38- gssapi = [
38+ gssauth = [
3939 ' gssapi; platform_system != "Windows"' ,
4040 ' sspilib; platform_system == "Windows"' ,
4141]
You can’t perform that action at this time.
0 commit comments