CINXE.COM
LOCKSS Documentation Portal — LOCKSS Documentation Portal
<!DOCTYPE html> <html lang="en" data-content_root="./"> <head> <meta charset="utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /><meta name="viewport" content="width=device-width, initial-scale=1" /> <title>LOCKSS Documentation Portal — LOCKSS Documentation Portal</title> <link rel="stylesheet" href="_static/basic.css" type="text/css" /> <link rel="stylesheet" type="text/css" href="_static/pygments.css?v=649a27d8" /> <link rel="stylesheet" type="text/css" href="_static/insipid.css?v=b2d00be7" /> <link rel="stylesheet" type="text/css" href="_static/sphinx-design.min.css?v=95c83b7e" /> <link rel="stylesheet" type="text/css" href="_static/css/lockss.css?v=c2ac6199" /> <link rel="preload" href="_static/insipid-sidebar-readthedocs.css" as="style" onload="this.onload=null;this.rel='stylesheet'"> <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=8a448e45"></script> <script src="_static/doctools.js?v=9bcbadda"></script> <script src="_static/sphinx_highlight.js?v=dc90522c"></script> <script src="_static/design-tabs.js?v=f930bc37"></script> <script defer src="_static/insipid.js"></script> <script defer src="_static/insipid-sidebar.js"></script> <link rel="canonical" href="https://docs.lockss.org/en/latest/index.html" /> <link rel="search" title="Search" href="search.html" /> <link rel="next" title="Releases" href="releases.html" /> <meta name="mobile-web-app-capable" content="yes"> <meta name="apple-mobile-web-app-capable" content="yes"> <script async type="text/javascript" src="/_/static/javascript/readthedocs-addons.js"></script><meta name="readthedocs-project-slug" content="lockss" /><meta name="readthedocs-version-slug" content="latest" /><meta name="readthedocs-resolver-filename" content="/" /><meta name="readthedocs-http-status" content="200" /></head><body> <script type="text/javascript"> document.body.classList.add('js'); </script> <input type="checkbox" id="sidebar-checkbox" style="display: none;"> <label id="overlay" for="sidebar-checkbox"></label> <div class="sidebar-resize-handle"></div> <script type="text/javascript"> try { let sidebar = localStorage.getItem('sphinx-sidebar'); const sidebar_width = localStorage.getItem('sphinx-sidebar-width'); if (sidebar_width) { document.documentElement.style.setProperty('--sidebar-width', sidebar_width); } // show sidebar on wide screen if (!sidebar && window.matchMedia('(min-width: 100rem)').matches) { sidebar = 'visible'; // NB: We don't store the value in localStorage! } if (sidebar === 'visible') { document.getElementById('sidebar-checkbox').checked = true; } } catch(e) { console.info(e); } </script> <header id="topbar-placeholder"> <div id="topbar"> <div id="titlebar"> <div class="buttons"> <label for="sidebar-checkbox" id="sidebar-button" role="button" tabindex="0" aria-controls="sphinxsidebar" accesskey="M"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M16 132h416c8.837 0 16-7.163 16-16V76c0-8.837-7.163-16-16-16H16C7.163 60 0 67.163 0 76v40c0 8.837 7.163 16 16 16zm0 160h416c8.837 0 16-7.163 16-16v-40c0-8.837-7.163-16-16-16H16c-8.837 0-16 7.163-16 16v40c0 8.837 7.163 16 16 16zm0 160h416c8.837 0 16-7.163 16-16v-40c0-8.837-7.163-16-16-16H16c-8.837 0-16 7.163-16 16v40c0 8.837 7.163 16 16 16z"/></svg> </label> <button id="search-button" type="button" title="Search" aria-label="Search" aria-expanded="false" aria-controls="search-form" accesskey="S"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 512 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M505 442.7L405.3 343c-4.5-4.5-10.6-7-17-7H372c27.6-35.3 44-79.7 44-128C416 93.1 322.9 0 208 0S0 93.1 0 208s93.1 208 208 208c48.3 0 92.7-16.4 128-44v16.3c0 6.4 2.5 12.5 7 17l99.7 99.7c9.4 9.4 24.6 9.4 33.9 0l28.3-28.3c9.4-9.4 9.4-24.6.1-34zM208 336c-70.7 0-128-57.2-128-128 0-70.7 57.2-128 128-128 70.7 0 128 57.2 128 128 0 70.7-57.2 128-128 128z"/></svg> </button> </div> <div class="title"> <span class="parent">LOCKSS Documentation Portal</span> <a class="top" href="#">LOCKSS Documentation Portal</a> </div> <div class="buttons"> <button id="fullscreen-button" type="button" aria-hidden="true"> <span class="enable"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M212.686 315.314L120 408l32.922 31.029c15.12 15.12 4.412 40.971-16.97 40.971h-112C10.697 480 0 469.255 0 456V344c0-21.382 25.803-32.09 40.922-16.971L72 360l92.686-92.686c6.248-6.248 16.379-6.248 22.627 0l25.373 25.373c6.249 6.248 6.249 16.378 0 22.627zm22.628-118.628L328 104l-32.922-31.029C279.958 57.851 290.666 32 312.048 32h112C437.303 32 448 42.745 448 56v112c0 21.382-25.803 32.09-40.922 16.971L376 152l-92.686 92.686c-6.248 6.248-16.379 6.248-22.627 0l-25.373-25.373c-6.249-6.248-6.249-16.378 0-22.627z"/></svg> </span> <span class="disable"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M4.686 427.314L104 328l-32.922-31.029C55.958 281.851 66.666 256 88.048 256h112C213.303 256 224 266.745 224 280v112c0 21.382-25.803 32.09-40.922 16.971L152 376l-99.314 99.314c-6.248 6.248-16.379 6.248-22.627 0L4.686 449.941c-6.248-6.248-6.248-16.379 0-22.627zM443.314 84.686L344 184l32.922 31.029c15.12 15.12 4.412 40.971-16.97 40.971h-112C234.697 256 224 245.255 224 232V120c0-21.382 25.803-32.09 40.922-16.971L296 136l99.314-99.314c6.248-6.248 16.379-6.248 22.627 0l25.373 25.373c6.248 6.248 6.248 16.379 0 22.627z"/></svg> </span> </button> </div> </div> <div id="searchbox" role="search"> <form id="search-form" class="search" style="display: none" action="search.html" method="get"> <input type="search" name="q" placeholder="Search ..." autocomplete="off" autocorrect="off" autocapitalize="off" spellcheck="false" /> <button>Go</button> </form> </div> </div> </header> <nav> <a href="releases.html" class="nav-icon next" title="next: Releases" aria-label="Next topic" accesskey="N" tabindex="-1"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 256 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M224.3 273l-136 136c-9.4 9.4-24.6 9.4-33.9 0l-22.6-22.6c-9.4-9.4-9.4-24.6 0-33.9l96.4-96.4-96.4-96.4c-9.4-9.4-9.4-24.6 0-33.9L54.3 103c9.4-9.4 24.6-9.4 33.9 0l136 136c9.5 9.4 9.5 24.6.1 34z"/></svg> </a> </nav> <nav class="relbar"> <a class="next" href="releases.html" aria-label="Next topic" > <div class="title"> <span class="text"> <span class="direction">next</span> Releases </span> </div> <div class="icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M190.5 66.9l22.2-22.2c9.4-9.4 24.6-9.4 33.9 0L441 239c9.4 9.4 9.4 24.6 0 33.9L246.6 467.3c-9.4 9.4-24.6 9.4-33.9 0l-22.2-22.2c-9.5-9.5-9.3-25 .4-34.3L311.4 296H24c-13.3 0-24-10.7-24-24v-32c0-13.3 10.7-24 24-24h287.4L190.9 101.2c-9.8-9.3-10-24.8-.4-34.3z"/></svg> </div> </a> </nav> <div class="document"> <div class="documentwrapper"> <div class="bodywrapper"> <div class="body" role="main"> <nav class="crumbs"> <ul> <li><a href="#" aria-label="LOCKSS Documentation Portal"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 576 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M280.37 148.26L96 300.11V464a16 16 0 0 0 16 16l112.06-.29a16 16 0 0 0 15.92-16V368a16 16 0 0 1 16-16h64a16 16 0 0 1 16 16v95.64a16 16 0 0 0 16 16.05L464 480a16 16 0 0 0 16-16V300L295.67 148.26a12.19 12.19 0 0 0-15.3 0zM571.6 251.47L488 182.56V44.05a12 12 0 0 0-12-12h-56a12 12 0 0 0-12 12v72.61L318.47 43a48 48 0 0 0-61 0L4.34 251.47a12 12 0 0 0-1.6 16.9l25.5 31A12 12 0 0 0 45.15 301l235.22-193.74a12.19 12.19 0 0 1 15.3 0L530.9 301a12 12 0 0 0 16.9-1.6l25.5-31a12 12 0 0 0-1.7-16.93z"/></svg></a> »</li> <li><a href="">LOCKSS Documentation Portal</a></li> </ul> </nav> <section id="lockss-documentation-portal"> <h1>LOCKSS Documentation Portal<a class="headerlink" href="#lockss-documentation-portal" title="Link to this heading"></a></h1> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 sd-p-0 docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-2 sd-row-cols-lg-2 sd-g-1 sd-g-xs-1 sd-g-sm-1 sd-g-md-1 sd-g-lg-1 docutils"> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <img alt="_images/lockss-classic-80x80.gif" class="align-center" src="_images/lockss-classic-80x80.gif" /> </div> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold sd-text-center docutils"> LOCKSS 1.x <span class="sd-sphinx-override sd-badge sd-bg-success sd-bg-text-success">stable</span></div> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="https://github.com/lockss/lockss-daemon/releases/tag/release-candidate_1-78-b3">LOCKSS 1.78.3</a> (2023-07-29) <span class="sd-sphinx-override sd-badge sd-bg-info sd-bg-text-info">latest</span></p></li> </ul> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary reference external" href="https://lockss.github.io/administrators/classic-lockss/"><span>LOCKSS 1.x System Manual</span></a></span></p> </div> </div> </div> <div class="sd-col sd-d-flex-row docutils"> <div class="sd-card sd-sphinx-override sd-w-100 sd-shadow-sm docutils"> <div class="sd-card-header docutils"> <img alt="_images/lockss-80x80.png" class="align-center" src="_images/lockss-80x80.png" /> </div> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold sd-text-center docutils"> LOCKSS 2.x <span class="sd-sphinx-override sd-badge sd-outline-warning sd-text-warning">beta</span></div> <ul class="simple"> <li><p class="sd-card-text"><a class="reference external" href="/projects/manual/en/2.0-beta1/appendix/release-notes.html#lockss-2-0-83-beta1">LOCKSS 2.0.83-beta1</a> (2023-09-25) <span class="sd-sphinx-override sd-badge sd-outline-info sd-text-info">latest</span></p></li> <li><p class="sd-card-text"><a class="reference external" href="/projects/manual/en/2.0-beta1/appendix/release-notes.html#lockss-2-0-82-beta1">LOCKSS 2.0.82-beta1</a> (2023-08-19)</p></li> <li><p class="sd-card-text"><a class="reference external" href="/projects/manual/en/2.0-beta1/appendix/release-notes.html#lockss-2-0-81-beta1">LOCKSS 2.0.81-beta1</a> (2023-07-29)</p></li> </ul> </div> <div class="sd-card-footer docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-primary reference external" href="/projects/manual/"><span>LOCKSS 2.x System Manual</span></a></span></p> </div> </div> </div> </div> </div> <div class="sd-card sd-sphinx-override sd-mb-3 sd-shadow-sm sd-text-center docutils"> <div class="sd-card-body docutils"> <div class="sd-card-title sd-font-weight-bold docutils"> LOCKSS Guides</div> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-1 sd-row-cols-lg-1 docutils"> <div class="sd-col sd-d-flex-column docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="migration/index.html"><span class="doc">LOCKSS 1.x to 2.x Migration Guide</span></a></span></p> </div> </div> </div> <div class="sd-container-fluid sd-sphinx-override sd-mb-4 docutils"> <div class="sd-row sd-row-cols-1 sd-row-cols-xs-1 sd-row-cols-sm-1 sd-row-cols-md-3 sd-row-cols-lg-3 docutils"> <div class="sd-col sd-d-flex-column docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="admin/index.html"><span class="doc">LOCKSS Network Administrator Guide</span></a></span></p> </div> <div class="sd-col sd-d-flex-column docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="plugin/index.html"><span class="doc">LOCKSS Plugin Developer Guide</span></a></span></p> </div> <div class="sd-col sd-d-flex-column docutils"> <p class="sd-card-text"><span class="sd-d-grid"><a class="sd-sphinx-override sd-btn sd-text-wrap sd-btn-secondary reference internal" href="dev/index.html"><span class="doc">LOCKSS Software Developer Guide</span></a></span></p> </div> </div> </div> </div> </div> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> <div class="toctree-wrapper compound"> </div> </section> <div class="clearer"></div> </div> </div> </div> <div class="sphinxsidebar" role="navigation" aria-label="Main"> <div class="sphinxsidebarwrapper"> <p class="logo"><a href="#"> <img class="logo" src="_static/lockss-docs-128x128.png" alt="Logo of LOCKSS Documentation Portal"/> </a></p> <div class="sidebar-resize-handle"></div> <h3><a href="#">Table of Contents</a></h3> <p class="caption" role="heading"><span class="caption-text">LOCKSS System</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="releases.html">Releases</a></li> <li class="toctree-l1"><a class="reference internal" href="security/index.html">Security</a></li> <li class="toctree-l1"><a class="reference external" href="https://lockss.github.io/administrators/classic-lockss/">LOCKSS 1.x System Manual</a></li> <li class="toctree-l1"><a class="reference external" href="https://docs.lockss.org/projects/manual/">LOCKSS 2.x System Manual</a></li> <li class="toctree-l1"><a class="reference internal" href="acknowledgments.html">Acknowledgments</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">LOCKSS Guides</span></p> <ul> <li class="toctree-l1"><a class="reference internal" href="admin/index.html">LOCKSS Network Administrator Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="plugin/index.html">LOCKSS Plugin Developer Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="dev/index.html">LOCKSS Software Developer Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="migration/index.html">LOCKSS 1.x to 2.x Migration Guide</a></li> </ul> <p class="caption" role="heading"><span class="caption-text">Navigation</span></p> <ul> <li class="toctree-l1"><a class="reference external" href="https://www.lockss.org/">LOCKSS Program Web Site</a></li> <li class="toctree-l1"><a class="reference external" href="https://docs.lockss.org/">» LOCKSS Documentation Portal</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/lockss/community/wiki">LOCKSS Community Wiki</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/lockss/community/discussions">LOCKSS Community Discussions</a></li> </ul> <div><hr class="docutils"></div> <ul> </ul> <div id="ethical-ad-placement"></div> <div id="readthedocs-embed-flyout"></div> <script>document.currentScript.previousElementSibling.style.display = 'block';</script> </div> </div> <div class="clearer"></div> </div> <nav class="relbar"> <a class="next" href="releases.html" aria-label="Next topic" > <div class="title"> <span class="text"> <span class="direction">next</span> Releases </span> </div> <div class="icon"> <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!-- Font Awesome Free 5.15.4 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) --><path d="M190.5 66.9l22.2-22.2c9.4-9.4 24.6-9.4 33.9 0L441 239c9.4 9.4 9.4 24.6 0 33.9L246.6 467.3c-9.4 9.4-24.6 9.4-33.9 0l-22.2-22.2c-9.5-9.5-9.3-25 .4-34.3L311.4 296H24c-13.3 0-24-10.7-24-24v-32c0-13.3 10.7-24 24-24h287.4L190.9 101.2c-9.8-9.3-10-24.8-.4-34.3z"/></svg> </div> </a> </nav> <footer role="contentinfo"> © Copyright 2000-2024, LOCKSS Program. Created using <a class="reference external" href="https://www.sphinx-doc.org/">Sphinx</a> 8.1.3. <a class="reference external" href="https://insipid-sphinx-theme.readthedocs.io/">Insipid Theme</a>. </footer> </body> </html>