Convert DEBUG_REFERRALS to TRACE_* framework
[krb5.git] / doc / rst_source / krb_admins / env_variables.rst
1 Environment variables
2 =====================
3
4 The following environment variables can be used during runtime:
5
6 **KRB5_CONFIG**
7     Main Kerberos configuration file.  (See :ref:`mitK5defaults` for
8     the default name.)
9
10 **KRB5_KDC_PROFILE**
11     KDC configuration file.  (See :ref:`mitK5defaults` for the default
12     name.)
13
14 **KRB5_KTNAME**
15     Default keytab file name.  (See :ref:`mitK5defaults` for the
16     default name.)
17
18 **KRB5CCNAME**
19     Default name for the credentials cache file, in the form *type*\:\
20     *residual*.  The type of the default cache may determine the
21     availability of a cache collection.  For instance, a default cache
22     of type ``DIR`` causes caches within the directory to be present
23     in the global cache collection.
24
25 **KRB5RCACHETYPE**
26     Default replay cache type.  Defaults to ``dfl``.  A value of
27     ``none`` disables the replay cache.
28
29 **KRB5RCACHEDIR**
30     Default replay cache directory.  (See :ref:`mitK5defaults` for the
31     default location.)
32
33 **KPROP_PORT**
34     :ref:`kprop(8)` port to use.  Defaults to 754.
35
36 **KRB5_TRACE**
37     Filename for trace-logging output (introduced in release 1.9).
38     For example, ``env KRB5_TRACE=/dev/stdout kinit`` would send
39     tracing information for kinit to ``/dev/stdout``.  Some programs
40     may ignore this variable (particularly setuid or login system
41     programs).