/proc/1387183/root/snap/lxd/35616/share/lxd-documentation/server/ Current File: //proc/1387183/root/snap/lxd/35616/share/lxd-documentation/server/index.html
<!doctype html>
<html class="no-js" lang="en" data-content_root="../">
  <head><meta charset="utf-8"/>
    <meta name="viewport" content="width=device-width,initial-scale=1"/>
    <meta name="color-scheme" content="light dark"><meta name="viewport" content="width=device-width, initial-scale=1" />
<meta property="og:title" content="Server configuration" />
<meta property="og:type" content="website" />
<meta property="og:url" content="https://documentation.ubuntu.com/lxd/latest/server/" />
<meta property="og:site_name" content="LXD documentation" />
<meta property="og:description" content="The LXD server can be configured through a set of key/value configuration options. The key/value configuration is namespaced. The following options are available: Core configuration, ACME configura..." />
<meta property="og:image" content="https://documentation.ubuntu.com/lxd/latest/_static/tag.png" />
<meta property="og:image:alt" content="LXD documentation" />
<meta name="description" content="The LXD server can be configured through a set of key/value configuration options. The key/value configuration is namespaced. The following options are available: Core configuration, ACME configura..." />
<link rel="index" title="Index" href="../genindex/" /><link rel="search" title="Search" href="../search/" /><link rel="next" title="Instance configuration" href="../explanation/instance_config/" /><link rel="prev" title="Index" href="../config-options/" />
        <link rel="canonical" href="https://documentation.ubuntu.com/lxd/server/" />

    <link rel="shortcut icon" href="../_static/favicon.ico"/><!-- Generated with Sphinx 8.2.3 and Furo 2025.07.19 -->
        <title>Server configuration</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=d111a655" />
    <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=25af2a20" />
    <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
    <link rel="stylesheet" type="text/css" href="../_static/youtube.css" />
    <link rel="stylesheet" type="text/css" href="../_static/related-links.css" />
    <link rel="stylesheet" type="text/css" href="../_static/terminal-output.css" />
    <link rel="stylesheet" type="text/css" href="../_static/config-options.css" />
    <link rel="stylesheet" type="text/css" href="../_static/sphinx-design.min.css?v=95c83b7e" />
    <link rel="stylesheet" type="text/css" href="../_static/styles/furo-extensions.css?v=8dab3a3b" />
    <link rel="stylesheet" type="text/css" href="../_static/custom.css?v=66d86e9d" />
    <link rel="stylesheet" type="text/css" href="../_static/header.css?v=84f70f09" />
    <link rel="stylesheet" type="text/css" href="../_static/github_issue_links.css?v=af88fb93" />
    <link rel="stylesheet" type="text/css" href="../_static/furo_colors.css?v=c4ccdb8a" />
    <link rel="stylesheet" type="text/css" href="../_static/footer.css?v=bd05fc90" />
    <link rel="stylesheet" type="text/css" href="../_static/cookie-banner.css?v=b74831ab" />
    
</head>
  <body>
    <header id="header" class="p-navigation">
  <script type="module" src="../_static/js/bundle.js">
  </script>

  <!-- Google Tag Manager -->
  <script>
    (function(w, d, s, l, i) {
      w[l] = w[l] || [];
      w[l].push({
        'gtm.start': new Date().getTime(),
        event: 'gtm.js'
      });
      var f = d.getElementsByTagName(s)[0];
      var j = d.createElement(s);
      var dl = '';
      if (l != 'dataLayer') {
          dl = '&l=' + l;
      }
      j.async = true;
      j.src = 'https://www.googletagmanager.com/gtm.js?id=' + i + dl;
      f.parentNode.insertBefore(j, f);
    })(window, document, 'script', 'dataLayer', 'GTM-KNX3CJC');
  </script>
  
  <div class="p-navigation__nav" role="menubar">

    <ul class="p-navigation__links" role="menu">

      <li>
        <a class="p-logo" href="https://canonical.com/lxd" aria-current="page">
          <img src="../_static/tag.png" alt="Logo" class="p-logo-image">
          <div class="p-logo-text p-heading--4">LXD
          </div>
        </a>
      </li>

      <li class="nav-ubuntu-com">
        <a href="https://canonical.com/lxd" class="p-navigation__link">canonical.com/lxd</a>
      </li>

      <li>
        <a href="#" class="p-navigation__link nav-more-links">More resources</a>
        <ul class="more-links-dropdown">

          <li>
            <a href="https://ubuntu.com/lxd/install/" class="p-navigation__sub-link p-dropdown__link">Install LXD</a>
          </li>

          <li>
            <a href="https://ubuntu.com/lxd/manage/" class="p-navigation__sub-link p-dropdown__link">Manage LXD</a>
          </li>

          <li>
            <a href="https://discourse.ubuntu.com/c/lxd/" class="p-navigation__sub-link p-dropdown__link">Forum</a>
          </li>

          <li>
            <a href="https://github.com/canonical/lxd" class="p-navigation__sub-link p-dropdown__link">GitHub</a>
          </li>

        </ul>
      </li>

    </ul>
  </div>
</header>
   
    <script>
      document.body.dataset.theme = localStorage.getItem("theme") || "auto";
    </script>
    

