mirror of
https://github.com/LogicLabs-OU/OpenArchiver.git
synced 2026-04-06 00:31:57 +02:00
deploy: e9a65f9672
This commit is contained in:
wayneshn
4
404.html
4
404.html
@@ -9,7 +9,7 @@
|
||||
<link rel="preload stylesheet" href="/assets/style.BZzyQG4l.css" as="style">
|
||||
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
|
||||
|
||||
<script type="module" src="/assets/app.Dyig87Ye.js"></script>
|
||||
<script type="module" src="/assets/app.BFcN5a0y.js"></script>
|
||||
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
|
||||
<script defer src="https://analytics.zenceipt.com/script.js" data-website-id="2c8b452e-eab5-4f82-8ead-902d8f8b976f"></script>
|
||||
<link rel="icon" href="/logo-sq.svg">
|
||||
@@ -18,7 +18,7 @@
|
||||
</head>
|
||||
<body>
|
||||
<div id="app"></div>
|
||||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_archived-email.md\":\"rYKCgF6R\",\"api_auth.md\":\"BqZ6wN0q\",\"api_authentication.md\":\"CyDXtQYg\",\"api_dashboard.md\":\"lu70c-Pf\",\"api_index.md\":\"DFnFK07E\",\"api_ingestion.md\":\"B8EOVCr7\",\"api_rate-limiting.md\":\"a1m1O0N8\",\"api_search.md\":\"B8tLtEbg\",\"api_storage.md\":\"DKUKvFrO\",\"index.md\":\"9PKJf5H1\",\"services_iam-service.md\":\"DLjefPo_\",\"services_iam-service_iam-policy.md\":\"BMP46V9x\",\"services_index.md\":\"BLn224J3\",\"services_storage-service.md\":\"Bgos1Y2E\",\"summary.md\":\"5seSND4L\",\"user-guides_email-providers_eml.md\":\"a288N17s\",\"user-guides_email-providers_google-workspace.md\":\"BWo_12De\",\"user-guides_email-providers_imap.md\":\"DnuaRv-0\",\"user-guides_email-providers_index.md\":\"DLhwJ4vK\",\"user-guides_email-providers_microsoft-365.md\":\"QHHVfYxW\",\"user-guides_email-providers_pst.md\":\"c6jOF8P1\",\"user-guides_installation.md\":\"BuO7QeKe\",\"user-guides_settings_system.md\":\"DZw4puzm\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Open Archiver Docs\",\"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/MTtD7BhuTQ\"}],\"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\":\"Generic IMAP Server\",\"link\":\"/user-guides/email-providers/imap\"},{\"text\":\"Google Workspace\",\"link\":\"/user-guides/email-providers/google-workspace\"},{\"text\":\"Microsoft 365\",\"link\":\"/user-guides/email-providers/microsoft-365\"},{\"text\":\"EML Import\",\"link\":\"/user-guides/email-providers/eml\"},{\"text\":\"PST Import\",\"link\":\"/user-guides/email-providers/pst\"}]},{\"text\":\"Settings\",\"collapsed\":true,\"items\":[{\"text\":\"System\",\"link\":\"/user-guides/settings/system\"}]}]},{\"text\":\"API Reference\",\"items\":[{\"text\":\"Overview\",\"link\":\"/api/\"},{\"text\":\"Authentication\",\"link\":\"/api/authentication\"},{\"text\":\"Rate Limiting\",\"link\":\"/api/rate-limiting\"},{\"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\"},{\"text\":\"IAM Service\",\"items\":[{\"text\":\"IAM Policies\",\"link\":\"/services/iam-service/iam-policy\"}]}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||||
<script>window.__VP_HASH_MAP__=JSON.parse("{\"api_archived-email.md\":\"rYKCgF6R\",\"api_auth.md\":\"BqZ6wN0q\",\"api_authentication.md\":\"CyDXtQYg\",\"api_dashboard.md\":\"lu70c-Pf\",\"api_index.md\":\"DFnFK07E\",\"api_ingestion.md\":\"B8EOVCr7\",\"api_rate-limiting.md\":\"a1m1O0N8\",\"api_search.md\":\"B8tLtEbg\",\"api_storage.md\":\"DKUKvFrO\",\"index.md\":\"9PKJf5H1\",\"services_iam-service.md\":\"DLjefPo_\",\"services_iam-service_iam-policy.md\":\"BMP46V9x\",\"services_index.md\":\"BLn224J3\",\"services_storage-service.md\":\"Bgos1Y2E\",\"summary.md\":\"5seSND4L\",\"user-guides_email-providers_eml.md\":\"a288N17s\",\"user-guides_email-providers_google-workspace.md\":\"BWo_12De\",\"user-guides_email-providers_imap.md\":\"DnuaRv-0\",\"user-guides_email-providers_index.md\":\"C3XNPTNj\",\"user-guides_email-providers_mbox.md\":\"Cavm6di7\",\"user-guides_email-providers_microsoft-365.md\":\"QHHVfYxW\",\"user-guides_email-providers_pst.md\":\"c6jOF8P1\",\"user-guides_installation.md\":\"DW7xJzZQ\",\"user-guides_settings_system.md\":\"DZw4puzm\",\"user-guides_upgrade-and-migration_meilisearch-upgrade.md\":\"xQXm1E12\",\"user-guides_upgrade-and-migration_upgrade.md\":\"DieppEdN\"}");window.__VP_SITE_DATA__=JSON.parse("{\"lang\":\"en-US\",\"dir\":\"ltr\",\"title\":\"Open Archiver Docs\",\"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/MTtD7BhuTQ\"}],\"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\":\"Generic IMAP Server\",\"link\":\"/user-guides/email-providers/imap\"},{\"text\":\"Google Workspace\",\"link\":\"/user-guides/email-providers/google-workspace\"},{\"text\":\"Microsoft 365\",\"link\":\"/user-guides/email-providers/microsoft-365\"},{\"text\":\"EML Import\",\"link\":\"/user-guides/email-providers/eml\"},{\"text\":\"PST Import\",\"link\":\"/user-guides/email-providers/pst\"},{\"text\":\"Mbox Import\",\"link\":\"/user-guides/email-providers/mbox\"}]},{\"text\":\"Settings\",\"collapsed\":true,\"items\":[{\"text\":\"System\",\"link\":\"/user-guides/settings/system\"}]},{\"text\":\"Upgrading and Migration\",\"collapsed\":true,\"items\":[{\"text\":\"Upgrading\",\"link\":\"/user-guides/upgrade-and-migration/upgrade\"},{\"text\":\"Meilisearch Upgrade\",\"link\":\"/user-guides/upgrade-and-migration/meilisearch-upgrade\"}]}]},{\"text\":\"API Reference\",\"items\":[{\"text\":\"Overview\",\"link\":\"/api/\"},{\"text\":\"Authentication\",\"link\":\"/api/authentication\"},{\"text\":\"Rate Limiting\",\"link\":\"/api/rate-limiting\"},{\"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\"},{\"text\":\"IAM Service\",\"items\":[{\"text\":\"IAM Policies\",\"link\":\"/services/iam-service/iam-policy\"}]}]}]},\"locales\":{},\"scrollOffset\":134,\"cleanUrls\":false}");</script>
|
||||
|
||||
</body>
|
||||
</html>
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +1 @@
|
||||
import{t as p}from"./chunks/theme.Bdp0zZ6c.js";import{R as s,a2 as i,a3 as u,a4 as c,a5 as l,a6 as f,a7 as d,a8 as m,a9 as h,aa as g,ab as A,d as v,u as y,v as C,s as P,ac as b,ad as w,ae as R,af as E}from"./chunks/framework.S-Qvb3wi.js";function r(e){if(e.extends){const a=r(e.extends);return{...a,...e,async enhanceApp(t){a.enhanceApp&&await a.enhanceApp(t),e.enhanceApp&&await e.enhanceApp(t)}}}return e}const n=r(p),S=v({name:"VitePressApp",setup(){const{site:e,lang:a,dir:t}=y();return C(()=>{P(()=>{document.documentElement.lang=a.value,document.documentElement.dir=t.value})}),e.value.router.prefetchLinks&&b(),w(),R(),n.setup&&n.setup(),()=>E(n.Layout)}});async function T(){globalThis.__VITEPRESS__=!0;const e=_(),a=D();a.provide(u,e);const t=c(e.route);return a.provide(l,t),a.component("Content",f),a.component("ClientOnly",d),Object.defineProperties(a.config.globalProperties,{$frontmatter:{get(){return t.frontmatter.value}},$params:{get(){return t.page.value.params}}}),n.enhanceApp&&await n.enhanceApp({app:a,router:e,siteData:m}),{app:a,router:e,data:t}}function D(){return A(S)}function _(){let e=s;return h(a=>{let t=g(a),o=null;return t&&(e&&(t=t.replace(/\.js$/,".lean.js")),o=import(t)),s&&(e=!1),o},n.NotFound)}s&&T().then(({app:e,router:a,data:t})=>{a.go().then(()=>{i(a.route,t.site),e.mount("#app")})});export{T as createApp};
|
||||
import{t as p}from"./chunks/theme.DKUzEMCL.js";import{R as s,a2 as i,a3 as u,a4 as c,a5 as l,a6 as f,a7 as d,a8 as m,a9 as h,aa as g,ab as A,d as v,u as y,v as C,s as P,ac as b,ad as w,ae as R,af as E}from"./chunks/framework.S-Qvb3wi.js";function r(e){if(e.extends){const a=r(e.extends);return{...a,...e,async enhanceApp(t){a.enhanceApp&&await a.enhanceApp(t),e.enhanceApp&&await e.enhanceApp(t)}}}return e}const n=r(p),S=v({name:"VitePressApp",setup(){const{site:e,lang:a,dir:t}=y();return C(()=>{P(()=>{document.documentElement.lang=a.value,document.documentElement.dir=t.value})}),e.value.router.prefetchLinks&&b(),w(),R(),n.setup&&n.setup(),()=>E(n.Layout)}});async function T(){globalThis.__VITEPRESS__=!0;const e=_(),a=D();a.provide(u,e);const t=c(e.route);return a.provide(l,t),a.component("Content",f),a.component("ClientOnly",d),Object.defineProperties(a.config.globalProperties,{$frontmatter:{get(){return t.frontmatter.value}},$params:{get(){return t.page.value.params}}}),n.enhanceApp&&await n.enhanceApp({app:a,router:e,siteData:m}),{app:a,router:e,data:t}}function D(){return A(S)}function _(){let e=s;return h(a=>{let t=g(a),o=null;return t&&(e&&(t=t.replace(/\.js$/,".lean.js")),o=import(t)),s&&(e=!1),o},n.NotFound)}s&&T().then(({app:e,router:a,data:t})=>{a.go().then(()=>{i(a.route,t.site),e.mount("#app")})});export{T as createApp};
|
||||
1
assets/chunks/@localSearchIndexroot.C1kOZJMQ.js
Normal file
1
assets/chunks/@localSearchIndexroot.C1kOZJMQ.js
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
@@ -1 +1 @@
|
||||
import{_ as r,c as i,o,ag as a}from"./chunks/framework.S-Qvb3wi.js";const h=JSON.parse('{"title":"Connecting Email Providers","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/email-providers/index.md","filePath":"user-guides/email-providers/index.md"}'),t={name:"user-guides/email-providers/index.md"};function s(n,e,l,c,d,m){return o(),i("div",null,e[0]||(e[0]=[a('<h1 id="connecting-email-providers" tabindex="-1">Connecting Email Providers <a class="header-anchor" href="#connecting-email-providers" aria-label="Permalink to "Connecting Email Providers""></a></h1><p>Open Archiver can connect to a variety of email sources to ingest and archive your emails. This section provides guides for connecting to popular email providers.</p><p>Choose your provider from the list below to get started:</p><ul><li><a href="./google-workspace.html">Google Workspace</a></li><li><a href="./microsoft-365.html">Microsoft 365</a></li><li><a href="./imap.html">Generic IMAP Server</a></li><li><a href="./eml.html">EML Import</a></li><li><a href="./pst.html">PST Import</a></li></ul>',4)]))}const _=r(t,[["render",s]]);export{h as __pageData,_ as default};
|
||||
import{_ as r,c as i,o,ag as a}from"./chunks/framework.S-Qvb3wi.js";const h=JSON.parse('{"title":"Connecting Email Providers","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/email-providers/index.md","filePath":"user-guides/email-providers/index.md"}'),t={name:"user-guides/email-providers/index.md"};function l(s,e,n,c,d,m){return o(),i("div",null,e[0]||(e[0]=[a('<h1 id="connecting-email-providers" tabindex="-1">Connecting Email Providers <a class="header-anchor" href="#connecting-email-providers" aria-label="Permalink to "Connecting Email Providers""></a></h1><p>Open Archiver can connect to a variety of email sources to ingest and archive your emails. This section provides guides for connecting to popular email providers.</p><p>Choose your provider from the list below to get started:</p><ul><li><a href="./google-workspace.html">Google Workspace</a></li><li><a href="./microsoft-365.html">Microsoft 365</a></li><li><a href="./imap.html">Generic IMAP Server</a></li><li><a href="./eml.html">EML Import</a></li><li><a href="./pst.html">PST Import</a></li><li><a href="./mbox.html">Mbox Import</a></li></ul>',4)]))}const _=r(t,[["render",l]]);export{h as __pageData,_ as default};
|
||||
@@ -1 +1 @@
|
||||
import{_ as r,c as i,o,ag as a}from"./chunks/framework.S-Qvb3wi.js";const h=JSON.parse('{"title":"Connecting Email Providers","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/email-providers/index.md","filePath":"user-guides/email-providers/index.md"}'),t={name:"user-guides/email-providers/index.md"};function s(n,e,l,c,d,m){return o(),i("div",null,e[0]||(e[0]=[a("",4)]))}const _=r(t,[["render",s]]);export{h as __pageData,_ as default};
|
||||
import{_ as r,c as i,o,ag as a}from"./chunks/framework.S-Qvb3wi.js";const h=JSON.parse('{"title":"Connecting Email Providers","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/email-providers/index.md","filePath":"user-guides/email-providers/index.md"}'),t={name:"user-guides/email-providers/index.md"};function l(s,e,n,c,d,m){return o(),i("div",null,e[0]||(e[0]=[a("",4)]))}const _=r(t,[["render",l]]);export{h as __pageData,_ as default};
|
||||
1
assets/user-guides_email-providers_mbox.md.Cavm6di7.js
Normal file
1
assets/user-guides_email-providers_mbox.md.Cavm6di7.js
Normal file
@@ -0,0 +1 @@
|
||||
import{_ as o,c as t,o as r,ag as i}from"./chunks/framework.S-Qvb3wi.js";const m=JSON.parse('{"title":"Mbox Ingestion","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/email-providers/mbox.md","filePath":"user-guides/email-providers/mbox.md"}'),l={name:"user-guides/email-providers/mbox.md"};function a(n,e,s,d,c,u){return r(),t("div",null,e[0]||(e[0]=[i('<h1 id="mbox-ingestion" tabindex="-1">Mbox Ingestion <a class="header-anchor" href="#mbox-ingestion" aria-label="Permalink to "Mbox Ingestion""></a></h1><p>Mbox is a common format for storing email messages. This guide will walk you through the process of ingesting mbox files into OpenArchiver.</p><h2 id="_1-exporting-from-your-email-client" tabindex="-1">1. Exporting from Your Email Client <a class="header-anchor" href="#_1-exporting-from-your-email-client" aria-label="Permalink to "1. Exporting from Your Email Client""></a></h2><p>Most email clients that support mbox exports will allow you to export a folder of emails as a single <code>.mbox</code> file. Here are the general steps:</p><ul><li><strong>Mozilla Thunderbird</strong>: Right-click on a folder, select <strong>ImportExportTools NG</strong>, and then choose <strong>Export folder</strong>.</li><li><strong>Gmail</strong>: You can use Google Takeout to export your emails in mbox format.</li><li><strong>Other Clients</strong>: Refer to your email client's documentation for instructions on how to export emails to an mbox file.</li></ul><h2 id="_2-uploading-to-openarchiver" tabindex="-1">2. Uploading to OpenArchiver <a class="header-anchor" href="#_2-uploading-to-openarchiver" aria-label="Permalink to "2. Uploading to OpenArchiver""></a></h2><p>Once you have your <code>.mbox</code> file, you can upload it to OpenArchiver through the web interface.</p><ol><li>Navigate to the <strong>Ingestion</strong> page.</li><li>Click on the <strong>New Ingestion</strong> button.</li><li>Select <strong>Mbox</strong> as the source type.</li><li>Upload your <code>.mbox</code> file.</li></ol><h2 id="_3-folder-structure" tabindex="-1">3. Folder Structure <a class="header-anchor" href="#_3-folder-structure" aria-label="Permalink to "3. Folder Structure""></a></h2><p>OpenArchiver will attempt to preserve the original folder structure of your emails. This is done by inspecting the following email headers:</p><ul><li><code>X-Gmail-Labels</code>: Used by Gmail to store labels.</li><li><code>X-Folder</code>: A custom header used by some email clients like Thunderbird.</li></ul><p>If neither of these headers is present, the emails will be ingested into the root of the archive.</p>',12)]))}const p=o(l,[["render",a]]);export{m as __pageData,p as default};
|
||||
@@ -0,0 +1 @@
|
||||
import{_ as o,c as t,o as r,ag as i}from"./chunks/framework.S-Qvb3wi.js";const m=JSON.parse('{"title":"Mbox Ingestion","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/email-providers/mbox.md","filePath":"user-guides/email-providers/mbox.md"}'),l={name:"user-guides/email-providers/mbox.md"};function a(n,e,s,d,c,u){return r(),t("div",null,e[0]||(e[0]=[i("",12)]))}const p=o(l,[["render",a]]);export{m as __pageData,p as default};
|
||||
@@ -1 +0,0 @@
|
||||
import{_ as t,c as o,o as a,ag as i}from"./chunks/framework.S-Qvb3wi.js";const u=JSON.parse('{"title":"Installation Guide","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/installation.md","filePath":"user-guides/installation.md"}'),s={name:"user-guides/installation.md"};function r(n,e,d,c,l,h){return a(),o("div",null,e[0]||(e[0]=[i("",93)]))}const g=t(s,[["render",r]]);export{u as __pageData,g as default};
|
||||
File diff suppressed because one or more lines are too long
1
assets/user-guides_installation.md.DW7xJzZQ.lean.js
Normal file
1
assets/user-guides_installation.md.DW7xJzZQ.lean.js
Normal file
@@ -0,0 +1 @@
|
||||
import{_ as s,c as i,o as t,ag as a}from"./chunks/framework.S-Qvb3wi.js";const k=JSON.parse('{"title":"Installation Guide","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/installation.md","filePath":"user-guides/installation.md"}'),o={name:"user-guides/installation.md"};function n(r,e,l,d,h,c){return t(),i("div",null,e[0]||(e[0]=[a("",98)]))}const g=s(o,[["render",n]]);export{k as __pageData,g as default};
|
||||
@@ -0,0 +1,11 @@
|
||||
import{_ as i,c as s,o as a,ag as t}from"./chunks/framework.S-Qvb3wi.js";const u=JSON.parse('{"title":"Upgrading Meilisearch","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/upgrade-and-migration/meilisearch-upgrade.md","filePath":"user-guides/upgrade-and-migration/meilisearch-upgrade.md"}'),n={name:"user-guides/upgrade-and-migration/meilisearch-upgrade.md"};function r(o,e,p,l,h,d){return a(),s("div",null,e[0]||(e[0]=[t(`<h1 id="upgrading-meilisearch" tabindex="-1">Upgrading Meilisearch <a class="header-anchor" href="#upgrading-meilisearch" aria-label="Permalink to "Upgrading Meilisearch""></a></h1><p>Meilisearch, the search engine used by Open Archiver, requires a manual data migration process when upgrading to a new version. This is because Meilisearch databases are only compatible with the specific version that created them.</p><p>If an Open Archiver upgrade includes a major Meilisearch version change, you will need to migrate your search index by following the process below.</p><h2 id="migration-process-overview" tabindex="-1">Migration Process Overview <a class="header-anchor" href="#migration-process-overview" aria-label="Permalink to "Migration Process Overview""></a></h2><p>For self-hosted instances using Docker Compose (as recommended), the migration process involves creating a data dump from your current Meilisearch instance, upgrading the Docker image, and then importing that dump into the new version.</p><h3 id="step-1-create-a-dump" tabindex="-1">Step 1: Create a Dump <a class="header-anchor" href="#step-1-create-a-dump" aria-label="Permalink to "Step 1: Create a Dump""></a></h3><p>Before upgrading, you must create a dump of your existing Meilisearch data. You can do this by sending a POST request to the <code>/dumps</code> endpoint of the Meilisearch API.</p><ol><li><p><strong>Find your Meilisearch container name</strong>:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compose</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> ps</span></span></code></pre></div><p>Look for the service name that corresponds to Meilisearch, usually <code>meilisearch</code>.</p></li><li><p><strong>Execute the dump command</strong>: You will need your Meilisearch Admin API key, which can be found in your <code>.env</code> file as <code>MEILI_MASTER_KEY</code>.</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">curl</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -X</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> POST</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> 'http://localhost:7700/dumps'</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> \\</span></span>
|
||||
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -H</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> "Authorization: Bearer YOUR_MEILI_MASTER_KEY"</span></span></code></pre></div><p>This will start the dump creation process. The dump file will be created inside the <code>meili_data</code> volume used by the Meilisearch container.</p></li><li><p><strong>Monitor the dump status</strong>: The dump creation request returns a <code>taskUid</code>. You can use this to check the status of the dump.</p><p>For more details on dump and import, see the <a href="https://www.meilisearch.com/docs/learn/update_and_migration/updating" target="_blank" rel="noreferrer">official Meilisearch documentation</a>.</p></li></ol><h3 id="step-2-upgrade-your-open-archiver-instance" tabindex="-1">Step 2: Upgrade Your Open Archiver Instance <a class="header-anchor" href="#step-2-upgrade-your-open-archiver-instance" aria-label="Permalink to "Step 2: Upgrade Your Open Archiver Instance""></a></h3><p>Once the dump is successfully created, you can proceed with the standard Open Archiver upgrade process.</p><ol><li><p><strong>Pull the latest changes and Docker images</strong>:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> pull</span></span>
|
||||
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compose</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> pull</span></span></code></pre></div></li><li><p><strong>Stop the running services</strong>:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compose</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> down</span></span></code></pre></div></li></ol><h3 id="step-3-import-the-dump" tabindex="-1">Step 3: Import the Dump <a class="header-anchor" href="#step-3-import-the-dump" aria-label="Permalink to "Step 3: Import the Dump""></a></h3><p>Now, you need to restart the services while telling Meilisearch to import from your dump file.</p><ol><li><p><strong>Modify <code>docker-compose.yml</code></strong>: You need to temporarily add the <code>--import-dump</code> flag to the Meilisearch service command. Find the <code>meilisearch</code> service in your <code>docker-compose.yml</code> and modify the <code>command</code> section.</p><p>You will need the name of your dump file. It will be a <code>.dump</code> file located in the directory mapped to <code>/meili_data</code> inside the container.</p><div class="language-yaml vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">yaml</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;">services</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
||||
<span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;"> meilisearch</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
||||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"> # ... other service config</span></span>
|
||||
<span class="line"><span style="--shiki-light:#22863A;--shiki-dark:#85E89D;"> command</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
|
||||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> [</span></span>
|
||||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '--master-key=\${MEILI_MASTER_KEY}'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '--env=production'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||||
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> '--import-dump=/meili_data/dumps/YOUR_DUMP_FILE.dump'</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">,</span></span>
|
||||
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> ]</span></span></code></pre></div></li><li><p><strong>Restart the services</strong>:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compose</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> up</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -d</span></span></code></pre></div><p>Meilisearch will now start and import the data from the dump file. This may take some time depending on the size of your index.</p></li></ol><h3 id="step-4-clean-up" tabindex="-1">Step 4: Clean Up <a class="header-anchor" href="#step-4-clean-up" aria-label="Permalink to "Step 4: Clean Up""></a></h3><p>Once the import is complete and you have verified that your search is working correctly, you should remove the <code>--import-dump</code> flag from your <code>docker-compose.yml</code> to prevent it from running on every startup.</p><ol><li><strong>Remove the <code>--import-dump</code> line</strong> from the <code>command</code> section of the <code>meilisearch</code> service in <code>docker-compose.yml</code>.</li><li><strong>Restart the services</strong> one last time:<div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compose</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> up</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -d</span></span></code></pre></div></li></ol><p>Your Meilisearch instance is now upgraded and running with your migrated data.</p><p>For more advanced scenarios or troubleshooting, please refer to the <strong><a href="https://www.meilisearch.com/docs/learn/update_and_migration/updating" target="_blank" rel="noreferrer">official Meilisearch migration guide</a></strong>.</p>`,19)]))}const g=i(n,[["render",r]]);export{u as __pageData,g as default};
|
||||
@@ -0,0 +1 @@
|
||||
import{_ as i,c as s,o as a,ag as t}from"./chunks/framework.S-Qvb3wi.js";const u=JSON.parse('{"title":"Upgrading Meilisearch","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/upgrade-and-migration/meilisearch-upgrade.md","filePath":"user-guides/upgrade-and-migration/meilisearch-upgrade.md"}'),n={name:"user-guides/upgrade-and-migration/meilisearch-upgrade.md"};function r(o,e,p,l,h,d){return a(),s("div",null,e[0]||(e[0]=[t("",19)]))}const g=i(n,[["render",r]]);export{u as __pageData,g as default};
|
||||
@@ -0,0 +1 @@
|
||||
import{_ as e,c as i,o as s,ag as t}from"./chunks/framework.S-Qvb3wi.js";const g=JSON.parse('{"title":"Upgrading Your Instance","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/upgrade-and-migration/upgrade.md","filePath":"user-guides/upgrade-and-migration/upgrade.md"}'),n={name:"user-guides/upgrade-and-migration/upgrade.md"};function r(o,a,l,p,h,d){return s(),i("div",null,a[0]||(a[0]=[t('<h1 id="upgrading-your-instance" tabindex="-1">Upgrading Your Instance <a class="header-anchor" href="#upgrading-your-instance" aria-label="Permalink to "Upgrading Your Instance""></a></h1><p>This guide provides instructions for upgrading your Open Archiver instance to the latest version.</p><h2 id="checking-for-new-versions" tabindex="-1">Checking for New Versions <a class="header-anchor" href="#checking-for-new-versions" aria-label="Permalink to "Checking for New Versions""></a></h2><p>Open Archiver automatically checks for new versions and will display a notification in the footer of the web interface when an update is available. You can find a list of all releases and their release notes on the <a href="https://github.com/LogicLabs-OU/OpenArchiver/releases" target="_blank" rel="noreferrer">GitHub Releases</a> page.</p><h2 id="upgrading-your-instance-1" tabindex="-1">Upgrading Your Instance <a class="header-anchor" href="#upgrading-your-instance-1" aria-label="Permalink to "Upgrading Your Instance""></a></h2><p>To upgrade your Open Archiver instance, follow these steps:</p><ol><li><p><strong>Pull the latest changes from the repository</strong>:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">git</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> pull</span></span></code></pre></div></li><li><p><strong>Pull the latest Docker images</strong>:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compose</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> pull</span></span></code></pre></div></li><li><p><strong>Restart the services with the new images</strong>:</p><div class="language-bash vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">bash</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;">docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> compose</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> up</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -d</span></span></code></pre></div></li></ol><p>This will restart your Open Archiver instance with the latest version of the application.</p><h2 id="migrating-data" tabindex="-1">Migrating Data <a class="header-anchor" href="#migrating-data" aria-label="Permalink to "Migrating Data""></a></h2><p>When you upgrade to a new version, database migrations are applied automatically when the application starts up. This ensures that your database schema is always up-to-date with the latest version of the application.</p><p>No manual intervention is required for database migrations.</p><h2 id="upgrading-meilisearch" tabindex="-1">Upgrading Meilisearch <a class="header-anchor" href="#upgrading-meilisearch" aria-label="Permalink to "Upgrading Meilisearch""></a></h2><p>When an Open Archiver update includes a major version change for Meilisearch, you will need to manually migrate your search data. This process is not covered by the standard upgrade commands.</p><p>For detailed instructions, please see the <a href="./meilisearch-upgrade.html">Meilisearch Upgrade Guide</a>.</p>',14)]))}const u=e(n,[["render",r]]);export{g as __pageData,u as default};
|
||||
@@ -0,0 +1 @@
|
||||
import{_ as e,c as i,o as s,ag as t}from"./chunks/framework.S-Qvb3wi.js";const g=JSON.parse('{"title":"Upgrading Your Instance","description":"","frontmatter":{},"headers":[],"relativePath":"user-guides/upgrade-and-migration/upgrade.md","filePath":"user-guides/upgrade-and-migration/upgrade.md"}'),n={name:"user-guides/upgrade-and-migration/upgrade.md"};function r(o,a,l,p,h,d){return s(),i("div",null,a[0]||(a[0]=[t("",14)]))}const u=e(n,[["render",r]]);export{g as __pageData,u as default};
|
||||
@@ -1 +1 @@
|
||||
{"api_archived-email.md":"rYKCgF6R","api_auth.md":"BqZ6wN0q","api_authentication.md":"CyDXtQYg","api_dashboard.md":"lu70c-Pf","api_index.md":"DFnFK07E","api_ingestion.md":"B8EOVCr7","api_rate-limiting.md":"a1m1O0N8","api_search.md":"B8tLtEbg","api_storage.md":"DKUKvFrO","index.md":"9PKJf5H1","services_iam-service.md":"DLjefPo_","services_iam-service_iam-policy.md":"BMP46V9x","services_index.md":"BLn224J3","services_storage-service.md":"Bgos1Y2E","summary.md":"5seSND4L","user-guides_email-providers_eml.md":"a288N17s","user-guides_email-providers_google-workspace.md":"BWo_12De","user-guides_email-providers_imap.md":"DnuaRv-0","user-guides_email-providers_index.md":"DLhwJ4vK","user-guides_email-providers_microsoft-365.md":"QHHVfYxW","user-guides_email-providers_pst.md":"c6jOF8P1","user-guides_installation.md":"BuO7QeKe","user-guides_settings_system.md":"DZw4puzm"}
|
||||
{"api_archived-email.md":"rYKCgF6R","api_auth.md":"BqZ6wN0q","api_authentication.md":"CyDXtQYg","api_dashboard.md":"lu70c-Pf","api_index.md":"DFnFK07E","api_ingestion.md":"B8EOVCr7","api_rate-limiting.md":"a1m1O0N8","api_search.md":"B8tLtEbg","api_storage.md":"DKUKvFrO","index.md":"9PKJf5H1","services_iam-service.md":"DLjefPo_","services_iam-service_iam-policy.md":"BMP46V9x","services_index.md":"BLn224J3","services_storage-service.md":"Bgos1Y2E","summary.md":"5seSND4L","user-guides_email-providers_eml.md":"a288N17s","user-guides_email-providers_google-workspace.md":"BWo_12De","user-guides_email-providers_imap.md":"DnuaRv-0","user-guides_email-providers_index.md":"C3XNPTNj","user-guides_email-providers_mbox.md":"Cavm6di7","user-guides_email-providers_microsoft-365.md":"QHHVfYxW","user-guides_email-providers_pst.md":"c6jOF8P1","user-guides_installation.md":"DW7xJzZQ","user-guides_settings_system.md":"DZw4puzm","user-guides_upgrade-and-migration_meilisearch-upgrade.md":"xQXm1E12","user-guides_upgrade-and-migration_upgrade.md":"DieppEdN"}
|
||||
|
||||
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
27
user-guides/email-providers/mbox.html
Normal file
27
user-guides/email-providers/mbox.html
Normal file
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
File diff suppressed because one or more lines are too long
37
user-guides/upgrade-and-migration/meilisearch-upgrade.html
Normal file
37
user-guides/upgrade-and-migration/meilisearch-upgrade.html
Normal file
File diff suppressed because one or more lines are too long
27
user-guides/upgrade-and-migration/upgrade.html
Normal file
27
user-guides/upgrade-and-migration/upgrade.html
Normal file
File diff suppressed because one or more lines are too long
Reference in New Issue
Block a user