mirror of
https://github.com/LogicLabs-OU/OpenArchiver.git
synced 2026-04-06 00:31:57 +02:00
33 lines
32 KiB
HTML
33 lines
32 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>Installation Guide | 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.Byz1HnQd.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.1KUHhmPd.js">
|
||
<link rel="modulepreload" href="/assets/chunks/framework.S-Qvb3wi.js">
|
||
<link rel="modulepreload" href="/assets/user-guides_installation.md.Lx-5aly3.lean.js">
|
||
<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="../assets/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" href="/" tabindex="0" data-v-e1b4cdce data-v-a32d3490><!--[--><span data-v-a32d3490>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/user-guides/email-providers/" tabindex="0" data-v-e1b4cdce data-v-a32d3490><!--[--><span data-v-a32d3490>User Guides</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 _user-guides_installation" data-v-ef58e7af><div><h1 id="installation-guide" tabindex="-1">Installation Guide <a class="header-anchor" href="#installation-guide" aria-label="Permalink to "Installation Guide""></a></h1><p>This guide will walk you through setting up Open Archiver using Docker Compose. This is the recommended method for deploying the application.</p><h2 id="prerequisites" tabindex="-1">Prerequisites <a class="header-anchor" href="#prerequisites" aria-label="Permalink to "Prerequisites""></a></h2><ul><li><a href="https://docs.docker.com/get-docker/" target="_blank" rel="noreferrer">Docker</a> and <a href="https://docs.docker.com/compose/install/" target="_blank" rel="noreferrer">Docker Compose</a> installed on your server or local machine.</li><li>A server or local machine with at least 4GB of RAM (2GB of RAM if you use external Postgres, Redis (Valkey) and Meilisearch instances).</li><li><a href="https://git-scm.com/book/en/v2/Getting-Started-Installing-Git" target="_blank" rel="noreferrer">Git</a> installed on your server or local machine.</li></ul><h2 id="_1-clone-the-repository" tabindex="-1">1. Clone the Repository <a class="header-anchor" href="#_1-clone-the-repository" aria-label="Permalink to "1. Clone the Repository""></a></h2><p>First, clone the Open Archiver repository to your machine:</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;"> clone</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> https://github.com/LogicLabs-OU/OpenArchiver.git</span></span>
|
||
<span class="line"><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">cd</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> OpenArchiver</span></span></code></pre></div><h2 id="_2-configure-your-environment" tabindex="-1">2. Configure Your Environment <a class="header-anchor" href="#_2-configure-your-environment" aria-label="Permalink to "2. Configure Your Environment""></a></h2><p>The application is configured using environment variables. You'll need to create a <code>.env</code> file to store your configuration.</p><p>Copy the example environment file for Docker:</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;">cp</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> .env.example.docker</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> .env</span></span></code></pre></div><p>Now, open the <code>.env</code> file in a text editor and customize the settings.</p><h3 id="important-configuration" tabindex="-1">Important Configuration <a class="header-anchor" href="#important-configuration" aria-label="Permalink to "Important Configuration""></a></h3><p>You must change the following placeholder values to secure your instance:</p><ul><li><code>POSTGRES_PASSWORD</code>: A strong, unique password for the database.</li><li><code>REDIS_PASSWORD</code>: A strong, unique password for the Valkey/Redis service.</li><li><code>MEILI_MASTER_KEY</code>: A complex key for Meilisearch.</li><li><code>JWT_SECRET</code>: A long, random string for signing authentication tokens.</li><li><code>ADMIN_PASSWORD</code>: A strong password for the initial admin user.</li><li><code>ENCRYPTION_KEY</code>: A 32-byte hex string for encrypting sensitive data in the database. You can generate one with the following command:<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;">openssl</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> rand</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -hex</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> 32</span></span></code></pre></div></li></ul><h3 id="storage-configuration" tabindex="-1">Storage Configuration <a class="header-anchor" href="#storage-configuration" aria-label="Permalink to "Storage Configuration""></a></h3><p>By default, the Docker Compose setup uses local filesystem storage, which is persisted using a Docker volume named <code>archiver-data</code>. This is suitable for most use cases.</p><p>If you want to use S3-compatible object storage, change the <code>STORAGE_TYPE</code> to <code>s3</code> and fill in your S3 credentials (<code>STORAGE_S3_*</code> variables).</p><h3 id="using-external-services" tabindex="-1">Using External Services <a class="header-anchor" href="#using-external-services" aria-label="Permalink to "Using External Services""></a></h3><p>For convenience, the <code>docker-compose.yml</code> file includes services for PostgreSQL, Valkey (Redis), and Meilisearch. However, you can use your own external or managed instances for these services.</p><p>To do so:</p><ol><li><strong>Update your <code>.env</code> file</strong>: Change the host, port, and credential variables to point to your external service instances. For example, you would update <code>DATABASE_URL</code>, <code>REDIS_HOST</code>, and <code>MEILI_HOST</code>.</li><li><strong>Modify <code>docker-compose.yml</code></strong>: Remove or comment out the service definitions for <code>postgres</code>, <code>valkey</code>, and <code>meilisearch</code> from your <code>docker-compose.yml</code> file.</li></ol><p>This will configure the Open Archiver application to connect to your services instead of starting the default ones.</p><h3 id="environment-variable-reference" tabindex="-1">Environment Variable Reference <a class="header-anchor" href="#environment-variable-reference" aria-label="Permalink to "Environment Variable Reference""></a></h3><p>Here is a complete list of environment variables available for configuration:</p><h4 id="application-settings" tabindex="-1">Application Settings <a class="header-anchor" href="#application-settings" aria-label="Permalink to "Application Settings""></a></h4><table tabindex="0"><thead><tr><th>Variable</th><th>Description</th><th>Default Value</th></tr></thead><tbody><tr><td><code>NODE_ENV</code></td><td>The application environment.</td><td><code>development</code></td></tr><tr><td><code>PORT_BACKEND</code></td><td>The port for the backend service.</td><td><code>4000</code></td></tr><tr><td><code>PORT_FRONTEND</code></td><td>The port for the frontend service.</td><td><code>3000</code></td></tr></tbody></table><h4 id="docker-compose-service-configuration" tabindex="-1">Docker Compose Service Configuration <a class="header-anchor" href="#docker-compose-service-configuration" aria-label="Permalink to "Docker Compose Service Configuration""></a></h4><p>These variables are used by <code>docker-compose.yml</code> to configure the services.</p><table tabindex="0"><thead><tr><th>Variable</th><th>Description</th><th>Default Value</th></tr></thead><tbody><tr><td><code>POSTGRES_DB</code></td><td>The name of the PostgreSQL database.</td><td><code>open_archive</code></td></tr><tr><td><code>POSTGRES_USER</code></td><td>The username for the PostgreSQL database.</td><td><code>admin</code></td></tr><tr><td><code>POSTGRES_PASSWORD</code></td><td>The password for the PostgreSQL database.</td><td><code>password</code></td></tr><tr><td><code>DATABASE_URL</code></td><td>The connection URL for the PostgreSQL database.</td><td><code>postgresql://admin:password@postgres:5432/open_archive</code></td></tr><tr><td><code>MEILI_MASTER_KEY</code></td><td>The master key for Meilisearch.</td><td><code>aSampleMasterKey</code></td></tr><tr><td><code>MEILI_HOST</code></td><td>The host for the Meilisearch service.</td><td><code>http://meilisearch:7700</code></td></tr><tr><td><code>REDIS_HOST</code></td><td>The host for the Valkey (Redis) service.</td><td><code>valkey</code></td></tr><tr><td><code>REDIS_PORT</code></td><td>The port for the Valkey (Redis) service.</td><td><code>6379</code></td></tr><tr><td><code>REDIS_PASSWORD</code></td><td>The password for the Valkey (Redis) service.</td><td><code>defaultredispassword</code></td></tr><tr><td><code>REDIS_TLS_ENABLED</code></td><td>Enable or disable TLS for Redis.</td><td><code>false</code></td></tr></tbody></table><h4 id="storage-settings" tabindex="-1">Storage Settings <a class="header-anchor" href="#storage-settings" aria-label="Permalink to "Storage Settings""></a></h4><table tabindex="0"><thead><tr><th>Variable</th><th>Description</th><th>Default Value</th></tr></thead><tbody><tr><td><code>STORAGE_TYPE</code></td><td>The storage backend to use (<code>local</code> or <code>s3</code>).</td><td><code>local</code></td></tr><tr><td><code>STORAGE_LOCAL_ROOT_PATH</code></td><td>The root path for local file storage.</td><td><code>/var/data/open-archiver</code></td></tr><tr><td><code>STORAGE_S3_ENDPOINT</code></td><td>The endpoint for S3-compatible storage.</td><td></td></tr><tr><td><code>STORAGE_S3_BUCKET</code></td><td>The bucket name for S3-compatible storage.</td><td></td></tr><tr><td><code>STORAGE_S3_ACCESS_KEY_ID</code></td><td>The access key ID for S3-compatible storage.</td><td></td></tr><tr><td><code>STORAGE_S3_SECRET_ACCESS_KEY</code></td><td>The secret access key for S3-compatible storage.</td><td></td></tr><tr><td><code>STORAGE_S3_REGION</code></td><td>The region for S3-compatible storage.</td><td></td></tr><tr><td><code>STORAGE_S3_FORCE_PATH_STYLE</code></td><td>Force path-style addressing for S3.</td><td><code>false</code></td></tr></tbody></table><h4 id="security-authentication" tabindex="-1">Security & Authentication <a class="header-anchor" href="#security-authentication" aria-label="Permalink to "Security & Authentication""></a></h4><table tabindex="0"><thead><tr><th>Variable</th><th>Description</th><th>Default Value</th></tr></thead><tbody><tr><td><code>JWT_SECRET</code></td><td>A secret key for signing JWT tokens.</td><td><code>a-very-secret-key-that-you-should-change</code></td></tr><tr><td><code>JWT_EXPIRES_IN</code></td><td>The expiration time for JWT tokens.</td><td><code>7d</code></td></tr><tr><td><code>ADMIN_EMAIL</code></td><td>The email for the initial admin user.</td><td><code>admin@local.com</code></td></tr><tr><td><code>ADMIN_PASSWORD</code></td><td>The password for the initial admin user.</td><td><code>a_strong_password_that_you_should_change</code></td></tr><tr><td><code>SUPER_API_KEY</code></td><td>An API key with super admin privileges.</td><td></td></tr><tr><td><code>ENCRYPTION_KEY</code></td><td>A 32-byte hex string for encrypting sensitive data.</td><td></td></tr></tbody></table><h2 id="_3-run-the-application" tabindex="-1">3. Run the Application <a class="header-anchor" href="#_3-run-the-application" aria-label="Permalink to "3. Run the Application""></a></h2><p>Once you have configured your <code>.env</code> file, you can start all the services using Docker Compose:</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>This command will:</p><ul><li>Pull the required Docker images for the frontend, backend, database, and other services.</li><li>Create and start the containers in the background (<code>-d</code> flag).</li><li>Create the persistent volumes for your data.</li></ul><p>You can check the status of the running containers with:</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><h2 id="_4-access-the-application" tabindex="-1">4. Access the Application <a class="header-anchor" href="#_4-access-the-application" aria-label="Permalink to "4. Access the Application""></a></h2><p>Once the services are running, you can access the Open Archiver web interface by navigating to <code>http://localhost:3000</code> in your web browser.</p><p>You can log in with the <code>ADMIN_EMAIL</code> and <code>ADMIN_PASSWORD</code> you configured in your <code>.env</code> file.</p><h2 id="_5-next-steps" tabindex="-1">5. Next Steps <a class="header-anchor" href="#_5-next-steps" aria-label="Permalink to "5. Next Steps""></a></h2><p>After successfully deploying and logging into Open Archiver, the next step is to configure your ingestion sources to start archiving emails.</p><ul><li><a href="./email-providers/google-workspace.html">Connecting to Google Workspace</a></li><li><a href="./email-providers/microsoft-365.html">Connecting to Microsoft 365</a></li><li><a href="./email-providers/imap.html">Connecting to a Generic IMAP Server</a></li></ul><h2 id="updating-your-installation" tabindex="-1">Updating Your Installation <a class="header-anchor" href="#updating-your-installation" aria-label="Permalink to "Updating Your Installation""></a></h2><p>To update your Open Archiver instance to the latest version, run the following commands:</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:#6A737D;--shiki-dark:#6A737D;"># Pull the latest changes from the repository</span></span>
|
||
<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>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Pull the latest Docker images</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>
|
||
<span class="line"></span>
|
||
<span class="line"><span style="--shiki-light:#6A737D;--shiki-dark:#6A737D;"># Restart the services with the new images</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;"> up</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> -d</span></span></code></pre></div></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><a class="VPLink link pager-link prev" href="/" data-v-28097769><!--[--><span class="desc" data-v-28097769>Previous page</span><span class="title" data-v-28097769>Get Started</span><!--]--></a></div><div class="pager" data-v-28097769><a class="VPLink link pager-link next" href="/user-guides/email-providers/" data-v-28097769><!--[--><span class="desc" data-v-28097769>Next page</span><span class="title" data-v-28097769>Email Providers</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\":\"Lx-5aly3\"}");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\":\"../assets/logo-sq.svg\"},\"nav\":[{\"text\":\"Home\",\"link\":\"/\"},{\"text\":\"User Guides\",\"link\":\"/user-guides/email-providers/\"}],\"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> |