<svg xmlns="http://www.w3.org/2000/svg" style="display: none;">
  <symbol id="svg-toc" viewBox="0 0 24 24">
    <title>Contents</title>
    <svg stroke="currentColor" fill="currentColor" stroke-width="0" viewBox="0 0 1024 1024">
      <path d="M408 442h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8zm-8 204c0 4.4 3.6 8 8 8h480c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8H408c-4.4 0-8 3.6-8 8v56zm504-486H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zm0 632H120c-4.4 0-8 3.6-8 8v56c0 4.4 3.6 8 8 8h784c4.4 0 8-3.6 8-8v-56c0-4.4-3.6-8-8-8zM115.4 518.9L271.7 642c5.8 4.6 14.4.5 14.4-6.9V388.9c0-7.4-8.5-11.5-14.4-6.9L115.4 505.1a8.74 8.74 0 0 0 0 13.8z"/>
    </svg>
  </symbol>
  <symbol id="svg-menu" viewBox="0 0 24 24">
    <title>Menu</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-menu">
      <line x1="3" y1="12" x2="21" y2="12"></line>
      <line x1="3" y1="6" x2="21" y2="6"></line>
      <line x1="3" y1="18" x2="21" y2="18"></line>
    </svg>
  </symbol>
  <symbol id="svg-arrow-right" viewBox="0 0 24 24">
    <title>Expand</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather-chevron-right">
      <polyline points="9 18 15 12 9 6"></polyline>
    </svg>
  </symbol>
  <symbol id="svg-sun" viewBox="0 0 24 24">
    <title>Light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="feather-sun">
      <circle cx="12" cy="12" r="5"></circle>
      <line x1="12" y1="1" x2="12" y2="3"></line>
      <line x1="12" y1="21" x2="12" y2="23"></line>
      <line x1="4.22" y1="4.22" x2="5.64" y2="5.64"></line>
      <line x1="18.36" y1="18.36" x2="19.78" y2="19.78"></line>
      <line x1="1" y1="12" x2="3" y2="12"></line>
      <line x1="21" y1="12" x2="23" y2="12"></line>
      <line x1="4.22" y1="19.78" x2="5.64" y2="18.36"></line>
      <line x1="18.36" y1="5.64" x2="19.78" y2="4.22"></line>
    </svg>
  </symbol>
  <symbol id="svg-moon" viewBox="0 0 24 24">
    <title>Dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-moon">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M12 3c.132 0 .263 0 .393 0a7.5 7.5 0 0 0 7.92 12.446a9 9 0 1 1 -8.313 -12.454z" />
    </svg>
  </symbol>
  <symbol id="svg-sun-with-moon" viewBox="0 0 24 24">
    <title>Auto light/dark, in light mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path style="opacity: 50%" d="M 5.411 14.504 C 5.471 14.504 5.532 14.504 5.591 14.504 C 3.639 16.319 4.383 19.569 6.931 20.352 C 7.693 20.586 8.512 20.551 9.25 20.252 C 8.023 23.207 4.056 23.725 2.11 21.184 C 0.166 18.642 1.702 14.949 4.874 14.536 C 5.051 14.512 5.231 14.5 5.411 14.5 L 5.411 14.504 Z"/>
      <line x1="14.5" y1="3.25" x2="14.5" y2="1.25"/>
      <line x1="14.5" y1="15.85" x2="14.5" y2="17.85"/>
      <line x1="10.044" y1="5.094" x2="8.63" y2="3.68"/>
      <line x1="19" y1="14.05" x2="20.414" y2="15.464"/>
      <line x1="8.2" y1="9.55" x2="6.2" y2="9.55"/>
      <line x1="20.8" y1="9.55" x2="22.8" y2="9.55"/>
      <line x1="10.044" y1="14.006" x2="8.63" y2="15.42"/>
      <line x1="19" y1="5.05" x2="20.414" y2="3.636"/>
      <circle cx="14.5" cy="9.55" r="3.6"/>
    </svg>
  </symbol>
  <symbol id="svg-moon-with-sun" viewBox="0 0 24 24">
    <title>Auto light/dark, in dark mode</title>
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round"
      class="icon-custom-derived-from-feather-sun-and-tabler-moon">
      <path d="M 8.282 7.007 C 8.385 7.007 8.494 7.007 8.595 7.007 C 5.18 10.184 6.481 15.869 10.942 17.24 C 12.275 17.648 13.706 17.589 15 17.066 C 12.851 22.236 5.91 23.143 2.505 18.696 C -0.897 14.249 1.791 7.786 7.342 7.063 C 7.652 7.021 7.965 7 8.282 7 L 8.282 7.007 Z"/>
      <line style="opacity: 50%" x1="18" y1="3.705" x2="18" y2="2.5"/>
      <line style="opacity: 50%" x1="18" y1="11.295" x2="18" y2="12.5"/>
      <line style="opacity: 50%" x1="15.316" y1="4.816" x2="14.464" y2="3.964"/>
      <line style="opacity: 50%" x1="20.711" y1="10.212" x2="21.563" y2="11.063"/>
      <line style="opacity: 50%" x1="14.205" y1="7.5" x2="13.001" y2="7.5"/>
      <line style="opacity: 50%" x1="21.795" y1="7.5" x2="23" y2="7.5"/>
      <line style="opacity: 50%" x1="15.316" y1="10.184" x2="14.464" y2="11.036"/>
      <line style="opacity: 50%" x1="20.711" y1="4.789" x2="21.563" y2="3.937"/>
      <circle style="opacity: 50%" cx="18" cy="7.5" r="2.169"/>
    </svg>
  </symbol>
  <symbol id="svg-pencil" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-pencil-code">
      <path d="M4 20h4l10.5 -10.5a2.828 2.828 0 1 0 -4 -4l-10.5 10.5v4" />
      <path d="M13.5 6.5l4 4" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
  <symbol id="svg-eye" viewBox="0 0 24 24">
    <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor"
      stroke-width="1" stroke-linecap="round" stroke-linejoin="round" class="icon-tabler-eye-code">
      <path stroke="none" d="M0 0h24v24H0z" fill="none" />
      <path d="M10 12a2 2 0 1 0 4 0a2 2 0 0 0 -4 0" />
      <path
        d="M11.11 17.958c-3.209 -.307 -5.91 -2.293 -8.11 -5.958c2.4 -4 5.4 -6 9 -6c3.6 0 6.6 2 9 6c-.21 .352 -.427 .688 -.647 1.008" />
      <path d="M20 21l2 -2l-2 -2" />
      <path d="M17 17l-2 2l2 2" />
    </svg>
  </symbol>
</svg>

<input type="checkbox" class="sidebar-toggle" name="__navigation" id="__navigation">
<input type="checkbox" class="sidebar-toggle" name="__toc" id="__toc">
<label class="overlay sidebar-overlay" for="__navigation">
  <div class="visually-hidden">Hide navigation sidebar</div>
</label>
<label class="overlay toc-overlay" for="__toc">
  <div class="visually-hidden">Hide table of contents sidebar</div>
</label>

<a class="skip-to-content muted-link" href="#furo-main-content">Skip to content</a>



<div class="page">
  <header class="mobile-header">
    <div class="header-left">
      <label class="nav-overlay-icon" for="__navigation">
        <div class="visually-hidden">Toggle site navigation sidebar</div>
        <i class="icon"><svg><use href="#svg-menu"></use></svg></i>
      </label>
    </div>
    <div class="header-center">
      <a href="../"><div class="brand">LXD</div></a>
    </div>
    <div class="header-right">
      <div class="theme-toggle-container theme-toggle-header">
        <button class="theme-toggle">
          <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
          <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
          <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
          <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
          <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
        </button>
      </div>
      <label class="toc-overlay-icon toc-header-icon" for="__toc">
        <div class="visually-hidden">Toggle table of contents sidebar</div>
        <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
      </label>
    </div>
  </header>
  <aside class="sidebar-drawer">
    <div class="sidebar-container">
      
      <div class="sidebar-sticky"><a class="sidebar-brand" href="../">
  
  
</a><form class="sidebar-search-container" method="get" action="../search/" role="search">
    <input class="sidebar-search" placeholder="Search" name="q" aria-label="Search">
    <input type="submit" value="Go">
    <input type="hidden" name="check_keywords" value="yes">
    <input type="hidden" name="area" value="default">
  </form>
  <div id="searchbox"></div><div class="sidebar-scroll"><div class="sidebar-tree">
  <ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../">LXD</a></li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../tutorial/">Tutorials</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" role="switch" type="checkbox"/><label for="toctree-checkbox-1"><div class="visually-hidden">Toggle navigation of Tutorials</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/first_steps/">First steps with LXD</a></li>
