mirror of
https://github.com/LogicLabs-OU/OpenArchiver.git
synced 2026-04-06 00:31:57 +02:00
26 lines
21 KiB
HTML
26 lines
21 KiB
HTML
<!DOCTYPE html>
|
||
<html lang="en-US" dir="ltr">
|
||
<head>
|
||
<meta charset="utf-8">
|
||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||
<title>Get Started 👋 | Open Archiver</title>
|
||
<meta name="description" content="Official documentation for the Open Archiver project.">
|
||
<meta name="generator" content="VitePress v1.6.3">
|
||
<link rel="preload stylesheet" href="/assets/style.3jgUiUT_.css" as="style">
|
||
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
||
|
||
<script type="module" src="/assets/app.Dj-ZQhsf.js"></script>
|
||
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||
<link rel="modulepreload" href="/assets/chunks/theme.Y7m0PHnt.js">
|
||
<link rel="modulepreload" href="/assets/chunks/framework.S-Qvb3wi.js">
|
||
<link rel="modulepreload" href="/assets/index.md.9PKJf5H1.lean.js">
|
||
<script defer src="https://analytics.zenceipt.com/script.js" data-website-id="2c8b452e-eab5-4f82-8ead-902d8f8b976f"></script>
|
||
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
|
||
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
|
||
</head>
|
||
<body>
|
||
<div id="app"><div class="Layout" data-v-b4de4928><!--[--><!--]--><!--[--><span tabindex="-1" data-v-f1a6591b></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-f1a6591b>Skip to content</a><!--]--><!----><header class="VPNav" data-v-b4de4928 data-v-196296ba><div class="VPNavBar" data-v-196296ba data-v-632f34fa><div class="wrapper" data-v-632f34fa><div class="container" data-v-632f34fa><div class="title" data-v-632f34fa><div class="VPNavBarTitle has-sidebar" data-v-632f34fa data-v-dcc486d8><a class="title" href="/" data-v-dcc486d8><!--[--><!--]--><!--[--><img class="VPImage logo" src="/logo-sq.svg" alt data-v-085b6aad><!--]--><span data-v-dcc486d8>Open Archiver</span><!--[--><!--]--></a></div></div><div class="content" data-v-632f34fa><div class="content-body" data-v-632f34fa><!--[--><!--]--><div class="VPNavBarSearch search" data-v-632f34fa><!--[--><!----><div id="local-search"><button type="button" class="DocSearch DocSearch-Button" aria-label="Search"><span class="DocSearch-Button-Container"><span class="vp-icon DocSearch-Search-Icon"></span><span class="DocSearch-Button-Placeholder">Search</span></span><span class="DocSearch-Button-Keys"><kbd class="DocSearch-Button-Key"></kbd><kbd class="DocSearch-Button-Key">K</kbd></span></button></div><!--]--></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-632f34fa data-v-e1b4cdce><span id="main-nav-aria-label" class="visually-hidden" data-v-e1b4cdce> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink active" href="/" tabindex="0" data-v-e1b4cdce data-v-a32d3490><!--[--><span data-v-a32d3490>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://github.com/LogicLabs-OU/OpenArchiver" target="_blank" rel="noreferrer" tabindex="0" data-v-e1b4cdce data-v-a32d3490><!--[--><span data-v-a32d3490>Github</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://openarchiver.com/" target="_blank" rel="noreferrer" tabindex="0" data-v-e1b4cdce data-v-a32d3490><!--[--><span data-v-a32d3490>Website</span><!--]--></a><!--]--><!--[--><a class="VPLink link vp-external-link-icon VPNavBarMenuLink" href="https://discord.gg/Qpv4BmHp" target="_blank" rel="noreferrer" tabindex="0" data-v-e1b4cdce data-v-a32d3490><!--[--><span data-v-a32d3490>Discord</span><!--]--></a><!--]--><!--]--></nav><!----><div class="VPNavBarAppearance appearance" data-v-632f34fa data-v-5cc3ce0d><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-5cc3ce0d data-v-299b7b5e data-v-a6d5da05><span class="check" data-v-a6d5da05><span class="icon" data-v-a6d5da05><!--[--><span class="vpi-sun sun" data-v-299b7b5e></span><span class="vpi-moon moon" data-v-299b7b5e></span><!--]--></span></span></button></div><!----><div class="VPFlyout VPNavBarExtra extra" data-v-632f34fa data-v-cf3d1140 data-v-f22c51c1><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="extra navigation" data-v-f22c51c1><span class="vpi-more-horizontal icon" data-v-f22c51c1></span></button><div class="menu" data-v-f22c51c1><div class="VPMenu" data-v-f22c51c1 data-v-21da92f6><!----><!--[--><!--[--><!----><div class="group" data-v-cf3d1140><div class="item appearance" data-v-cf3d1140><p class="label" data-v-cf3d1140>Appearance</p><div class="appearance-action" data-v-cf3d1140><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-cf3d1140 data-v-299b7b5e data-v-a6d5da05><span class="check" data-v-a6d5da05><span class="icon" data-v-a6d5da05><!--[--><span class="vpi-sun sun" data-v-299b7b5e></span><span class="vpi-moon moon" data-v-299b7b5e></span><!--]--></span></span></button></div></div></div><!----><!--]--><!--]--></div></div></div><!--[--><!--]--><button type="button" class="VPNavBarHamburger hamburger" aria-label="mobile navigation" aria-expanded="false" aria-controls="VPNavScreen" data-v-632f34fa data-v-bc4091a7><span class="container" data-v-bc4091a7><span class="top" data-v-bc4091a7></span><span class="middle" data-v-bc4091a7></span><span class="bottom" data-v-bc4091a7></span></span></button></div></div></div></div><div class="divider" data-v-632f34fa><div class="divider-line" data-v-632f34fa></div></div></div><!----></header><div class="VPLocalNav has-sidebar empty" data-v-b4de4928 data-v-25ab87d9><div class="container" data-v-25ab87d9><button class="menu" aria-expanded="false" aria-controls="VPSidebarNav" data-v-25ab87d9><span class="vpi-align-left menu-icon" data-v-25ab87d9></span><span class="menu-text" data-v-25ab87d9>Menu</span></button><div class="VPLocalNavOutlineDropdown" style="--vp-vh:0px;" data-v-25ab87d9 data-v-3b0d77ac><button data-v-3b0d77ac>Return to top</button><!----></div></div></div><aside class="VPSidebar" data-v-b4de4928 data-v-f58b6c37><div class="curtain" data-v-f58b6c37></div><nav class="nav" id="VPSidebarNav" aria-labelledby="sidebar-aria-label" tabindex="-1" data-v-f58b6c37><span class="visually-hidden" id="sidebar-aria-label" data-v-f58b6c37> Sidebar Navigation </span><!--[--><!--]--><!--[--><div class="no-transition group" data-v-3272fbfa><section class="VPSidebarItem level-0 has-active" data-v-3272fbfa data-v-b566cf41><div class="item" role="button" tabindex="0" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><h2 class="text" data-v-b566cf41>User Guides</h2><!----></div><div class="items" data-v-b566cf41><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Get Started</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/user-guides/installation.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Installation</p><!--]--></a><!----></div><!----></div><section class="VPSidebarItem level-1 collapsible collapsed is-link" data-v-b566cf41 data-v-b566cf41><div class="item" tabindex="0" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/user-guides/email-providers/" data-v-b566cf41><!--[--><h3 class="text" data-v-b566cf41>Email Providers</h3><!--]--></a><div class="caret" role="button" aria-label="toggle section" tabindex="0" data-v-b566cf41><span class="vpi-chevron-right caret-icon" data-v-b566cf41></span></div></div><div class="items" data-v-b566cf41><!--[--><div class="VPSidebarItem level-2 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/user-guides/email-providers/google-workspace.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Google Workspace</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/user-guides/email-providers/imap.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Generic IMAP Server</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-2 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/user-guides/email-providers/microsoft-365.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Microsoft 365</p><!--]--></a><!----></div><!----></div><!--]--></div></section><!--]--></div></section></div><div class="no-transition group" data-v-3272fbfa><section class="VPSidebarItem level-0" data-v-3272fbfa data-v-b566cf41><div class="item" role="button" tabindex="0" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><h2 class="text" data-v-b566cf41>API Reference</h2><!----></div><div class="items" data-v-b566cf41><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/authentication.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Authentication</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/auth.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Auth</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/archived-email.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Archived Email</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/dashboard.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Dashboard</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/ingestion.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Ingestion</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/search.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Search</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/api/storage.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Storage</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><div class="no-transition group" data-v-3272fbfa><section class="VPSidebarItem level-0" data-v-3272fbfa data-v-b566cf41><div class="item" role="button" tabindex="0" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><h2 class="text" data-v-b566cf41>Services</h2><!----></div><div class="items" data-v-b566cf41><!--[--><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/services/" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Overview</p><!--]--></a><!----></div><!----></div><div class="VPSidebarItem level-1 is-link" data-v-b566cf41 data-v-b566cf41><div class="item" data-v-b566cf41><div class="indicator" data-v-b566cf41></div><a class="VPLink link link" href="/services/storage-service.html" data-v-b566cf41><!--[--><p class="text" data-v-b566cf41>Storage Service</p><!--]--></a><!----></div><!----></div><!--]--></div></section></div><!--]--><!--[--><!--]--></nav></aside><div class="VPContent has-sidebar" id="VPContent" data-v-b4de4928 data-v-da66bf6a><div class="VPDoc has-sidebar has-aside" data-v-da66bf6a data-v-ef58e7af><!--[--><!--]--><div class="container" data-v-ef58e7af><div class="aside" data-v-ef58e7af><div class="aside-curtain" data-v-ef58e7af></div><div class="aside-container" data-v-ef58e7af><div class="aside-content" data-v-ef58e7af><div class="VPDocAside" data-v-ef58e7af data-v-271fded2><!--[--><!--]--><!--[--><!--]--><nav aria-labelledby="doc-outline-aria-label" class="VPDocAsideOutline" data-v-271fded2 data-v-fa352379><div class="content" data-v-fa352379><div class="outline-marker" data-v-fa352379></div><div aria-level="2" class="outline-title" id="doc-outline-aria-label" role="heading" data-v-fa352379>On this page</div><ul class="VPDocOutlineItem root" data-v-fa352379 data-v-0bb3c463><!--[--><!--]--></ul></div></nav><!--[--><!--]--><div class="spacer" data-v-271fded2></div><!--[--><!--]--><!----><!--[--><!--]--><!--[--><!--]--></div></div></div></div><div class="content" data-v-ef58e7af><div class="content-container" data-v-ef58e7af><!--[--><!--]--><main class="main" data-v-ef58e7af><div style="position:relative;" class="vp-doc _" data-v-ef58e7af><div><h1 id="get-started-👋" tabindex="-1">Get Started 👋 <a class="header-anchor" href="#get-started-👋" aria-label="Permalink to "Get Started 👋""></a></h1><p>Welcome to Open Archiver! This guide will help you get started with setting up and using the platform.</p><h2 id="what-is-open-archiver-🛡️" tabindex="-1">What is Open Archiver? 🛡️ <a class="header-anchor" href="#what-is-open-archiver-🛡️" aria-label="Permalink to "What is Open Archiver? 🛡️""></a></h2><p><strong>A secure, sovereign, and affordable open-source platform for email archiving and eDiscovery.</strong></p><p>Open Archiver provides a robust, self-hosted solution for archiving, storing, indexing, and searching emails from major platforms, including Google Workspace (Gmail), Microsoft 365, as well as generic IMAP-enabled email inboxes. Use Open Archiver to keep a permanent, tamper-proof record of your communication history, free from vendor lock-in.</p><h2 id="key-features-✨" tabindex="-1">Key Features ✨ <a class="header-anchor" href="#key-features-✨" aria-label="Permalink to "Key Features ✨""></a></h2><ul><li><strong>Universal Ingestion</strong>: Connect to Google Workspace, Microsoft 365, and standard IMAP servers to perform initial bulk imports and maintain continuous, real-time synchronization.</li><li><strong>Secure & Efficient Storage</strong>: Emails are stored in the standard <code>.eml</code> format. The system uses deduplication and compression to minimize storage costs. All data is encrypted at rest.</li><li><strong>Pluggable Storage Backends</strong>: Support both local filesystem storage and S3-compatible object storage (like AWS S3 or MinIO).</li><li><strong>Powerful Search & eDiscovery</strong>: A high-performance search engine indexes the full text of emails and attachments (PDF, DOCX, etc.).</li><li><strong>Compliance & Retention</strong>: Define granular retention policies to automatically manage the lifecycle of your data. Place legal holds on communications to prevent deletion during litigation (TBD).</li><li><strong>Comprehensive Auditing</strong>: An immutable audit trail logs all system activities, ensuring you have a clear record of who accessed what and when (TBD).</li></ul><h2 id="installation-🚀" tabindex="-1">Installation 🚀 <a class="header-anchor" href="#installation-🚀" aria-label="Permalink to "Installation 🚀""></a></h2><p>To get your own instance of Open Archiver running, follow our detailed installation guide:</p><ul><li><a href="./user-guides/installation.html">Installation Guide</a></li></ul><h2 id="data-source-configuration-🔌" tabindex="-1">Data Source Configuration 🔌 <a class="header-anchor" href="#data-source-configuration-🔌" aria-label="Permalink to "Data Source Configuration 🔌""></a></h2><p>After deploying the application, you will need to configure one or more ingestion sources to begin archiving emails. Follow our detailed guides to connect to your email provider:</p><ul><li><a href="./user-guides/email-providers/google-workspace.html">Connecting to Google Workspace</a></li><li><a href="./user-guides/email-providers/microsoft-365.html">Connecting to Microsoft 365</a></li><li><a href="./user-guides/email-providers/imap.html">Connecting to a Generic IMAP Server</a></li></ul><h2 id="contributing-❤️" tabindex="-1">Contributing ❤️ <a class="header-anchor" href="#contributing-❤️" aria-label="Permalink to "Contributing ❤️""></a></h2><p>We welcome contributions from the community!</p><ul><li><strong>Reporting Bugs</strong>: If you find a bug, please open an issue on our GitHub repository.</li><li><strong>Suggesting Enhancements</strong>: Have an idea for a new feature? We'd love to hear it. Open an issue to start the discussion.</li><li><strong>Code Contributions</strong>: If you'd like to contribute code, please fork the repository and submit a pull request.</li></ul><p>Please read our <code>CONTRIBUTING.md</code> file for more details on our code of conduct and the process for submitting pull requests.</p></div></div></main><footer class="VPDocFooter" data-v-ef58e7af data-v-28097769><!--[--><!--]--><!----><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-28097769><span class="visually-hidden" id="doc-footer-aria-label" data-v-28097769>Pager</span><div class="pager" data-v-28097769><!----></div><div class="pager" data-v-28097769><a class="VPLink link pager-link next" href="/user-guides/installation.html" data-v-28097769><!--[--><span class="desc" data-v-28097769>Next page</span><span class="title" data-v-28097769>Installation</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><!----><!--[--><!--]--></div></div>
|
||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_archived-email.md\":\"Di9i_OKb\",\"api_auth.md\":\"Kt3iNEMn\",\"api_authentication.md\":\"DDCP-z1j\",\"api_dashboard.md\":\"CqvOiGVx\",\"api_index.md\":\"DFnFK07E\",\"api_ingestion.md\":\"DOeFHoQv\",\"api_search.md\":\"BRCIJTXq\",\"api_storage.md\":\"DKUKvFrO\",\"index.md\":\"9PKJf5H1\",\"services_index.md\":\"BLn224J3\",\"services_storage-service.md\":\"Dqpyxk77\",\"summary.md\":\"5seSND4L\",\"user-guides_email-providers_google-workspace.md\":\"BWo_12De\",\"user-guides_email-providers_imap.md\":\"Cdk3vG_S\",\"user-guides_email-providers_index.md\":\"DPaSFiTO\",\"user-guides_email-providers_microsoft-365.md\":\"QHHVfYxW\",\"user-guides_installation.md\":\"xXTSUcq4\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Open Archiver\",\"description\":\"Official documentation for the Open Archiver project.\",\"base\":\"/\",\"head\":[],\"router\":{\"prefetchLinks\":true},\"appearance\":true,\"themeConfig\":{\"search\":{\"provider\":\"local\"},\"logo\":{\"src\":\"/logo-sq.svg\"},\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"Github\",\"link\":\"https://github.com/LogicLabs-OU/OpenArchiver\"},{\"text\":\"Website\",\"link\":\"https://openarchiver.com/\"},{\"text\":\"Discord\",\"link\":\"https://discord.gg/Qpv4BmHp\"}],\"sidebar\":[{\"text\":\"User Guides\",\"items\":[{\"text\":\"Get Started\",\"link\":\"/\"},{\"text\":\"Installation\",\"link\":\"/user-guides/installation\"},{\"text\":\"Email Providers\",\"link\":\"/user-guides/email-providers/\",\"collapsed\":true,\"items\":[{\"text\":\"Google Workspace\",\"link\":\"/user-guides/email-providers/google-workspace\"},{\"text\":\"Generic IMAP Server\",\"link\":\"/user-guides/email-providers/imap\"},{\"text\":\"Microsoft 365\",\"link\":\"/user-guides/email-providers/microsoft-365\"}]}]},{\"text\":\"API Reference\",\"items\":[{\"text\":\"Overview\",\"link\":\"/api/\"},{\"text\":\"Authentication\",\"link\":\"/api/authentication\"},{\"text\":\"Auth\",\"link\":\"/api/auth\"},{\"text\":\"Archived Email\",\"link\":\"/api/archived-email\"},{\"text\":\"Dashboard\",\"link\":\"/api/dashboard\"},{\"text\":\"Ingestion\",\"link\":\"/api/ingestion\"},{\"text\":\"Search\",\"link\":\"/api/search\"},{\"text\":\"Storage\",\"link\":\"/api/storage\"}]},{\"text\":\"Services\",\"items\":[{\"text\":\"Overview\",\"link\":\"/services/\"},{\"text\":\"Storage Service\",\"link\":\"/services/storage-service\"}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||
|
||
</body>
|
||
</html> |