s3-docs: add very basic winbind_krb5_locator.7 manpage.
[kai/samba-autobuild/.git] / docs-xml / manpages-3 / winbind_krb5_locator.7.xml
1 <?xml version="1.0" encoding="iso-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//Samba-Team//DTD DocBook V4.2-Based Variant V1.0//EN" "http://www.samba.org/samba/DTD/samba-doc">
3 <refentry id="winbind_krb5_locator.7">
4
5 <refmeta>
6         <refentrytitle>winbind_krb5_locator</refentrytitle>
7         <manvolnum>7</manvolnum>
8         <refmiscinfo class="source">Samba</refmiscinfo>
9         <refmiscinfo class="manual">7</refmiscinfo>
10         <refmiscinfo class="version">3.3</refmiscinfo>
11 </refmeta>
12
13
14 <refnamediv>
15         <refname>winbind_krb5_locator</refname>
16         <refpurpose>A plugin for MIT and Heimdal Kerberos for detecting KDCs using Windows semantics.</refpurpose>
17 </refnamediv>
18
19
20 <refsect1>
21         <title>DESCRIPTION</title>
22
23         <para>
24         This plugin is part of the <citerefentry><refentrytitle>samba</refentrytitle>
25         <manvolnum>7</manvolnum></citerefentry> suite.
26         </para>
27
28         <para>
29                 <command>winbind_krb5_locator</command> is a plugin that permits MIT and
30                 Heimdal Kerberos libraries to detect Kerberos Servers (for the KDC and
31                 kpasswd service) using the same semantics that other tools of the Samba
32                 suite use. This include site-aware DNS service record lookups and caching
33                 of closest dc.
34                 The plugin uses the public locator API provided by most modern Kerberos
35                 implementations.
36         </para>
37 </refsect1>
38 <refsect1>
39         <title>PREREQUISITES</title>
40         <para>
41                 MIT Kerberos (at least version 1.5) or Heimdal Kerberos (at least version
42                 1.0) is required.
43         </para>
44
45         <para>
46                 The plugin requires the winbindd daemon to be configured and started.
47         </para>
48
49         <para>
50                 The <command>winbind_krb5_locator</command>.so file needs to be manually
51                 copied to the plugin directory of the system Kerberos library.
52
53                 For MIT Kerberos this is often:
54                         <filename>/usr/lib/krb5/plugins/libkrb5/</filename>.
55                 For Heimdal Kerberos this is often:
56                         <filename>/usr/lib/plugin/krb5/</filename>.
57
58                 Please check your local Kerberos installation for the correct
59                 paths. No modification in <filename>/etc/krb5.conf</filename>
60                 is required to enable the use of this plugin.
61         </para>
62         <para>
63                 After copying the locator plugin to the appropriate plugin
64                 directory it should immediately be available for use.
65                 Users should be able to kinit into their kerberized Windows
66                 environment without any modification or servers
67                 being put manually into <filename>/etc/krb5.conf</filename>
68         </para>
69 </refsect1>
70
71 <refsect1>
72         <title>VERSION</title>
73
74         <para>
75         This man page is correct for version 3 of the Samba suite.
76         </para>
77 </refsect1>
78
79 <refsect1>
80         <title>AUTHOR</title>
81
82         <para>
83                 The original Samba software and related utilities were created by Andrew
84                 Tridgell. Samba is now developed by the Samba Team as an Open Source
85                 project similar to the way the Linux kernel is developed.
86         </para>
87
88         <para>
89                 The winbind_krb5_locator manpage page was written by Guenther Deschner.
90         </para>
91 </refsect1>
92
93 </refentry>