<li class="toctree-l2"><a class="reference internal" href="../tutorial/ui/">Getting started with the UI</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../howto/">How-to guides</a><input class="toctree-checkbox" id="toctree-checkbox-2" name="toctree-checkbox-2" role="switch" type="checkbox"/><label for="toctree-checkbox-2"><div class="visually-hidden">Toggle navigation of How-to guides</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2 has-children"><a class="reference internal" href="../getting_started/">Getting started</a><input class="toctree-checkbox" id="toctree-checkbox-3" name="toctree-checkbox-3" role="switch" type="checkbox"/><label for="toctree-checkbox-3"><div class="visually-hidden">Toggle navigation of Getting started</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../installing/">Install LXD</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/initialize/">Initialize LXD</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/access_ui/">Access the UI</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/access_documentation/">Access documentation locally</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../operation/">LXD server and client</a><input class="toctree-checkbox" id="toctree-checkbox-4" name="toctree-checkbox-4" role="switch" type="checkbox"/><label for="toctree-checkbox-4"><div class="visually-hidden">Toggle navigation of LXD server and client</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/server_expose/">Expose LXD to the network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/server_configure/">Configure the LXD server</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/oidc_auth0/">Configure OIDC authentication with Auth0</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/oidc_ory/">Configure OIDC authentication with Ory Hydra</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/oidc_keycloak/">Configure OIDC authentication with Keycloak</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/oidc_entra_id/">Configure OIDC authentication with Microsoft Entra ID</a></li>
<li class="toctree-l3"><a class="reference internal" href="../remotes/">Add remote servers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/lxc_alias/">Add command aliases</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../instances/">Instances</a><input class="toctree-checkbox" id="toctree-checkbox-5" name="toctree-checkbox-5" role="switch" type="checkbox"/><label for="toctree-checkbox-5"><div class="visually-hidden">Toggle navigation of Instances</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_create/">Create instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_configure/">Configure instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_manage/">Manage instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../profiles/">Use profiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_troubleshoot/">Troubleshoot errors</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_ubuntu_pro_attach/">Auto attach Ubuntu Pro</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_access_files/">Access files</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_console/">Access the console</a></li>
<li class="toctree-l3"><a class="reference internal" href="../instance-exec/">Run commands</a></li>
<li class="toctree-l3"><a class="reference internal" href="../cloud-init/">Use cloud-init</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_routed_nic_vm/">Add a routed NIC to a VM</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_backup/">Back up instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_migrate/">Migrate instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/import_machines_to_instances/">Import existing machines</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/container_gpu_passthrough_with_docker/">Pass NVIDIA GPUs</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../images/">Images</a><input class="toctree-checkbox" id="toctree-checkbox-6" name="toctree-checkbox-6" role="switch" type="checkbox"/><label for="toctree-checkbox-6"><div class="visually-hidden">Toggle navigation of Images</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_remote/">Use remote images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_manage/">Manage images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_profiles/">Associate profiles</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_copy/">Copy and import images</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/images_create/">Create images</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../projects/">Projects</a><input class="toctree-checkbox" id="toctree-checkbox-7" name="toctree-checkbox-7" role="switch" type="checkbox"/><label for="toctree-checkbox-7"><div class="visually-hidden">Toggle navigation of Projects</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/projects_create/">Create and configure</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/projects_work/">Work with projects</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/projects_confine/">Confine users to projects</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../storage/">Storage</a><input class="toctree-checkbox" id="toctree-checkbox-8" name="toctree-checkbox-8" role="switch" type="checkbox"/><label for="toctree-checkbox-8"><div class="visually-hidden">Toggle navigation of Storage</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_pools/">Manage pools</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_volumes/">Manage volumes</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_buckets/">Manage buckets</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_create_instance/">Create an instance in a pool</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_backup_volume/">Back up a volume</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/storage_move_volume/">Move or copy a volume</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../networks/">Networking</a><input class="toctree-checkbox" id="toctree-checkbox-9" name="toctree-checkbox-9" role="switch" type="checkbox"/><label for="toctree-checkbox-9"><div class="visually-hidden">Toggle navigation of Networking</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_create/">Create a network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_configure/">Configure a network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bgp/">Configure as BGP server</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_acls/">Configure network ACLs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_forwards/">Configure forwards</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_zones/">Configure network zones</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_firewalld/">Configure your firewall</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_resolved/">Integrate with resolved</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_ovn_setup/">Set up OVN</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_load_balancers/">Configure load balancers</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_ovn_peers/">Configure peer routing</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_ipam/">Display IPAM information</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../clustering/">Clustering</a><input class="toctree-checkbox" id="toctree-checkbox-10" name="toctree-checkbox-10" role="switch" type="checkbox"/><label for="toctree-checkbox-10"><div class="visually-hidden">Toggle navigation of Clustering</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_form/">Form a cluster</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_manage/">Manage a cluster</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_config_networks/">Configure networks</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_config_storage/">Configure storage</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_manage_instance/">Manage instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_groups/">Set up cluster groups</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/cluster_recover/">Recover a cluster</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../production-setup/">Production setup</a><input class="toctree-checkbox" id="toctree-checkbox-11" name="toctree-checkbox-11" role="switch" type="checkbox"/><label for="toctree-checkbox-11"><div class="visually-hidden">Toggle navigation of Production setup</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/benchmark_performance/">Benchmark performance</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_increase_bandwidth/">Increase bandwidth</a></li>
<li class="toctree-l3"><a class="reference internal" href="../metrics/">Monitor metrics</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/logs_loki/">Send logs to Loki</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/grafana/">Set up Grafana</a></li>
<li class="toctree-l3"><a class="reference internal" href="../backup/">Back up a server</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/disaster_recovery/">Recover instances</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../howto/snap/">Manage the snap</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../howto/troubleshoot/">Troubleshooting</a><input class="toctree-checkbox" id="toctree-checkbox-12" name="toctree-checkbox-12" role="switch" type="checkbox"/><label for="toctree-checkbox-12"><div class="visually-hidden">Toggle navigation of Troubleshooting</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../howto/network_bridge_firewalld/">Configure your firewall</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/instances_troubleshoot/">Troubleshoot instances</a></li>
<li class="toctree-l3"><a class="reference internal" href="../howto/dqlite_troubleshoot/">Troubleshoot Dqlite</a></li>
<li class="toctree-l3"><a class="reference internal" href="../debugging/">Debug LXD</a></li>
<li class="toctree-l3"><a class="reference internal" href="../faq/">Frequently asked</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../support/">Get support</a></li>
<li class="toctree-l2"><a class="reference internal" href="../contributing/">Contribute to LXD</a></li>
</ul>
</li>
<li class="toctree-l1 has-children"><a class="reference internal" href="../explanation/">Explanation</a><input class="toctree-checkbox" id="toctree-checkbox-13" name="toctree-checkbox-13" role="switch" type="checkbox"/><label for="toctree-checkbox-13"><div class="visually-hidden">Toggle navigation of Explanation</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../explanation/lxd_lxc/"><code class="docutils literal notranslate"><span class="pre">lxd</span></code> and <code class="docutils literal notranslate"><span class="pre">lxc</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/instances/">Containers and VMs</a></li>
<li class="toctree-l2"><a class="reference internal" href="../image-handling/">Local and remote images</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/storage/">Storage pools, volumes, and buckets</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/networks/">Networking setups</a></li>
<li class="toctree-l2"><a class="reference internal" href="../database/">The LXD Dqlite database</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/lxc_show_info/"><code class="docutils literal notranslate"><span class="pre">lxc</span></code> <code class="docutils literal notranslate"><span class="pre">show</span></code> and <code class="docutils literal notranslate"><span class="pre">info</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../authentication/">Remote API authentication</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/authorization/">Remote API authorization</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/projects/">Instances grouping with projects</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/clusters/">Clusters</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/performance_tuning/">Performance tuning</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/security/">Security</a></li>
<li class="toctree-l2"><a class="reference internal" href="../explanation/bpf/">Privilege delegation using BPF Token</a></li>
</ul>
</li>
<li class="toctree-l1 current has-children"><a class="reference internal" href="../reference/">Reference</a><input checked="" class="toctree-checkbox" id="toctree-checkbox-14" name="toctree-checkbox-14" role="switch" type="checkbox"/><label for="toctree-checkbox-14"><div class="visually-hidden">Toggle navigation of Reference</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="../requirements/">Requirements</a></li>
<li class="toctree-l2"><a class="reference internal" href="../architectures/">Architectures</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/releases-snap/">Releases and snap</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/remote_image_servers/">Remote image servers</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/image_format/">Image format</a></li>
<li class="toctree-l2"><a class="reference internal" href="../guest-os-compatibility/">Guest OS compatibility</a></li>
<li class="toctree-l2"><a class="reference internal" href="../container-environment/">Container environment</a></li>
<li class="toctree-l2"><a class="reference internal" href="../config-options/">Configuration option index</a></li>
<li class="toctree-l2 current current-page"><a class="current reference internal" href="#">Server configuration</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../explanation/instance_config/">Instance configuration</a><input class="toctree-checkbox" id="toctree-checkbox-15" name="toctree-checkbox-15" role="switch" type="checkbox"/><label for="toctree-checkbox-15"><div class="visually-hidden">Toggle navigation of Instance configuration</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/instance_properties/">Instance properties</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/instance_options/">Instance options</a></li>
<li class="toctree-l3 has-children"><a class="reference internal" href="../reference/devices/">Devices</a><input class="toctree-checkbox" id="toctree-checkbox-16" name="toctree-checkbox-16" role="switch" type="checkbox"/><label for="toctree-checkbox-16"><div class="visually-hidden">Toggle navigation of Devices</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l4"><a class="reference internal" href="../reference/standard_devices/">Standard devices</a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_none/">Type: <code class="docutils literal notranslate"><span class="pre">none</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_nic/">Type: <code class="docutils literal notranslate"><span class="pre">nic</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_disk/">Type: <code class="docutils literal notranslate"><span class="pre">disk</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_char/">Type: <code class="docutils literal notranslate"><span class="pre">unix-char</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_block/">Type: <code class="docutils literal notranslate"><span class="pre">unix-block</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_usb/">Type: <code class="docutils literal notranslate"><span class="pre">usb</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_gpu/">Type: <code class="docutils literal notranslate"><span class="pre">gpu</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_infiniband/">Type: <code class="docutils literal notranslate"><span class="pre">infiniband</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_proxy/">Type: <code class="docutils literal notranslate"><span class="pre">proxy</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_unix_hotplug/">Type: <code class="docutils literal notranslate"><span class="pre">unix-hotplug</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_tpm/">Type: <code class="docutils literal notranslate"><span class="pre">tpm</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="../reference/devices_pci/">Type: <code class="docutils literal notranslate"><span class="pre">pci</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="../reference/instance_units/">Units for storage and network limits</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/preseed_yaml_fields/">Preseed YAML file fields</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/projects/">Project configuration</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/storage_drivers/">Storage drivers</a><input class="toctree-checkbox" id="toctree-checkbox-17" name="toctree-checkbox-17" role="switch" type="checkbox"/><label for="toctree-checkbox-17"><div class="visually-hidden">Toggle navigation of Storage drivers</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_btrfs/">Btrfs - <code class="docutils literal notranslate"><span class="pre">btrfs</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_cephfs/">CephFS - <code class="docutils literal notranslate"><span class="pre">cephfs</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_cephobject/">Ceph Object - <code class="docutils literal notranslate"><span class="pre">cephobject</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_ceph/">Ceph RBD - <code class="docutils literal notranslate"><span class="pre">ceph</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_powerflex/">Dell PowerFlex - <code class="docutils literal notranslate"><span class="pre">powerflex</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_pure/">Pure Storage - <code class="docutils literal notranslate"><span class="pre">pure</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_dir/">Directory - <code class="docutils literal notranslate"><span class="pre">dir</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_lvm/">LVM - <code class="docutils literal notranslate"><span class="pre">lvm</span></code></a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/storage_zfs/">ZFS - <code class="docutils literal notranslate"><span class="pre">zfs</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/networks/">Networks</a><input class="toctree-checkbox" id="toctree-checkbox-18" name="toctree-checkbox-18" role="switch" type="checkbox"/><label for="toctree-checkbox-18"><div class="visually-hidden">Toggle navigation of Networks</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_bridge/">Bridge network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_ovn/">OVN network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_macvlan/">Macvlan network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_physical/">Physical network</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/network_sriov/">SR-IOV network</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="../reference/cluster_member_config/">Cluster configuration</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/server_settings/">Production server settings</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/provided_metrics/">Provided metrics</a></li>
<li class="toctree-l2"><a class="reference internal" href="../reference/permissions/">Permissions</a></li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../restapi_landing/">REST API</a><input class="toctree-checkbox" id="toctree-checkbox-19" name="toctree-checkbox-19" role="switch" type="checkbox"/><label for="toctree-checkbox-19"><div class="visually-hidden">Toggle navigation of REST API</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../rest-api/">Main API documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../api/">Main API specification</a></li>
<li class="toctree-l3"><a class="reference internal" href="../api-extensions/">Main API extensions</a></li>
<li class="toctree-l3"><a class="reference internal" href="../events/">Events API documentation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../dev-lxd/">Instance API</a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../reference/manpages/">Man pages</a><input class="toctree-checkbox" id="toctree-checkbox-20" name="toctree-checkbox-20" role="switch" type="checkbox"/><label for="toctree-checkbox-20"><div class="visually-hidden">Toggle navigation of Man pages</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../reference/manpages/lxc/"><code class="docutils literal notranslate"><span class="pre">lxc</span></code></a></li>
</ul>
</li>
<li class="toctree-l2 has-children"><a class="reference internal" href="../internals/">Internals</a><input class="toctree-checkbox" id="toctree-checkbox-21" name="toctree-checkbox-21" role="switch" type="checkbox"/><label for="toctree-checkbox-21"><div class="visually-hidden">Toggle navigation of Internals</div><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></label><ul>
<li class="toctree-l3"><a class="reference internal" href="../environment/">Environment variables</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/uefi_variables/">UEFI variables for VMs</a></li>
<li class="toctree-l3"><a class="reference internal" href="../daemon-behavior/">Daemon behavior</a></li>
<li class="toctree-l3"><a class="reference internal" href="../syscall-interception/">System call interception</a></li>
<li class="toctree-l3"><a class="reference internal" href="../userns-idmap/">User namespace setup</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/ovn-internals/">OVN implementation</a></li>
<li class="toctree-l3"><a class="reference internal" href="../reference/vm_live_migration_internals/">VM live migration implementation</a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference external" href="https://github.com/canonical/lxd">Project repository</a></li>
<li class="toctree-l2"><a class="reference external" href="https://images.lxd.canonical.com">Image server</a></li>
</ul>
</li>
</ul>

