<!DOCTYPE html> <html lang="en-US"> <head> <meta charset="UTF-8"> <meta http-equiv="X-UA-Compatible" content="IE=Edge"> <link rel="stylesheet" href="/assets/css/just-the-docs-default.css"> <link rel="stylesheet" href="/assets/css/just-the-docs-head-nav.css" id="jtd-head-nav-stylesheet"> <style id="jtd-nav-activation"> .site-nav ul li a { background-image: none; } </style> <script src="/assets/js/vendor/lunr.min.js"></script> <script src="/assets/js/just-the-docs.js"></script> <meta name="viewport" content="width=device-width, initial-scale=1"> <!-- Begin Jekyll SEO tag v2.8.0 --> <title>BoxVault Documentation | Documentation for BoxVault - Vagrant Box Repository Management System</title> <meta name="generator" content="Jekyll v4.4.1" /> <meta property="og:title" content="BoxVault Documentation" /> <meta name="author" content="BoxVault Project" /> <meta property="og:locale" content="en_US" /> <meta name="description" content="Documentation for BoxVault - Vagrant Box Repository Management System" /> <meta property="og:description" content="Documentation for BoxVault - Vagrant Box Repository Management System" /> <link rel="canonical" href="https://makr91.github.io/assets/css/just-the-docs-head-nav.css" /> <meta property="og:url" content="https://makr91.github.io/assets/css/just-the-docs-head-nav.css" /> <meta property="og:site_name" content="BoxVault Documentation" /> <meta property="og:type" content="website" /> <meta name="twitter:card" content="summary" /> <meta property="twitter:title" content="BoxVault Documentation" /> <script type="application/ld+json"> {"@context":"https://schema.org","@type":"WebPage","author":{"@type":"Person","name":"BoxVault Project","url":"https://github.com/Makr91/BoxVault"},"description":"Documentation for BoxVault - Vagrant Box Repository Management System","headline":"BoxVault Documentation","url":"https://makr91.github.io/assets/css/just-the-docs-head-nav.css"}</script> <!-- End Jekyll SEO tag --> <!-- Custom head content for BoxVault Documentation --> <link rel="icon" type="image/x-icon" href="/frontend/public/favicon.ico"> <link rel="apple-touch-icon" sizes="192x192" href="/frontend/public/logo192.png"> <link rel="apple-touch-icon" sizes="512x512" href="/frontend/public/logo512.png"> <!-- Dynamic version loading for releases page --> <script type="text/javascript"> document.addEventListener('DOMContentLoaded', function() { if (window.location.pathname.includes('/releases/')) { var releaseDiv = document.getElementById('latest-release-content'); if (releaseDiv) { fetch('https://raw.githubusercontent.com/Makr91/BoxVault/refs/heads/main/package.json') .then(function(response) { return response.json(); }) .then(function(data) { releaseDiv.innerHTML = '<p><strong>Version v' + data.version + '</strong> - Current Build</p>'; var p5pLink = document.querySelector('a[href*="boxvault.p5p"]'); if (p5pLink) { p5pLink.href = 'https://github.com/Makr91/BoxVault/releases/latest/download/boxvault-' + data.version + '.p5p'; } var debLink = document.querySelector('a[href*="boxvault.deb"]'); if (debLink) { debLink.href = 'https://github.com/Makr91/BoxVault/releases/latest/download/boxvault_' + data.version + '_amd64.deb'; } }); } } }); </script> <!-- Dynamic version loading for changelog page --> <script type="text/javascript"> document.addEventListener('DOMContentLoaded', function() { if (window.location.pathname.includes('/changelog/')) { var releaseDiv = document.getElementById('latest-release-content'); if (releaseDiv) { fetch('https://raw.githubusercontent.com/Makr91/BoxVault/refs/heads/main/package.json') .then(function(response) { return response.json(); }) .then(function(data) { releaseDiv.innerHTML = '<p><strong>Version v' + data.version + '</strong> - Current Build</p>'; }); } } }); </script> <!-- Dynamic version loading for security page --> <script type="text/javascript"> document.addEventListener('DOMContentLoaded', function() { if (window.location.pathname.includes('/security/')) { var versionsDiv = document.getElementById('supported-versions-content'); if (versionsDiv) { fetch('https://api.github.com/repos/Makr91/BoxVault/releases') .then(function(response) { return response.json(); }) .then(function(releases) { var html = '<div class="table-wrapper"><table><thead><tr><th>Version</th><th>Release Date</th><th>Supported</th><th>Download</th></tr></thead><tbody>'; var count = 0; for (var i = 0; i < releases.length && count < 5; i++) { var release = releases[i]; if (!release.draft && !release.prerelease) { var releaseDate = new Date(release.published_at).toLocaleDateString(); var isSupported = count < 3; var supportIcon = isSupported ? '✅' : '❌'; html += '<tr>'; html += '<td><a href="' + release.html_url + '">' + release.tag_name + '</a></td>'; html += '<td>' + releaseDate + '</td>'; html += '<td>' + supportIcon + '</td>'; html += '<td><a href="' + release.html_url + '">Download</a></td>'; html += '</tr>'; count++; } } html += '</tbody></table></div>'; html += '<p><em>Last updated: ' + new Date().toLocaleDateString() + '</em></p>'; versionsDiv.innerHTML = html; }) .catch(function(error) { versionsDiv.innerHTML = '<p><em>Error loading versions</em></p>'; }); } } }); </script> </head> <body> <a class="skip-to-main" href="#main-content">Skip to main content</a> <svg xmlns="http://www.w3.org/2000/svg" class="d-none"> <symbol id="svg-link" viewBox="0 0 24 24"> <title>Link</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-link"> <path d="M10 13a5 5 0 0 0 7.54.54l3-3a5 5 0 0 0-7.07-7.07l-1.72 1.71"></path><path d="M14 11a5 5 0 0 0-7.54-.54l-3 3a5 5 0 0 0 7.07 7.07l1.71-1.71"></path> </svg> </symbol> <symbol id="svg-menu" viewBox="0 0 24 24"> <title>Menu</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather 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" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-chevron-right"> <polyline points="9 18 15 12 9 6"></polyline> </svg> </symbol> <!-- Feather. MIT License: https://github.com/feathericons/feather/blob/master/LICENSE --> <symbol id="svg-external-link" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-external-link"> <title id="svg-external-link-title">(external link)</title> <path d="M18 13v6a2 2 0 0 1-2 2H5a2 2 0 0 1-2-2V8a2 2 0 0 1 2-2h6"></path><polyline points="15 3 21 3 21 9"></polyline><line x1="10" y1="14" x2="21" y2="3"></line> </symbol> <symbol id="svg-doc" viewBox="0 0 24 24"> <title>Document</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-file"> <path d="M13 2H6a2 2 0 0 0-2 2v16a2 2 0 0 0 2 2h12a2 2 0 0 0 2-2V9z"></path><polyline points="13 2 13 9 20 9"></polyline> </svg> </symbol> <symbol id="svg-search" viewBox="0 0 24 24"> <title>Search</title> <svg xmlns="http://www.w3.org/2000/svg" width="24" height="24" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" class="feather feather-search"> <circle cx="11" cy="11" r="8"></circle><line x1="21" y1="21" x2="16.65" y2="16.65"></line> </svg> </symbol> <!-- Bootstrap Icons. MIT License: https://github.com/twbs/icons/blob/main/LICENSE.md --> <symbol id="svg-copy" viewBox="0 0 16 16"> <title>Copy</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard" viewBox="0 0 16 16"> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1h1a1 1 0 0 1 1 1V14a1 1 0 0 1-1 1H3a1 1 0 0 1-1-1V3.5a1 1 0 0 1 1-1h1v-1z"/> <path d="M9.5 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3zm-3-1A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3z"/> </svg> </symbol> <symbol id="svg-copied" viewBox="0 0 16 16"> <title>Copied</title> <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" fill="currentColor" class="bi bi-clipboard-check-fill" viewBox="0 0 16 16"> <path d="M6.5 0A1.5 1.5 0 0 0 5 1.5v1A1.5 1.5 0 0 0 6.5 4h3A1.5 1.5 0 0 0 11 2.5v-1A1.5 1.5 0 0 0 9.5 0h-3Zm3 1a.5.5 0 0 1 .5.5v1a.5.5 0 0 1-.5.5h-3a.5.5 0 0 1-.5-.5v-1a.5.5 0 0 1 .5-.5h3Z"/> <path d="M4 1.5H3a2 2 0 0 0-2 2V14a2 2 0 0 0 2 2h10a2 2 0 0 0 2-2V3.5a2 2 0 0 0-2-2h-1v1A2.5 2.5 0 0 1 9.5 5h-3A2.5 2.5 0 0 1 4 2.5v-1Zm6.854 7.354-3 3a.5.5 0 0 1-.708 0l-1.5-1.5a.5.5 0 0 1 .708-.708L7.5 10.793l2.646-2.647a.5.5 0 0 1 .708.708Z"/> </svg> </symbol> </svg> <div class="side-bar"> <div class="site-header" role="banner"> <a href="/" class="site-title lh-tight"> BoxVault Documentation </a> <button id="menu-button" class="site-button btn-reset" aria-label="Toggle menu" aria-pressed="false"> <svg viewBox="0 0 24 24" class="icon" aria-hidden="true"><use xlink:href="#svg-menu"></use></svg> </button> </div> <nav aria-label="Main" id="site-nav" class="site-nav"> <ul class="nav-list"><li class="nav-list-item"><a href="/" class="nav-list-link">Home</a></li><li class="nav-list-item"><a href="/docs/api/" class="nav-list-link">API Reference</a></li><li class="nav-list-item"><button class="nav-list-expander btn-reset" aria-label="toggle items in Guides category" aria-pressed="false"> <svg viewBox="0 0 24 24" aria-hidden="true"><use xlink:href="#svg-arrow-right"></use></svg> </button><a href="/docs/guides/" class="nav-list-link">Guides</a><ul class="nav-list"><li class="nav-list-item"><a href="/docs/guides/getting-started/" class="nav-list-link">Getting Started</a></li><li class="nav-list-item"><a href="/docs/guides/installation/" class="nav-list-link">Installation</a></li><li class="nav-list-item"><a href="/docs/guides/authentication/" class="nav-list-link">Authentication</a></li><li class="nav-list-item"><a href="/docs/guides/api-examples/" class="nav-list-link">API Examples</a></li><li class="nav-list-item"><a href="/docs/guides/backend-integration/" class="nav-list-link">Backend Integration</a></li></ul></li><li class="nav-list-item"><a href="/docs/configuration/" class="nav-list-link">Configuration</a></li><li class="nav-list-item"><a href="/docs/releases/" class="nav-list-link">Releases</a></li><li class="nav-list-item"><a href="/docs/changelog/" class="nav-list-link">Changelog</a></li><li class="nav-list-item"><a href="/docs/license/" class="nav-list-link">License</a></li><li class="nav-list-item"><a href="/docs/security/" class="nav-list-link">Security Policy</a></li><li class="nav-list-item"><a href="/docs/support/" class="nav-list-link">Support</a></li><li class="nav-list-item"><a href="/docs/contributing/" class="nav-list-link">Contributing</a></li><li class="nav-list-item"><a href="/docs/code-of-conduct/" class="nav-list-link">Code of Conduct</a></li><li class="nav-list-item"><a href="/docs/acknowledgments/" class="nav-list-link">Acknowledgments</a></li><li class="nav-list-item"><a href="/docs/authors/" class="nav-list-link">Authors</a></li></ul> </nav> <footer class="site-footer"> This site uses <a href="https://github.com/just-the-docs/just-the-docs">Just the Docs</a>, a documentation theme for Jekyll. </footer> </div> <div class="main" id="top"> <div id="main-header" class="main-header"> <div class="search" role="search"> <div class="search-input-wrap"> <input type="text" id="search-input" class="search-input" tabindex="0" placeholder="Search BoxVault Documentation" aria-label="Search BoxVault Documentation" autocomplete="off"> <label for="search-input" class="search-label"><svg viewBox="0 0 24 24" class="search-icon"><use xlink:href="#svg-search"></use></svg></label> </div> <div id="search-results" class="search-results"></div> </div> </div> <div class="main-content-wrap"> <div id="main-content" class="main-content"> <main> </main> <hr> <footer> <p><a href="#top" id="back-to-top">Back to top</a></p> <p class="text-small text-grey-dk-100 mb-0">Copyright &copy; 2024 BoxVault Project. Distributed under the <a href="https://github.com/Makr91/BoxVault/blob/main/LICENSE.md">GPL-3.0 License</a>.</p> <div class="d-flex mt-2"> </div> </footer> </div> </div> <div class="search-overlay"></div> </div> <script src="https://cdn.jsdelivr.net/npm/mermaid@9.4.3/dist/mermaid.min.js"></script> <script> var config = {} ; mermaid.initialize(config); window.mermaid.init(undefined, document.querySelectorAll('.language-mermaid')); </script> </body> </html>
