doc/html/admin/env_variables.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
   2   "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   3
   4
   5 <html xmlns="http://www.w3.org/1999/xhtml">
   6   <head>
   7     <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
   8
   9     <title>Environment variables &mdash; MIT Kerberos Documentation</title>
  10
  11     <link rel="stylesheet" href="../_static/agogo.css" type="text/css" />
  12     <link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
  13     <link rel="stylesheet" href="../_static/kerb.css" type="text/css" />
  14
  15     <script type="text/javascript">
  16       var DOCUMENTATION_OPTIONS = {
  17         URL_ROOT:    '../',
  18         VERSION:     '1.15.2',
  19         COLLAPSE_INDEX: false,
  20         FILE_SUFFIX: '.html',
  21         HAS_SOURCE:  true
  22       };
  23     </script>
  24     <script type="text/javascript" src="../_static/jquery.js"></script>
  25     <script type="text/javascript" src="../_static/underscore.js"></script>
  26     <script type="text/javascript" src="../_static/doctools.js"></script>
  27     <link rel="author" title="About these documents" href="../about.html" />
  28     <link rel="copyright" title="Copyright" href="../copyright.html" />
  29     <link rel="top" title="MIT Kerberos Documentation" href="../index.html" />
  30     <link rel="up" title="For administrators" href="index.html" />
  31     <link rel="next" title="Troubleshooting" href="troubleshoot.html" />
  32     <link rel="prev" title="MIT Kerberos defaults" href="../mitK5defaults.html" />
  33   </head>
  34   <body>
  35     <div class="header-wrapper">
  36         <div class="header">
  37
  38
  39             <h1><a href="../index.html">MIT Kerberos Documentation</a></h1>
  40
  41             <div class="rel">
  42
  43         <a href="../index.html" title="Full Table of Contents"
  44             accesskey="C">Contents</a> |
  45         <a href="../mitK5defaults.html" title="MIT Kerberos defaults"
  46             accesskey="P">previous</a> |
  47         <a href="troubleshoot.html" title="Troubleshooting"
  48             accesskey="N">next</a> |
  49         <a href="../genindex.html" title="General Index"
  50             accesskey="I">index</a> |
  51         <a href="../search.html" title="Enter search criteria"
  52             accesskey="S">Search</a> |
  53     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Environment variables">feedback</a>
  54             </div>
  55         </div>
  56     </div>
  57
  58     <div class="content-wrapper">
  59       <div class="content">
  60         <div class="document">
  61
  62       <div class="documentwrapper">
  63         <div class="bodywrapper">
  64           <div class="body">
  65
  66   <div class="section" id="environment-variables">
  67 <h1>Environment variables<a class="headerlink" href="#environment-variables" title="Permalink to this headline">¶</a></h1>
  68 <p>The following environment variables can be used during runtime:</p>
  69 <dl class="docutils">
  70 <dt><strong>KRB5_CONFIG</strong></dt>
  71 <dd>Main Kerberos configuration file.  Multiple filenames can be
  72 specified, separated by a colon; all files which are present will
  73 be read.  (See <a class="reference internal" href="../mitK5defaults.html#mitk5defaults"><em>MIT Kerberos defaults</em></a> for the default path.)</dd>
  74 <dt><strong>KRB5_KDC_PROFILE</strong></dt>
  75 <dd>KDC configuration file.  (See <a class="reference internal" href="../mitK5defaults.html#mitk5defaults"><em>MIT Kerberos defaults</em></a> for the default
  76 name.)</dd>
  77 <dt><strong>KRB5_KTNAME</strong></dt>
  78 <dd>Default keytab file name.  (See <a class="reference internal" href="../mitK5defaults.html#mitk5defaults"><em>MIT Kerberos defaults</em></a> for the
  79 default name.)</dd>
  80 <dt><strong>KRB5_CLIENT_KTNAME</strong></dt>
  81 <dd>Default client keytab file name.  (See <a class="reference internal" href="../mitK5defaults.html#mitk5defaults"><em>MIT Kerberos defaults</em></a> for
  82 the default name.)</dd>
  83 <dt><strong>KRB5CCNAME</strong></dt>
  84 <dd>Default name for the credentials cache file, in the form <em>type</em>:<em>residual</em>.  The type of the default cache may determine the
  85 availability of a cache collection.  For instance, a default cache
  86 of type <tt class="docutils literal"><span class="pre">DIR</span></tt> causes caches within the directory to be present
  87 in the global cache collection.</dd>
  88 <dt><strong>KRB5RCACHETYPE</strong></dt>
  89 <dd>Default replay cache type.  Defaults to <tt class="docutils literal"><span class="pre">dfl</span></tt>.  A value of
  90 <tt class="docutils literal"><span class="pre">none</span></tt> disables the replay cache.</dd>
  91 <dt><strong>KRB5RCACHEDIR</strong></dt>
  92 <dd>Default replay cache directory.  (See <a class="reference internal" href="../mitK5defaults.html#mitk5defaults"><em>MIT Kerberos defaults</em></a> for the
  93 default location.)</dd>
  94 <dt><strong>KPROP_PORT</strong></dt>
  95 <dd><a class="reference internal" href="admin_commands/kprop.html#kprop-8"><em>kprop</em></a> port to use.  Defaults to 754.</dd>
  96 <dt><strong>KRB5_TRACE</strong></dt>
  97 <dd>Filename for trace-logging output (introduced in release 1.9).
  98 For example, <tt class="docutils literal"><span class="pre">env</span> <span class="pre">KRB5_TRACE=/dev/stdout</span> <span class="pre">kinit</span></tt> would send
  99 tracing information for kinit to <tt class="docutils literal"><span class="pre">/dev/stdout</span></tt>.  Some programs
 100 may ignore this variable (particularly setuid or login system
 101 programs).</dd>
 102 </dl>
 103 </div>
 104
 105
 106           </div>
 107         </div>
 108       </div>
 109         </div>
 110         <div class="sidebar">
 111     <h2>On this page</h2>
 112     <ul>
 113 <li><a class="reference internal" href="#">Environment variables</a></li>
 114 </ul>
 115
 116     <br/>
 117     <h2>Table of contents</h2>
 118     <ul class="current">
 119 <li class="toctree-l1"><a class="reference internal" href="../user/index.html">For users</a></li>
 120 <li class="toctree-l1 current"><a class="reference internal" href="index.html">For administrators</a><ul class="current">
 121 <li class="toctree-l2"><a class="reference internal" href="install.html">Installation guide</a></li>
 122 <li class="toctree-l2"><a class="reference internal" href="conf_files/index.html">Configuration Files</a></li>
 123 <li class="toctree-l2"><a class="reference internal" href="realm_config.html">Realm configuration decisions</a></li>
 124 <li class="toctree-l2"><a class="reference internal" href="database.html">Database administration</a></li>
 125 <li class="toctree-l2"><a class="reference internal" href="lockout.html">Account lockout</a></li>
 126 <li class="toctree-l2"><a class="reference internal" href="conf_ldap.html">Configuring Kerberos with OpenLDAP back-end</a></li>
 127 <li class="toctree-l2"><a class="reference internal" href="appl_servers.html">Application servers</a></li>
 128 <li class="toctree-l2"><a class="reference internal" href="host_config.html">Host configuration</a></li>
 129 <li class="toctree-l2"><a class="reference internal" href="backup_host.html">Backups of secure hosts</a></li>
 130 <li class="toctree-l2"><a class="reference internal" href="pkinit.html">PKINIT configuration</a></li>
 131 <li class="toctree-l2"><a class="reference internal" href="otp.html">OTP Preauthentication</a></li>
 132 <li class="toctree-l2"><a class="reference internal" href="princ_dns.html">Principal names and DNS</a></li>
 133 <li class="toctree-l2"><a class="reference internal" href="enctypes.html">Encryption types</a></li>
 134 <li class="toctree-l2"><a class="reference internal" href="https.html">HTTPS proxy configuration</a></li>
 135 <li class="toctree-l2"><a class="reference internal" href="auth_indicator.html">Authentication indicators</a></li>
 136 <li class="toctree-l2"><a class="reference internal" href="admin_commands/index.html">Administration  programs</a></li>
 137 <li class="toctree-l2"><a class="reference internal" href="../mitK5defaults.html">MIT Kerberos defaults</a></li>
 138 <li class="toctree-l2 current"><a class="current reference internal" href="">Environment variables</a></li>
 139 <li class="toctree-l2"><a class="reference internal" href="troubleshoot.html">Troubleshooting</a></li>
 140 <li class="toctree-l2"><a class="reference internal" href="advanced/index.html">Advanced topics</a></li>
 141 <li class="toctree-l2"><a class="reference internal" href="various_envs.html">Various links</a></li>
 142 </ul>
 143 </li>
 144 <li class="toctree-l1"><a class="reference internal" href="../appdev/index.html">For application developers</a></li>
 145 <li class="toctree-l1"><a class="reference internal" href="../plugindev/index.html">For plugin module developers</a></li>
 146 <li class="toctree-l1"><a class="reference internal" href="../build/index.html">Building Kerberos V5</a></li>
 147 <li class="toctree-l1"><a class="reference internal" href="../basic/index.html">Kerberos V5 concepts</a></li>
 148 <li class="toctree-l1"><a class="reference internal" href="../formats/index.html">Protocols and file formats</a></li>
 149 <li class="toctree-l1"><a class="reference internal" href="../mitK5features.html">MIT Kerberos features</a></li>
 150 <li class="toctree-l1"><a class="reference internal" href="../build_this.html">How to build this documentation from the source</a></li>
 151 <li class="toctree-l1"><a class="reference internal" href="../about.html">Contributing to the MIT Kerberos Documentation</a></li>
 152 <li class="toctree-l1"><a class="reference internal" href="../resources.html">Resources</a></li>
 153 </ul>
 154
 155     <br/>
 156     <h4><a href="../index.html">Full Table of Contents</a></h4>
 157     <h4>Search</h4>
 158     <form class="search" action="../search.html" method="get">
 159       <input type="text" name="q" size="18" />
 160       <input type="submit" value="Go" />
 161       <input type="hidden" name="check_keywords" value="yes" />
 162       <input type="hidden" name="area" value="default" />
 163     </form>
 164         </div>
 165         <div class="clearer"></div>
 166       </div>
 167     </div>
 168
 169     <div class="footer-wrapper">
 170         <div class="footer" >
 171             <div class="right" ><i>Release: 1.15.2</i><br />
 172                 &copy; <a href="../copyright.html">Copyright</a> 1985-2017, MIT.
 173             </div>
 174             <div class="left">
 175
 176         <a href="../index.html" title="Full Table of Contents"
 177             >Contents</a> |
 178         <a href="../mitK5defaults.html" title="MIT Kerberos defaults"
 179             >previous</a> |
 180         <a href="troubleshoot.html" title="Troubleshooting"
 181             >next</a> |
 182         <a href="../genindex.html" title="General Index"
 183             >index</a> |
 184         <a href="../search.html" title="Enter search criteria"
 185             >Search</a> |
 186     <a href="mailto:krb5-bugs@mit.edu?subject=Documentation__Environment variables">feedback</a>
 187             </div>
 188         </div>
 189     </div>
 190
 191   </body>
 192 </html>