📦 Installation Instructions

← Back to Main Page

📋 Requirements

Obsidian Version 1.0.0 or higher
Operating System Windows, macOS, Linux, iOS, Android
Storage ~1 MB + thumbnail cache
Recommended Obsidian 1.4.0+ for best compatibility

📥 Installation Methods

ℹ️ Easiest Method

This is the recommended installation method for most users. Updates are handled automatically.

1 Open Obsidian Settings
  • Click the gear icon ⚙️ in the lower-left corner
  • Or press Ctrl/Cmd + ,
2 Navigate to Community Plugins
  • Click "Community plugins" in the left sidebar
  • If prompted, click "Turn on community plugins"
3 Browse & Search
  • Click the "Browse" button
  • Search for "Document Manager"
4 Install & Enable
  • Click on "Document Manager" in the search results
  • Click the "Install" button
  • Return to Community plugins and toggle to enable
5 Verify Installation
  • Look for the 📚 icon in the left ribbon
  • Or press Ctrl/Cmd + P and search "Document Manager"

✅ You're Done!

Click the 📚 ribbon icon to start browsing your documents.

⚠️ For Advanced Users

Manual installation requires downloading files and placing them in the correct location.

Required Files

Download these three files from the latest release:

main.js — Plugin code (required)
manifest.json — Plugin metadata (required)
styles.css — Styles (required)
1 Locate Your Vault

Find your Obsidian vault folder on your computer. This is the folder containing your notes.

2 Create Plugin Folder

Navigate to or create this folder structure:

YourVault/ └── .obsidian/ └── plugins/ └── document-manager/ ← Create this
3 Copy Files

Copy the downloaded files into the document-manager folder:

document-manager/ ├── main.js ├── manifest.json └── styles.css
4 Restart & Enable
  • Close Obsidian completely
  • Reopen Obsidian
  • Go to Settings → Community plugins
  • Find "Document Manager" and toggle to enable

Terminal Commands

macOS / Linux 
# Navigate to plugins folder
cd "path/to/your/vault/.obsidian/plugins"

# Create plugin directory
mkdir -p document-manager

# Copy files
cp ~/Downloads/main.js document-manager/
cp ~/Downloads/manifest.json document-manager/
cp ~/Downloads/styles.css document-manager/
Windows PowerShell 
# Navigate to plugins folder
cd "C:\path\to\your\vault\.obsidian\plugins"

# Create plugin directory
mkdir document-manager

# Copy files
copy "$env:USERPROFILE\Downloads\main.js" document-manager\
copy "$env:USERPROFILE\Downloads\manifest.json" document-manager\
copy "$env:USERPROFILE\Downloads\styles.css" document-manager\

🧪 Beta Testing

Use BRAT to install beta versions or unreleased features from GitHub.

1 Install BRAT Plugin

First, install the "BRAT" plugin from Community plugins.

2 Open BRAT Settings
  • Go to Settings → Community plugins → BRAT → Options
3 Add Beta Plugin

Click "Add Beta plugin" and enter:

GitHub Repository URL 
https://github.com/billaking/document-manager
4 Enable Plugin

Enable Document Manager in Community plugins after BRAT downloads it.

🚀 First Launch

Quick Start Checklist

🔄 Updating the Plugin

1 Community Plugin Updates
  • Open Settings → Community plugins
  • Click "Check for updates"
  • Update Document Manager if available
  • Restart Obsidian (recommended)

🗑️ Uninstalling

1 Through Obsidian
  • Open Settings → Community plugins
  • Find "Document Manager"
  • Click the ❌ or trash icon
  • Restart Obsidian

❓ Troubleshooting

Plugin Not Appearing

▼

Symptom: Document Manager doesn't show after manual install.

  • Ensure files are in the correct folder structure
  • Check that manifest.json exists
  • Verify file permissions aren't restricted
  • Completely restart Obsidian (not just reload)

"Plugin Failed to Load" Error

▼

Symptom: Error message when enabling the plugin.

  • Re-download all three files
  • Ensure no file corruption during download
  • Check Obsidian version meets requirements (1.0.0+)
  • Check Developer Console (Ctrl+Shift+I) for errors

Ribbon Icon Missing

▼

Symptom: The 📚 icon doesn't appear in the ribbon.

  • Right-click the ribbon → check "Document Manager"
  • Restart Obsidian
  • Disable and re-enable the plugin

Mobile Installation Issues

▼

iOS:

  • Use iCloud or file manager to access vault
  • Navigate to .obsidian/plugins/
  • Create folder and copy files
  • Relaunch Obsidian app

Android:

  • Use file manager to access vault storage
  • Navigate to .obsidian/plugins/
  • Create folder and copy files
  • Force close and reopen Obsidian

📁 File Structure Reference

YourVault/ ├── .obsidian/ │ └── plugins/ │ └── document-manager/ │ ├── data.json (created after first run) │ ├── main.js (required) │ ├── manifest.json (required) │ └── styles.css (required) ├── Covers/ (optional, for cover images) │ ├── book1.jpg │ └── book2.png └── Your Notes...