</div>
</div>

      </div>
      
    </div>
  </aside>
  <div class="main">
    <div class="content">
      <div class="article-container">
        <a href="#" class="back-to-top muted-link">
          <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24">
            <path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12z"></path>
          </svg>
          <span>Back to top</span>
        </a>
        <div class="content-icon-container">
          <div class="view-this-page">
  <a class="muted-link" href="../_sources/server.md.txt" title="View this page">
    <svg><use href="#svg-eye"></use></svg>
    <span class="visually-hidden">View this page</span>
  </a>
</div>
<div class="theme-toggle-container theme-toggle-content">
            <button class="theme-toggle">
              <div class="visually-hidden">Toggle Light / Dark / Auto color theme</div>
              <svg class="theme-icon-when-auto-light"><use href="#svg-sun-with-moon"></use></svg>
              <svg class="theme-icon-when-auto-dark"><use href="#svg-moon-with-sun"></use></svg>
              <svg class="theme-icon-when-dark"><use href="#svg-moon"></use></svg>
              <svg class="theme-icon-when-light"><use href="#svg-sun"></use></svg>
            </button>
          </div>
          <label class="toc-overlay-icon toc-content-icon" for="__toc">
            <div class="visually-hidden">Toggle table of contents sidebar</div>
            <i class="icon"><svg><use href="#svg-toc"></use></svg></i>
          </label>
        </div>
        <article role="main" id="furo-main-content">
          <section id="server-configuration">
