MCPcopy Index your code
hub / github.com/LogicLabs-OU/OpenArchiver

github.com/LogicLabs-OU/OpenArchiver @v0.5.0

Chat with this repo
repository ↗ · DeepWiki ↗ · release v0.5.0 ↗ · + Follow
499 symbols 1,266 edges 182 files 50 documented · 10%
What it actually does AI analysis from the code graph — generated when you open this
loading…
README

Open Archiver

Docker Compose PostgreSQL Meilisearch TypeScript Redis SvelteKit

A secure, sovereign, and open-source platform for email archiving.

Open Archiver provides a robust, self-hosted solution for archiving, storing, indexing, and searching emails from major platforms, including Google Workspace (Gmail), Microsoft 365, PST files, 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.

Screenshots

Open Archiver Preview Dashboard

Open Archiver Preview Archived emails

Open Archiver Preview Full-text search across all your emails and attachments

Join our community!

We are committed to building an engaging community around Open Archiver, and we are inviting all of you to join our community on Discord to get real-time support and connect with the team.

Discord

Bluesky

🚀 Live demo

Check out the live demo here: https://demo.openarchiver.com

Username: demo@openarchiver.com

Password: openarchiver_demo

Key Features

  • Universal Ingestion: Connect to any email provider to perform initial bulk imports and maintain continuous, real-time synchronization. Ingestion sources include:

    • IMAP connection
    • Google Workspace
    • Microsoft 365
    • PST files
    • Zipped .eml files
    • Mbox files
  • Secure & Efficient Storage: Emails are stored in the standard .eml format. The system uses deduplication and compression to minimize storage costs. All files are encrypted at rest.

  • Pluggable Storage Backends: Support both local filesystem storage and S3-compatible object storage (like AWS S3 or MinIO).
  • Powerful Search & eDiscovery: A high-performance search engine indexes the full text of emails and attachments (PDF, DOCX, etc.).
  • Thread discovery: The ability to discover if an email belongs to a thread/conversation and present the context.
  • Compliance & Retention: Define granular retention policies to automatically manage the lifecycle of your data. Place legal holds on communications to prevent deletion during litigation (TBD).
  • File Hash and Encryption: Email and attachment file hash values are stored in the meta database upon ingestion, meaning any attempt to alter the file content will be identified, ensuring legal and regulatory compliance.
    • Each archived email comes with an "Integrity Report" feature that indicates if the files are original.
  • Comprehensive Auditing: An immutable audit trail logs all system activities, ensuring you have a clear record of who accessed what and when.

Tech Stack

Open Archiver is built on a modern, scalable, and maintainable technology stack:

  • Frontend: SvelteKit with Svelte 5
  • Backend: Node.js with Express.js & TypeScript
  • Job Queue: BullMQ on Redis for robust, asynchronous processing. (We use Valkey as the Redis service in the Docker Compose deployment mode, but you can use Redis as well.)
  • Search Engine: Meilisearch for blazingly fast and resource-efficient search
  • Database: PostgreSQL for metadata, user management, and audit logs
  • Deployment: Docker Compose deployment

Deployment

Prerequisites

  • Docker and Docker Compose
  • A server or local machine with at least 4GB of RAM (2GB of RAM if you use external Postgres, Redis (Valkey) and Meilisearch instances).

Installation

  1. Clone the repository:

    bash git clone https://github.com/LogicLabs-OU/OpenArchiver.git cd OpenArchiver

  2. Configure your environment: Copy the example environment file and customize it with your settings.

    bash cp .env.example .env

    You will need to edit the .env file to set your admin passwords, secret keys, and other essential configuration. Read the .env.example for how to set up.

  3. Run the application:

    bash docker compose up -d

    This command will pull the pre-built Docker images and start all the services (frontend, backend, database, etc.) in the background.

  4. Access the application: Once the services are running, you can access the Open Archiver web interface by navigating to http://localhost:3000 in your web browser.

Data Source Configuration

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:

Contributing

We welcome contributions from the community!

  • Reporting Bugs: If you find a bug, please open an issue on our GitHub repository.
  • Suggesting Enhancements: Have an idea for a new feature? We'd love to hear it. Open an issue to start the discussion.
  • Code Contributions: If you'd like to contribute code, please fork the repository and submit a pull request.

Please read our CONTRIBUTING.md file for more details on our code of conduct and the process for submitting pull requests.

📈 Star History

Star History Chart

Extension points exported contracts — how you extend this code

IStorageProvider (Interface)
(no doc) [6 implementers]
packages/types/src/storage.types.ts
IEmailConnector (Interface)
(no doc) [7 implementers]
packages/backend/src/services/EmailProviderFactory.ts
Locals (Interface)
(no doc)
packages/frontend/src/app.d.ts
AuthTokenPayload (Interface)
(no doc)
packages/types/src/auth.types.ts
DeletionOptions (Interface)
(no doc)
packages/backend/src/helpers/deletionGuard.ts
AuthState (Interface)
(no doc)
packages/frontend/src/lib/stores/auth.store.ts
LoginResponse (Interface)
(no doc)
packages/types/src/auth.types.ts
ISyncCycleFinishedJob (Interface)
(no doc)
packages/backend/src/jobs/processors/sync-cycle-finished.processor.ts

Core symbols most depended-on inside this repo

get
called by 119
packages/types/src/storage.types.ts
api
called by 54
packages/frontend/src/lib/api.client.ts
update
called by 41
packages/backend/src/services/IngestionService.ts
requirePermission
called by 33
packages/backend/src/api/middleware/requirePermission.ts
findById
called by 26
packages/backend/src/services/UserService.ts
delete
called by 25
packages/types/src/storage.types.ts
createAuditLog
called by 18
packages/backend/src/services/AuditService.ts
set
called by 17
packages/backend/src/services/OcrService.ts

Shape

Method 223
Function 104
Class 88
Interface 83
Enum 1

Languages

TypeScript100%

Modules by API surface

packages/backend/src/services/OcrService.ts20 symbols
packages/backend/src/services/ingestion-connectors/MboxConnector.ts16 symbols
packages/backend/src/services/ingestion-connectors/EMLConnector.ts15 symbols
packages/types/src/ingestion.types.ts14 symbols
packages/backend/src/services/ingestion-connectors/PSTConnector.ts14 symbols
packages/backend/src/services/ingestion-connectors/MicrosoftConnector.ts14 symbols
packages/backend/src/services/ingestion-connectors/ImapConnector.ts14 symbols
packages/backend/src/services/IngestionService.ts14 symbols
packages/backend/src/services/IndexingService.ts14 symbols
packages/backend/src/services/StorageService.ts12 symbols
packages/types/src/retention.types.ts11 symbols
packages/backend/src/services/ingestion-connectors/GoogleWorkspaceConnector.ts11 symbols

For agents

$ claude mcp add OpenArchiver \
  -- python -m otcore.mcp_server <graph>

⬇ download graph artifact

Ask about this repo answers extend the page