Skip to content

Commit d381dad

Browse files
committed
Add some more documentation
1 parent 2d04a7f commit d381dad

File tree

1 file changed

+32
-0
lines changed

1 file changed

+32
-0
lines changed

README.rst

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,4 +15,36 @@ TODO:
1515
- package this backend and publish to PyPI
1616
- enable testing
1717
- why there are 2 classes for kerberos backend? which one if the real deal
18+
maybe 'tcms.auth.kerberos.ModAuthKerbBackend' ????
1819
- check-out https://github.com/kiwitcms/Kiwi/issues/240
20+
21+
22+
This package provides passwordless authentication for Kiwi TCMS via Kerberos.
23+
This is turned off by default because most organizations do not use it. To enable
24+
configure the following settings::
25+
26+
MIDDLEWARE += [
27+
'django.contrib.auth.middleware.RemoteUserMiddleware',
28+
]
29+
30+
AUTHENTICATION_BACKENDS += [
31+
'tcms.auth.kerberos.ModAuthKerbBackend',
32+
]
33+
34+
KRB5_REALM='YOUR-DOMAIN.COM'
35+
36+
37+
Also modify Kiwi TCMS ``Dockerfile`` to include the following lines::
38+
39+
RUN yum -y install krb5-devel mod_auth_kerb
40+
RUN pip install kerberos
41+
COPY ./auth_kerb.conf /etc/httpd/conf.d/
42+
43+
Where ``auth_kerb.conf`` is your Kerberos configuration file for Apache!
44+
More information about it can be found
45+
`here <https://access.redhat.com/documentation/en-US/Red_Hat_JBoss_Web_Server/2/html/HTTP_Connectors_Load_Balancing_Guide/ch10s02s03.html>`_.
46+
47+
.. warning::
48+
49+
Unless Kerberos authentication is configured and fully-operational the
50+
XML-RPC method `Auth.login_krbv()` will not work!

0 commit comments

Comments
 (0)