<span id="server"></span><h1>Server configuration<a class="headerlink" href="#server-configuration" title="Link to this heading">¶</a></h1>
<p>The LXD server can be configured through a set of key/value configuration options.</p>
<p>The key/value configuration is namespaced.
The following options are available:</p>
<ul class="simple">
<li><p><a class="reference internal" href="#server-options-core"><span class="std std-ref">Core configuration</span></a></p></li>
<li><p><a class="reference internal" href="#server-options-acme"><span class="std std-ref">ACME configuration</span></a></p></li>
<li><p><a class="reference internal" href="#server-options-oidc"><span class="std std-ref">OpenID Connect configuration</span></a></p></li>
<li><p><a class="reference internal" href="#server-options-cluster"><span class="std std-ref">Cluster configuration</span></a></p></li>
<li><p><a class="reference internal" href="#server-options-images"><span class="std std-ref">Images configuration</span></a></p></li>
<li><p><a class="reference internal" href="#server-options-loki"><span class="std std-ref">Loki configuration</span></a></p></li>
<li><p><a class="reference internal" href="#server-options-misc"><span class="std std-ref">Miscellaneous options</span></a></p></li>
</ul>
<p>See <a class="reference internal" href="../howto/server_configure/#server-configure"><span class="std std-ref">How to configure the LXD server</span></a> for instructions on how to set the configuration options.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Options marked with a <code class="docutils literal notranslate"><span class="pre">global</span></code> scope are immediately applied to all cluster members.
Options with a <code class="docutils literal notranslate"><span class="pre">local</span></code> scope must be set on a per-member basis.</p>
</div>
<section id="core-configuration">
<span id="server-options-core"></span><h2>Core configuration<a class="headerlink" href="#core-configuration" title="Link to this heading">¶</a></h2>
<p>The following server options control the core daemon configuration:</p>
<div class="configoption docutils container" id="server-core:core.bgp_address">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.bgp_address</span></code></span><span class="shortdesc"><p>Address to bind the BGP server to</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.bgp_address"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.bgp_address</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>See <a class="reference internal" href="../howto/network_bgp/#network-bgp"><span class="std std-ref">How to configure LXD as a BGP server</span></a>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.bgp_asn">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.bgp_asn</span></code></span><span class="shortdesc"><p>BGP Autonomous System Number for the local server</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.bgp_asn"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.bgp_asn</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.bgp_routerid">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.bgp_routerid</span></code></span><span class="shortdesc"><p>A unique identifier for the BGP server</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.bgp_routerid"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.bgp_routerid</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>The identifier must be formatted as an IPv4 address.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.debug_address">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.debug_address</span></code></span><span class="shortdesc"><p>Address to bind the <a class="reference external" href="https://pkg.go.dev/net/http/pprof"><code class="docutils literal notranslate"><span class="pre">pprof</span></code></a> debug server to (HTTP)</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.debug_address"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.debug_address</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.dns_address">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.dns_address</span></code></span><span class="shortdesc"><p>Address to bind the authoritative DNS server to</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.dns_address"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.dns_address</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>See <a class="reference internal" href="../howto/network_zones/#network-dns-server"><span class="std std-ref">Enable the built-in DNS server</span></a>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.https_address">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.https_address</span></code></span><span class="shortdesc"><p>Address to bind for the remote API (HTTPS)</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.https_address"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.https_address</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>See <a class="reference internal" href="../howto/server_expose/#server-expose"><span class="std std-ref">How to expose LXD to the network</span></a>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.https_allowed_credentials">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.https_allowed_credentials</span></code></span><span class="shortdesc"><p>Whether to set <code class="docutils literal notranslate"><span class="pre">Access-Control-Allow-Credentials</span></code></p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.https_allowed_credentials"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.https_allowed_credentials</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>bool</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>If enabled, the <code class="docutils literal notranslate"><span class="pre">Access-Control-Allow-Credentials</span></code> HTTP header value is set to <code class="docutils literal notranslate"><span class="pre">true</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.https_allowed_headers">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.https_allowed_headers</span></code></span><span class="shortdesc"><p><code class="docutils literal notranslate"><span class="pre">Access-Control-Allow-Headers</span></code> HTTP header value</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.https_allowed_headers"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.https_allowed_headers</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.https_allowed_methods">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.https_allowed_methods</span></code></span><span class="shortdesc"><p><code class="docutils literal notranslate"><span class="pre">Access-Control-Allow-Methods</span></code> HTTP header value</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.https_allowed_methods"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.https_allowed_methods</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.https_allowed_origin">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.https_allowed_origin</span></code></span><span class="shortdesc"><p><code class="docutils literal notranslate"><span class="pre">Access-Control-Allow-Origin</span></code> HTTP header value</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.https_allowed_origin"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.https_allowed_origin</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.https_trusted_proxy">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.https_trusted_proxy</span></code></span><span class="shortdesc"><p>Trusted servers to provide the client’s address</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.https_trusted_proxy"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.https_trusted_proxy</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify a comma-separated list of IP addresses of trusted servers that provide the client’s address through the proxy connection header.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.metrics_address">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.metrics_address</span></code></span><span class="shortdesc"><p>Address to bind the metrics server to (HTTPS)</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.metrics_address"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.metrics_address</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>See <a class="reference internal" href="../metrics/#metrics"><span class="std std-ref">How to monitor metrics</span></a>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.metrics_authentication">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.metrics_authentication</span></code></span><span class="shortdesc"><p>Whether to enforce authentication on the metrics endpoint</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.metrics_authentication"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.metrics_authentication</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>bool</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.proxy_http">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.proxy_http</span></code></span><span class="shortdesc"><p>HTTP proxy to use</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.proxy_http"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.proxy_http</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>If this option is not specified, LXD falls back to the <code class="docutils literal notranslate"><span class="pre">HTTP_PROXY</span></code> environment variable (if set).</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.proxy_https">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.proxy_https</span></code></span><span class="shortdesc"><p>HTTPS proxy to use</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.proxy_https"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.proxy_https</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>If this option is not specified, LXD falls back to the <code class="docutils literal notranslate"><span class="pre">HTTPS_PROXY</span></code> environment variable (if set).</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.proxy_ignore_hosts">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.proxy_ignore_hosts</span></code></span><span class="shortdesc"><p>Hosts that don’t need the proxy</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.proxy_ignore_hosts"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.proxy_ignore_hosts</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify this option in a similar format to <code class="docutils literal notranslate"><span class="pre">NO_PROXY</span></code> (for example, <code class="docutils literal notranslate"><span class="pre">1.2.3.4,1.2.3.5</span></code>)</p>
<p>If this option is not specified, LXD falls back to the <code class="docutils literal notranslate"><span class="pre">NO_PROXY</span></code> environment variable (if set).</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.remote_token_expiry">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.remote_token_expiry</span></code></span><span class="shortdesc"><p>Time after which a remote add token expires</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.remote_token_expiry"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.remote_token_expiry</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p>no expiry</p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.shutdown_timeout">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.shutdown_timeout</span></code></span><span class="shortdesc"><p>How long to wait before shutdown</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.shutdown_timeout"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.shutdown_timeout</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">5</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the number of minutes to wait for running operations to complete before the LXD server shuts down.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.storage_buckets_address">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.storage_buckets_address</span></code></span><span class="shortdesc"><p>Address to bind the storage object server to (HTTPS)</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.storage_buckets_address"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.storage_buckets_address</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>See <a class="reference internal" href="../howto/storage_buckets/#howto-storage-buckets"><span class="std std-ref">How to manage storage buckets</span></a>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.syslog_socket">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.syslog_socket</span></code></span><span class="shortdesc"><p>Whether to enable the syslog unixgram socket listener</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.syslog_socket"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.syslog_socket</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>bool</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Set this option to <code class="docutils literal notranslate"><span class="pre">true</span></code> to enable the syslog unixgram socket to receive log messages from external processes.</p>
</div>
</div>
<div class="configoption docutils container" id="server-core:core.trust_ca_certificates">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">core.trust_ca_certificates</span></code></span><span class="shortdesc"><p>Whether to automatically trust clients signed by the CA</p>
</span><span class="anchor"><a class="reference external" href="#server-core:core.trust_ca_certificates"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">core.trust_ca_certificates</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>bool</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</section>
<section id="acme-configuration">
<span id="server-options-acme"></span><h2>ACME configuration<a class="headerlink" href="#acme-configuration" title="Link to this heading">¶</a></h2>
<p>The following server options control the <a class="reference internal" href="../authentication/#authentication-server-certificate"><span class="std std-ref">ACME</span></a> configuration:</p>
<div class="configoption docutils container" id="server-acme:acme.agree_tos">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">acme.agree_tos</span></code></span><span class="shortdesc"><p>Agree to ACME terms of service</p>
</span><span class="anchor"><a class="reference external" href="#server-acme:acme.agree_tos"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">acme.agree_tos</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>bool</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">false</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-acme:acme.ca_url">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">acme.ca_url</span></code></span><span class="shortdesc"><p>URL to the directory resource of the ACME service</p>
</span><span class="anchor"><a class="reference external" href="#server-acme:acme.ca_url"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">acme.ca_url</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">https://acme-v02.api.letsencrypt.org/directory</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-acme:acme.domain">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">acme.domain</span></code></span><span class="shortdesc"><p>Domain for which the certificate is issued</p>
</span><span class="anchor"><a class="reference external" href="#server-acme:acme.domain"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">acme.domain</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-acme:acme.email">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">acme.email</span></code></span><span class="shortdesc"><p>Email address used for the account registration</p>
</span><span class="anchor"><a class="reference external" href="#server-acme:acme.email"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">acme.email</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</section>
<section id="openid-connect-configuration">
<span id="server-options-oidc"></span><h2>OpenID Connect configuration<a class="headerlink" href="#openid-connect-configuration" title="Link to this heading">¶</a></h2>
<p>The following server options configure external user authentication through <a class="reference internal" href="../authentication/#authentication-openid"><span class="std std-ref">OpenID Connect authentication</span></a>:</p>
<div class="configoption docutils container" id="server-oidc:oidc.audience">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">oidc.audience</span></code></span><span class="shortdesc"><p>Expected audience value for the application</p>
</span><span class="anchor"><a class="reference external" href="#server-oidc:oidc.audience"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">oidc.audience</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>This value is required by some providers.</p>
</div>
</div>
<div class="configoption docutils container" id="server-oidc:oidc.client.id">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">oidc.client.id</span></code></span><span class="shortdesc"><p>OpenID Connect client ID</p>
</span><span class="anchor"><a class="reference external" href="#server-oidc:oidc.client.id"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">oidc.client.id</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-oidc:oidc.client.secret">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">oidc.client.secret</span></code></span><span class="shortdesc"><p>OpenID Connect client secret</p>
</span><span class="anchor"><a class="reference external" href="#server-oidc:oidc.client.secret"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">oidc.client.secret</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-oidc:oidc.groups.claim">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">oidc.groups.claim</span></code></span><span class="shortdesc"><p>A claim used for mapping identity provider groups to LXD groups.</p>
</span><span class="anchor"><a class="reference external" href="#server-oidc:oidc.groups.claim"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">oidc.groups.claim</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify a custom token claim to denote groups defined at the identity provider.
The contents of this claim can be mapped to LXD groups for managing access control.
The value of the claim is expected to be a JSON string array.</p>
</div>
</div>
<div class="configoption docutils container" id="server-oidc:oidc.issuer">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">oidc.issuer</span></code></span><span class="shortdesc"><p>OpenID Connect Discovery URL for the provider</p>
</span><span class="anchor"><a class="reference external" href="#server-oidc:oidc.issuer"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">oidc.issuer</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-oidc:oidc.scopes">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">oidc.scopes</span></code></span><span class="shortdesc"><p>Space-separated list of OpenID Connect scopes</p>
</span><span class="anchor"><a class="reference external" href="#server-oidc:oidc.scopes"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">oidc.scopes</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>space-delimited string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>A list of OpenID Connect scopes to request from the identity provider.
This must include the <code class="docutils literal notranslate"><span class="pre">openid</span></code> and <code class="docutils literal notranslate"><span class="pre">email</span></code> scopes.
The remaining optional scopes are <code class="docutils literal notranslate"><span class="pre">offline_access</span></code> and <code class="docutils literal notranslate"><span class="pre">profile</span></code>.
If you remove the <code class="docutils literal notranslate"><span class="pre">offline_access</span></code> scope, users might be required to log in more frequently.
If you remove the <code class="docutils literal notranslate"><span class="pre">profile</span></code> scope, user information may not be displayed in LXD UI (or in <code class="docutils literal notranslate"><span class="pre">lxc</span> <span class="pre">auth</span> <span class="pre">identity</span></code> commands).
You may add additional scopes if this is required by your identity provider, or if necessary for configuration of <a class="reference internal" href="../explanation/authorization/#identity-provider-groups"><span class="std std-ref">identity provider groups</span></a>.</p>
</div>
</div>
<div class="admonition important">
<p class="admonition-title">Important</p>
<p>Setting <code class="docutils literal notranslate"><span class="pre">oidc.client.secret</span></code> may prevent CLI clients from authenticating depending on the Identity Provider policies.
Set this key only if required by the Identity Provider.</p>
</div>
</section>
<section id="cluster-configuration">
<span id="server-options-cluster"></span><h2>Cluster configuration<a class="headerlink" href="#cluster-configuration" title="Link to this heading">¶</a></h2>
<p>The following server options control <a class="reference internal" href="../clustering/#clustering"><span class="std std-ref">Clustering</span></a>:</p>
<div class="configoption docutils container" id="server-cluster:cluster.healing_threshold">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">cluster.healing_threshold</span></code></span><span class="shortdesc"><p>Threshold when to evacuate an offline cluster member</p>
</span><span class="anchor"><a class="reference external" href="#server-cluster:cluster.healing_threshold"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">cluster.healing_threshold</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">0</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the number of seconds after which an offline cluster member is to be evacuated.
To disable evacuating offline members, set this option to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-cluster:cluster.https_address">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">cluster.https_address</span></code></span><span class="shortdesc"><p>Address to use for clustering traffic</p>
</span><span class="anchor"><a class="reference external" href="#server-cluster:cluster.https_address"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">cluster.https_address</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>See <a class="reference internal" href="../howto/cluster_config_networks/#cluster-https-address"><span class="std std-ref">Separate REST API and clustering networks</span></a>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-cluster:cluster.images_minimal_replica">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">cluster.images_minimal_replica</span></code></span><span class="shortdesc"><p>Number of cluster members that replicate an image</p>
</span><span class="anchor"><a class="reference external" href="#server-cluster:cluster.images_minimal_replica"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">cluster.images_minimal_replica</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">3</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the minimal number of cluster members that keep a copy of a particular image.
Set this option to <code class="docutils literal notranslate"><span class="pre">1</span></code> for no replication, or to <code class="docutils literal notranslate"><span class="pre">-1</span></code> to replicate images on all members.</p>
</div>
</div>
<div class="configoption docutils container" id="server-cluster:cluster.join_token_expiry">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">cluster.join_token_expiry</span></code></span><span class="shortdesc"><p>Time after which a cluster join token expires</p>
</span><span class="anchor"><a class="reference external" href="#server-cluster:cluster.join_token_expiry"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">cluster.join_token_expiry</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">3H</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-cluster:cluster.max_standby">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">cluster.max_standby</span></code></span><span class="shortdesc"><p>Number of database stand-by members</p>
</span><span class="anchor"><a class="reference external" href="#server-cluster:cluster.max_standby"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">cluster.max_standby</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">2</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the maximum number of cluster members that are assigned the database stand-by role.
This must be a number between <code class="docutils literal notranslate"><span class="pre">0</span></code> and <code class="docutils literal notranslate"><span class="pre">5</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-cluster:cluster.max_voters">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">cluster.max_voters</span></code></span><span class="shortdesc"><p>Number of database voter members</p>
</span><span class="anchor"><a class="reference external" href="#server-cluster:cluster.max_voters"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">cluster.max_voters</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">3</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the maximum number of cluster members that are assigned the database voter role.
This must be an odd number &gt;= <code class="docutils literal notranslate"><span class="pre">3</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-cluster:cluster.offline_threshold">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">cluster.offline_threshold</span></code></span><span class="shortdesc"><p>Threshold when an unresponsive member is considered offline</p>
</span><span class="anchor"><a class="reference external" href="#server-cluster:cluster.offline_threshold"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">cluster.offline_threshold</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">20</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the number of seconds after which an unresponsive member is considered offline.</p>
</div>
</div>
</section>
<section id="images-configuration">
<span id="server-options-images"></span><h2>Images configuration<a class="headerlink" href="#images-configuration" title="Link to this heading">¶</a></h2>
<p>The following server options configure how to handle <a class="reference internal" href="../images/#images"><span class="std std-ref">Images</span></a>:</p>
<div class="configoption docutils container" id="server-images:images.auto_update_cached">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">images.auto_update_cached</span></code></span><span class="shortdesc"><p>Whether to automatically update cached images</p>
</span><span class="anchor"><a class="reference external" href="#server-images:images.auto_update_cached"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">images.auto_update_cached</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>bool</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">true</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-images:images.auto_update_interval">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">images.auto_update_interval</span></code></span><span class="shortdesc"><p>Interval at which to look for updates to cached images</p>
</span><span class="anchor"><a class="reference external" href="#server-images:images.auto_update_interval"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">images.auto_update_interval</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">6</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the interval in hours.
To disable looking for updates to cached images, set this option to <code class="docutils literal notranslate"><span class="pre">0</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-images:images.compression_algorithm">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">images.compression_algorithm</span></code></span><span class="shortdesc"><p>Compression algorithm to use for new images</p>
</span><span class="anchor"><a class="reference external" href="#server-images:images.compression_algorithm"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">images.compression_algorithm</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">gzip</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Possible values are <code class="docutils literal notranslate"><span class="pre">bzip2</span></code>, <code class="docutils literal notranslate"><span class="pre">gzip</span></code>, <code class="docutils literal notranslate"><span class="pre">lzma</span></code>, <code class="docutils literal notranslate"><span class="pre">xz</span></code>, or <code class="docutils literal notranslate"><span class="pre">none</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-images:images.default_architecture">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">images.default_architecture</span></code></span><span class="shortdesc"><p>Default architecture to use in a mixed-architecture cluster</p>
</span><span class="anchor"><a class="reference external" href="#server-images:images.default_architecture"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">images.default_architecture</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-images:images.remote_cache_expiry">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">images.remote_cache_expiry</span></code></span><span class="shortdesc"><p>When an unused cached remote image is flushed</p>
</span><span class="anchor"><a class="reference external" href="#server-images:images.remote_cache_expiry"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">images.remote_cache_expiry</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>integer</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">10</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the number of days after which the unused cached image expires.</p>
</div>
</div>
</section>
<section id="loki-configuration">
<span id="server-options-loki"></span><h2>Loki configuration<a class="headerlink" href="#loki-configuration" title="Link to this heading">¶</a></h2>
<p>The following server options configure the external log aggregation system:</p>
<div class="configoption docutils container" id="server-loki:loki.api.ca_cert">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.api.ca_cert</span></code></span><span class="shortdesc"><p>CA certificate for the Loki server</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.api.ca_cert"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.api.ca_cert</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-loki:loki.api.url">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.api.url</span></code></span><span class="shortdesc"><p>URL to the Loki server</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.api.url"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.api.url</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the protocol, name or IP and port. For example <code class="docutils literal notranslate"><span class="pre">https://loki.example.com:3100</span></code>. LXD will automatically add the <code class="docutils literal notranslate"><span class="pre">/loki/api/v1/push</span></code> suffix so there’s no need to add it here.</p>
</div>
</div>
<div class="configoption docutils container" id="server-loki:loki.auth.password">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.auth.password</span></code></span><span class="shortdesc"><p>Password used for Loki authentication</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.auth.password"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.auth.password</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-loki:loki.auth.username">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.auth.username</span></code></span><span class="shortdesc"><p>User name used for Loki authentication</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.auth.username"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.auth.username</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-loki:loki.instance">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.instance</span></code></span><span class="shortdesc"><p>Name to use as the instance field in Loki events.</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.instance"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.instance</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p>Local server host name or cluster member name</p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>This allows replacing the default instance value (server host name) by a more relevant value like a cluster identifier.</p>
</div>
</div>
<div class="configoption docutils container" id="server-loki:loki.labels">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.labels</span></code></span><span class="shortdesc"><p>Labels for a Loki log entry</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.labels"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.labels</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify a comma-separated list of values that should be used as labels for a Loki log entry.</p>
</div>
</div>
<div class="configoption docutils container" id="server-loki:loki.loglevel">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.loglevel</span></code></span><span class="shortdesc"><p>Minimum log level to send to the Loki server</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.loglevel"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.loglevel</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">info</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-loki:loki.types">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">loki.types</span></code></span><span class="shortdesc"><p>Events to send to the Loki server</p>
</span><span class="anchor"><a class="reference external" href="#server-loki:loki.types"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">loki.types</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">lifecycle,logging</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify a comma-separated list of events to send to the Loki server.
The events can be any combination of <code class="docutils literal notranslate"><span class="pre">lifecycle</span></code>, <code class="docutils literal notranslate"><span class="pre">logging</span></code>, and <code class="docutils literal notranslate"><span class="pre">ovn</span></code>.</p>
</div>
</div>
</section>
<section id="miscellaneous-options">
<span id="server-options-misc"></span><h2>Miscellaneous options<a class="headerlink" href="#miscellaneous-options" title="Link to this heading">¶</a></h2>
<p>The following server options configure server-specific settings for <a class="reference internal" href="../instances/#instances"><span class="std std-ref">Instances</span></a>, MAAS integration, <a class="reference internal" href="../reference/network_ovn/#network-ovn"><span class="std std-ref">OVN</span></a> integration, <a class="reference internal" href="../backup/#backups"><span class="std std-ref">Backups</span></a> and <a class="reference internal" href="../storage/#storage"><span class="std std-ref">Storage</span></a>:</p>
<div class="configoption docutils container" id="server-miscellaneous:backups.compression_algorithm">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">backups.compression_algorithm</span></code></span><span class="shortdesc"><p>Compression algorithm to use for backups</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:backups.compression_algorithm"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">backups.compression_algorithm</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">gzip</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Possible values are <code class="docutils literal notranslate"><span class="pre">bzip2</span></code>, <code class="docutils literal notranslate"><span class="pre">gzip</span></code>, <code class="docutils literal notranslate"><span class="pre">lzma</span></code>, <code class="docutils literal notranslate"><span class="pre">xz</span></code>, or <code class="docutils literal notranslate"><span class="pre">none</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:instances.migration.stateful">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">instances.migration.stateful</span></code></span><span class="shortdesc"><p>Whether to set <code class="docutils literal notranslate"><span class="pre">migration.stateful</span></code> to <code class="docutils literal notranslate"><span class="pre">true</span></code> for the instances</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:instances.migration.stateful"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">instances.migration.stateful</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>bool</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>You can override this setting for relevant instances, either in the instance-specific configuration or through a profile.</p>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:instances.nic.host_name">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">instances.nic.host_name</span></code></span><span class="shortdesc"><p>How to set the host name for a NIC</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:instances.nic.host_name"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">instances.nic.host_name</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">random</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Possible values are <code class="docutils literal notranslate"><span class="pre">random</span></code> and <code class="docutils literal notranslate"><span class="pre">mac</span></code>.</p>
<p>If set to <code class="docutils literal notranslate"><span class="pre">random</span></code>, use the random host interface name as the host name.
If set to <code class="docutils literal notranslate"><span class="pre">mac</span></code>, generate a host name in the form <code class="docutils literal notranslate"><span class="pre">lxd&lt;mac_address&gt;</span></code> (MAC without leading two digits).</p>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:instances.placement.scriptlet">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">instances.placement.scriptlet</span></code></span><span class="shortdesc"><p>Instance placement scriptlet for automatic instance placement</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:instances.placement.scriptlet"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">instances.placement.scriptlet</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>When using custom automatic instance placement logic, this option stores the scriptlet.
See <a class="reference internal" href="../explanation/clusters/#clustering-instance-placement-scriptlet"><span class="std std-ref">Instance placement scriptlet</span></a> for more information.</p>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:maas.api.key">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">maas.api.key</span></code></span><span class="shortdesc"><p>API key to manage MAAS</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:maas.api.key"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">maas.api.key</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:maas.api.url">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">maas.api.url</span></code></span><span class="shortdesc"><p>URL of the MAAS server</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:maas.api.url"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">maas.api.url</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:maas.machine">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">maas.machine</span></code></span><span class="shortdesc"><p>Name of this LXD host in MAAS</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:maas.machine"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">maas.machine</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p>host name</p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:network.ovn.ca_cert">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">network.ovn.ca_cert</span></code></span><span class="shortdesc"><p>OVN SSL certificate authority</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:network.ovn.ca_cert"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">network.ovn.ca_cert</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p>Content of <code class="docutils literal notranslate"><span class="pre">/etc/ovn/ovn-central.crt</span></code> if present</p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:network.ovn.client_cert">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">network.ovn.client_cert</span></code></span><span class="shortdesc"><p>OVN SSL client certificate</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:network.ovn.client_cert"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">network.ovn.client_cert</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p>Content of <code class="docutils literal notranslate"><span class="pre">/etc/ovn/cert_host</span></code> if present</p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:network.ovn.client_key">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">network.ovn.client_key</span></code></span><span class="shortdesc"><p>OVN SSL client key</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:network.ovn.client_key"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">network.ovn.client_key</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p>Content of <code class="docutils literal notranslate"><span class="pre">/etc/ovn/key_host</span></code> if present</p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:network.ovn.integration_bridge">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">network.ovn.integration_bridge</span></code></span><span class="shortdesc"><p>OVS integration bridge to use for OVN networks</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:network.ovn.integration_bridge"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">network.ovn.integration_bridge</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">br-int</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:network.ovn.northbound_connection">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">network.ovn.northbound_connection</span></code></span><span class="shortdesc"><p>OVN northbound database connection string</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:network.ovn.northbound_connection"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">network.ovn.northbound_connection</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Default: </strong></td>
<td><span class="ignoreP"><p><code class="docutils literal notranslate"><span class="pre">unix:/var/run/ovn/ovnnb_db.sock</span></code></p>
</span></td>
</tr>
<tr class="row-even"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>global</p>
</span></td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:storage.backups_volume">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">storage.backups_volume</span></code></span><span class="shortdesc"><p>Volume to use to store backup tarballs</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:storage.backups_volume"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">storage.backups_volume</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the volume using the syntax <code class="docutils literal notranslate"><span class="pre">POOL/VOLUME</span></code>.</p>
</div>
</div>
<div class="configoption docutils container" id="server-miscellaneous:storage.images_volume">
<div class="basicinfo docutils container">
<span class="key"><code class="docutils literal notranslate"><span class="pre">storage.images_volume</span></code></span><span class="shortdesc"><p>Volume to use to store the image tarballs</p>
</span><span class="anchor"><a class="reference external" href="#server-miscellaneous:storage.images_volume"><i class="icon"><svg><use href="#svg-arrow-right"></use></svg></i></a></span></div>
<div class="details docutils container">
<div class="table-wrapper fields docutils container">
<table class="fields docutils align-default">
<tbody>
<tr class="row-odd"><td><strong>Key: </strong></td>
<td><code class="docutils literal notranslate"><span class="pre">storage.images_volume</span></code></td>
</tr>
<tr class="row-even"><td><strong>Type: </strong></td>
<td><span class="ignoreP"><p>string</p>
</span></td>
</tr>
<tr class="row-odd"><td><strong>Scope: </strong></td>
<td><span class="ignoreP"><p>local</p>
</span></td>
</tr>
</tbody>
</table>
</div>
<p>Specify the volume using the syntax <code class="docutils literal notranslate"><span class="pre">POOL/VOLUME</span></code>.</p>
</div>
</div>
</section>
<section id="related-topics">
<h2>Related topics<a class="headerlink" href="#related-topics" title="Link to this heading">¶</a></h2>
<p>How-to guides:</p>
<ul class="simple">
<li><p><a class="reference internal" href="../howto/server_configure/#server-configure"><span class="std std-ref">How to configure the LXD server</span></a></p></li>
</ul>
</section>
</section>

        </article>
      </div>
      <footer>
        
   

