Edit defaults page in documentation
[krb5.git] / doc / rst_source / mitK5defaults.rst
1 .. _mitK5defaults:
2
3 MIT Kerberos defaults
4 =====================
5
6 General defaults
7 ----------------
8
9 ==========================  =============================  ====================
10 Description                 Default                        Environment
11 ==========================  =============================  ====================
12 Keytab file                 ``FILE:``\ |keytab|            **KRB5_KTNAME**
13 Kerberos config file        |krb5conf|\ ``:``\             **KRB5_CONFIG**
14                             |sysconfdir|\ ``/krb5.conf``
15 KDC config file             |kdcdir|\ ``/kdc.conf``        **KRB5_KDC_PROFILE**
16 KDC database path (DB2)     |kdcdir|\ ``/principal``
17 Master key stash file       |kdcdir|\ ``/.k5.``\ *realm*
18 Admin server ACL file       |kdcdir|\ ``/kadm5.acl``
19 Plugin base directory       |libdir|\ ``/krb5/plugins``
20 Replay cache directory      ``/var/tmp``                   **KRB5RCACHEDIR**
21 Master key default enctype  |defmkey|
22 Supported enc/salt types    |defkeysalts|
23 Permitted enctypes          |defetypes|
24 KDC default port            88
25 Second KDC default port     750
26 Admin server port           749
27 Password change port        464
28 ==========================  =============================  ====================
29
30
31 Slave KDC propagation defaults
32 ------------------------------
33
34 This table shows defaults used by the :ref:`kprop(8)` and
35 :ref:`kpropd(8)` programs.
36
37 ==========================  ==============================  ===========
38 Description                 Default                         Environment
39 ==========================  ==============================  ===========
40 kprop database dump file    |kdcdir|\ ``/slave_datatrans``
41 kpropd temporary dump file  |kdcdir|\ ``/from_master``
42 kdb5_util location          |sbindir|\ ``/kdb5_util``
43 kprop location              |sbindir|\ ``/kprop``
44 kpropd ACL file             |kdcdir|\ ``/kpropd.acl``
45 kprop port                  754                             KPROP_PORT
46 ==========================  ==============================  ===========
47
48
49 Default paths for Unix-like systems
50 -----------------------------------
51
52 On Unix-like systems, some paths used by MIT krb5 depend on parameters
53 chosen at build time.  For a custom build, these paths default to
54 subdirectories of ``/usr/local``.  When MIT krb5 is integrated into an
55 operating system, the paths are generally chosen to match the
56 operating system's filesystem layout.
57
58 =======================  ===============  ===================  ===============
59 Description              Symbolic name    Custom build path    Typical OS path
60 =======================  ===============  ===================  ===============
61 User programs            BINDIR           ``/usr/local/bin``   ``/usr/bin``
62 Libraries and plugins    LIBDIR           ``/usr/local/lib``   ``/usr/lib``
63 Parent of KDC state dir  LOCALSTATEDIR    ``/usr/local/var``   ``/var``
64 Administrative programs  SBINDIR          ``/usr/local/sbin``  ``/usr/sbin``
65 Alternate krb5.conf dir  SYSCONFDIR       ``/usr/local/etc``   ``/etc``
66 =======================  ===============  ===================  ===============