Documentation
Setup walkthroughs, security architecture, and integration guides for the VaultGuard Sync plugin and Community Edition server. All pages are also browsable on GitHub.
Getting started
Setup Guide
Install the plugin, point it at your API endpoint, and complete first-time vault provisioning.
Read →Plugin Overview
High-level walkthrough of the VaultGuard Sync plugin for end users.
Read →Signing In & First Run
Set your password, two-factor, and vault binding — plus fixes for the most common sign-in errors.
Read →Integrations
AI Chat
Use the built-in Claude chat panel inside Obsidian — connect a key or subscription, edit notes through reviewable diffs, all behind the same gates.
Read →AI Agent Bridge
Install the Claude Code skill, mint a lease, and wire Claude Code, Claudian, or Cursor into your vault.
Read →Share Links
Generate one-click links to specific files for teammates who already have vault access — permission model still applies.
Read →Security & compliance
Security Model
Threat model, encryption primitives, and compliance posture for security reviewers.
Read →At-Rest Encryption
How the local at-rest cipher works — adapter interception, key derivation, and what stays plaintext.
Read →Vault Model
The vault-scoping rule: how files, permissions, and S3 keys are partitioned per vault.
Read →Self-hosting
Self-Hosting Guide
End-to-end guide for running VaultGuard Community Edition on your own AWS account.
Read →CE Server Reference
Architecture, deployment, and operational surface of the Community Edition server stack.
Read →Deployment Guide
Terraform-based deployment of the VaultGuard backend on your own AWS account.
Read →