<div class="related-pages">
  
  
      
  
  
  <a class="next-page" href="../explanation/instance_config/">
        <div class="page-info">
          <div class="context">
            <span>Next</span>
          </div>
          <div class="title">Instance configuration</div>
        </div>
        <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
      </a>
    <a class="prev-page" href="../config-options/">
        <svg class="furo-related-icon"><use href="#svg-arrow-right"></use></svg>
        <div class="page-info">
          <div class="context">
            <span>Previous</span>
          </div>
          
            <div class="title">Index</div>
          
        </div>
      </a>
</div>
<div class="bottom-of-page">
  <div class="left-details">
    <div class="copyright">
        Copyright &#169; 2014-2025 LXD contributors
    </div>

    <div class="last-updated">
      Last updated on Sep 08, 2025</div>
    <div class="show-source">
      <a class="muted-link" href="../_sources/server.md.txt"
         rel="nofollow">Show source</a>
    </div>
  </div>
  <div>
    
        
        
          
              <a class="display-contributors">Thanks to the 13 contributors!</a>
          
          <div id="overlay"></div>
          <ul class="all-contributors">
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/2b85d657124b7f48843a827d3e12b0e826d1fe09" class="contributor">Alberto Donato</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/6e8bfb9c02532a2bd9f697f9795941b0c13019c7" class="contributor">Conner Crosby</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/c1489f4b16fce06870eb00e933d7cd6f64d4c3fd" class="contributor">Free Ekanayaka</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/2b577c3808f50133bec23d2ead99e10e12b7bd96" class="contributor">Hiroaki Nakamura</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/f5eaa6e9dcdd29c409aa0d746229ea39ee3bdb10" class="contributor">Mark Laing</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/7c43c9a295ba0adc235ae72502f43030661c7587" class="contributor">Nikita Mezhenskyi</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/82a06a9305660bb648abdd6ebe7ad25276752700" class="contributor">Piotr Resztak</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/f72f23c6fa91de386851902e4710cacedef7ffb4" class="contributor">Ruth Fuchss</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/50d47f88a4fdfff03b548206b9b210f5da445876" class="contributor">Simon Deziel</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/e9e5312b65cdac44ac7e4a7a307e7ee77416a34c" class="contributor">Stéphane Graber</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/fb80f15aa3280b1c49b9c9d62d5b1228a7cc7b1e" class="contributor">Thomas Hipp</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/1c1a5b56713f5957f7ccab39586ca2cb023f7bd6" class="contributor">Thomas Parrott</a>
                  </li>
              
                  <li>
                      <a href="https://github.com/canonical/lxd/commit/9be1e0cab3b1c2fcb5c52cefe50ad67f512d8181" class="contributor">gary-wzl77</a>
                  </li>
              
          </ul>
        
    
  </div>
  <div class="right-details">

    

    
    <div class="ask-discourse">
      <a class="muted-link" href="https://discourse.ubuntu.com/c/lxd/">Ask a question on Discourse</a>
    </div>
    

    

    
    <div class="ask-matrix">
      <a class="muted-link" href="https://matrix.to/#/#documentation:ubuntu.com">Ask a question on Matrix</a>
    </div>
    

    

    
    <div class="issue-github">
      <a class="muted-link" href="https://github.com/canonical/lxd/issues/new?title=doc%3A+ADD+A+TITLE&body=DESCRIBE+THE+ISSUE%0A%0A---%0ADocument: server.md">Open a GitHub issue for this page</a>
    </div>
    

    <div class="edit-github">
      <a class="muted-link" href="https://github.com/canonical/lxd/edit/main/doc/server.md">Edit this page on GitHub</a>
    </div>
    


    </div>
  </div>
