<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>docs/config/lua/TlsDomainServer.md - fork/wezterm @ termwiz-0.23.1</title>
<meta name="description" content="docs/config/lua/TlsDomainServer.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:title" content="docs/config/lua/TlsDomainServer.md - fork/wezterm @ termwiz-0.23.1">
<meta property="og:description" content="docs/config/lua/TlsDomainServer.md in fork/wezterm at termwiz-0.23.1.">
<meta property="og:type" content="website">
<meta property="og:site_name" content="git.julia.blue">
<link rel="stylesheet" href="/css/style.css?v=62">
<script type="module" src="/js/main.js?v=62"></script>
</head>
<body>
<main data-ref="termwiz-0.23.1" data-tip="7053748e4d899e7fc5e202d6f903b052fc78e759">
<noscript>
  <div class="callout">
    <p>
      hey! this is a static git repo viewer. commit diffs, file history,
      older commits and other revisions won't load without javascript.
    </p>
    <p>
      you are still able to view source files on branch/tag tips,
      but the experience is degraded.
    </p>
  </div>
</noscript>
<header class="repo"><div>
<h1>fork/wezterm</h1>
</div>
<pre class="clone">git clone https://git.julia.blue/fork/wezterm</pre>
</header>
<p class="snapshot-commit"><span class="commit-author">Wez Furlong</span><span class="commit-message" data-commit="0f8146b2120e2d747575f75831037a978d83435b">docs: shift from return {} style to config.something style</span><span class="snapshot-sha sha" data-commit="0f8146b2120e2d747575f75831037a978d83435b">0f8146b21</span><time datetime="2023-03-19T18:26:21-07:00" title="2023-03-19 18:26:21 -0700">2023-03-19</time></p>
<header class="topbar"><details class="switcher"><summary>termwiz-0.23.1</summary><div class="menu"><strong>branches</strong><a href="/fork/wezterm/ref/main/">main</a><strong>tags</strong><a href="/fork/wezterm/ref/termiz-0.23.1/">termiz-0.23.1</a><a href="/fork/wezterm/ref/termiz-0.23.2/">termiz-0.23.2</a><a href="/fork/wezterm/ref/termiz-0.23.3/">termiz-0.23.3</a><a href="/fork/wezterm/ref/termwiz-0.23.0/">termwiz-0.23.0</a><a class="current" href="/fork/wezterm/ref/termwiz-0.23.1/">termwiz-0.23.1</a><a href="/fork/wezterm/ref/termwiz-0.23.2/">termwiz-0.23.2</a><a href="/fork/wezterm/ref/termwiz-0.23.3/">termwiz-0.23.3</a><a href="/fork/wezterm/ref/vtparse-0.7.0/">vtparse-0.7.0</a><a class="all" href="/fork/wezterm/refs">all refs →</a></div></details><nav class="crumbs"><a href="/fork/wezterm/">wezterm</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/">docs</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/">config</a> / <a href="/fork/wezterm/ref/termwiz-0.23.1/tree/docs/config/lua/">lua</a> / <span class="cur">TlsDomainServer.md</span></nav>
<span class="view-stats"><span>1.3 KiB</span><span>36 lines</span></span><span class="actions"><a class="raw" href="/fork/wezterm/raw/f6f72680fa1a3c8e3f604b6412fb7bc943cf0208/docs/config/lua/TlsDomainServer.md">raw</a></span></header>
<div class="markdown-view"><input type="radio" name="markdown-view" id="markdown-rendered" checked><label for="markdown-rendered">rendered</label><input type="radio" name="markdown-view" id="markdown-code"><label for="markdown-code">code</label><section class="readme rendered"><h1>TlsDomainServer</h1>
<p>The <code>TlsDomainServer</code> struct specifies information about how to define
the server side of a <a href="/fork/wezterm/ref/termwiz-0.23.1/blob/docs/multiplexing.md#tls-domains">TLS Domain</a>.</p>
<p>It is a lua object with the following fields:</p>
<pre class="language-lua"><a-v>config</a-v><a-p>.</a-p><a-v>tls_servers</a-v> = <a-cr>{</a-cr>
  <a-cr>{</a-cr>
    <a-c>-- The address:port combination on which the server will listen</a-c>
    <a-c>-- for client connections</a-c>
    <a-v>bind_address</a-v> = <a-s>&#39;server.hostname:8080&#39;</a-s><a-p>,</a-p>

    <a-c>-- the path to an x509 PEM encoded private key file.</a-c>
    <a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c>
    <a-c>-- pem_private_key = &quot;/path/to/key.pem&quot;,</a-c>

    <a-c>-- the path to an x509 PEM encoded certificate file.</a-c>
    <a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c>
    <a-c>-- pem_cert = &quot;/path/to/cert.pem&quot;,</a-c>

    <a-c>-- the path to an x509 PEM encoded CA chain file.</a-c>
    <a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c>
    <a-c>-- pem_ca = &quot;/path/to/chain.pem&quot;,</a-c>

    <a-c>-- A set of paths to load additional CA certificates.</a-c>
    <a-c>-- Each entry can be either the path to a directory</a-c>
    <a-c>-- or to a PEM encoded CA file.  If an entry is a directory,</a-c>
    <a-c>-- then its contents will be loaded as CA certs and added</a-c>
    <a-c>-- to the trust store.</a-c>
    <a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c>
    <a-c>-- pem_root_certs = { &quot;/some/path/ca1.pem&quot;, &quot;/some/path/ca2.pem&quot; },</a-c>
  <a-cr>}</a-cr><a-p>,</a-p>
<a-cr>}</a-cr></pre>
</section><div class="code-panel"><pre class="code src language-markdown"><span class="code-line"><a class="ln" id="L1" href="#L1">1</a><span class="code-text"><a-p>#</a-p> <a-tt>TlsDomainServer</a-tt></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L2" href="#L2">2</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L3" href="#L3">3</a><span class="code-text">The `TlsDomainServer` struct specifies information about how to define</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L4" href="#L4">4</a><span class="code-text">the server side of a [TLS Domain](../../multiplexing.md#tls-domains).</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L5" href="#L5">5</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L6" href="#L6">6</a><span class="code-text">It is a lua object with the following fields:</span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L7" href="#L7">7</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L8" href="#L8">8</a><span class="code-text"><a-p>```</a-p><a-tl>lua</a-tl></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L9" href="#L9">9</a><span class="code-text"><a-p>config.</a-p><a-v>tls_servers</a-v><a-p> = </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L10" href="#L10">10</a><span class="code-text"><a-p>  </a-p><a-cr>{</a-cr></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L11" href="#L11">11</a><span class="code-text"><a-p>    </a-p><a-c>-- The address:port combination on which the server will listen</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L12" href="#L12">12</a><span class="code-text"><a-p>    </a-p><a-c>-- for client connections</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L13" href="#L13">13</a><span class="code-text"><a-p>    </a-p><a-v>bind_address</a-v><a-p> = </a-p><a-s>&#39;server.hostname:8080&#39;</a-s><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L14" href="#L14">14</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L15" href="#L15">15</a><span class="code-text"><a-p>    </a-p><a-c>-- the path to an x509 PEM encoded private key file.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L16" href="#L16">16</a><span class="code-text"><a-p>    </a-p><a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L17" href="#L17">17</a><span class="code-text"><a-p>    </a-p><a-c>-- pem_private_key = &quot;/path/to/key.pem&quot;,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L18" href="#L18">18</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L19" href="#L19">19</a><span class="code-text"><a-p>    </a-p><a-c>-- the path to an x509 PEM encoded certificate file.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L20" href="#L20">20</a><span class="code-text"><a-p>    </a-p><a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L21" href="#L21">21</a><span class="code-text"><a-p>    </a-p><a-c>-- pem_cert = &quot;/path/to/cert.pem&quot;,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L22" href="#L22">22</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L23" href="#L23">23</a><span class="code-text"><a-p>    </a-p><a-c>-- the path to an x509 PEM encoded CA chain file.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L24" href="#L24">24</a><span class="code-text"><a-p>    </a-p><a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L25" href="#L25">25</a><span class="code-text"><a-p>    </a-p><a-c>-- pem_ca = &quot;/path/to/chain.pem&quot;,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L26" href="#L26">26</a><span class="code-text"></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L27" href="#L27">27</a><span class="code-text"><a-p>    </a-p><a-c>-- A set of paths to load additional CA certificates.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L28" href="#L28">28</a><span class="code-text"><a-p>    </a-p><a-c>-- Each entry can be either the path to a directory</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L29" href="#L29">29</a><span class="code-text"><a-p>    </a-p><a-c>-- or to a PEM encoded CA file.  If an entry is a directory,</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L30" href="#L30">30</a><span class="code-text"><a-p>    </a-p><a-c>-- then its contents will be loaded as CA certs and added</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L31" href="#L31">31</a><span class="code-text"><a-p>    </a-p><a-c>-- to the trust store.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L32" href="#L32">32</a><span class="code-text"><a-p>    </a-p><a-c>-- You can omit this if your tls_client is using bootstrap_via_ssh.</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L33" href="#L33">33</a><span class="code-text"><a-p>    </a-p><a-c>-- pem_root_certs = { &quot;/some/path/ca1.pem&quot;, &quot;/some/path/ca2.pem&quot; },</a-c></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L34" href="#L34">34</a><span class="code-text"><a-p>  </a-p><a-cr>}</a-cr><a-p>,</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L35" href="#L35">35</a><span class="code-text"><a-p>}</a-p></span><span class="code-break">
</span></span><span class="code-line"><a class="ln" id="L36" href="#L36">36</a><span class="code-text"><a-p>```</a-p></span></span></pre></div></div>
</main>
</body>
</html>