</div>

      </footer>
    </div>
    <aside class="toc-drawer">
      
<div class="toc-sticky toc-scroll">
   
    <div class="toc-title-container">
      <span class="toc-title">
       Contents
      </span>
    </div>
    <div class="toc-tree-container">
      <div class="toc-tree">
        <ul>
<li><a class="reference internal" href="#">Server configuration</a><ul>
<li><a class="reference internal" href="#core-configuration">Core configuration</a></li>
<li><a class="reference internal" href="#acme-configuration">ACME configuration</a></li>
<li><a class="reference internal" href="#openid-connect-configuration">OpenID Connect configuration</a></li>
<li><a class="reference internal" href="#cluster-configuration">Cluster configuration</a></li>
<li><a class="reference internal" href="#images-configuration">Images configuration</a></li>
<li><a class="reference internal" href="#loki-configuration">Loki configuration</a></li>
<li><a class="reference internal" href="#miscellaneous-options">Miscellaneous options</a></li>
<li><a class="reference internal" href="#related-topics">Related topics</a></li>
</ul>
</li>
</ul>

      </div>
    </div>
   
    
  </div>

    </aside>
  </div>
</div><script src="../_static/jquery.js?v=5d32c60e"></script>
    <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
    <script src="../_static/documentation_options.js?v=187304be"></script>
    <script src="../_static/doctools.js?v=9bcbadda"></script>
    <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/scripts/furo.js?v=46bd48cc"></script>
    <script src="../_static/clipboard.min.js?v=a7894cd8"></script>
    <script src="../_static/copybutton.js?v=f281be69"></script>
    <script src="../_static/config-options.js"></script>
    <script src="../_static/design-tabs.js?v=f930bc37"></script>
    <script src="../_static/header-nav.js?v=e117ad08"></script>
    <script src="../_static/footer.js?v=5acea47a"></script>
    <script src="../_static/github_issue_links.js?v=32bb732f"></script>
    <script src="../_static/js/bundle.js?v=a4d88309"></script>
    
<script>
  const github_url = "https://github.com/canonical/lxd";
</script>
</body>
</html>