A service that monitors an Obsidian vault for file changes (new, modified, or deleted Markdown files) and indexes each note’s metadata and content into an SQLite database, exposing it for e.g. an MCP-server
Overview
What is Obsidian Index Service?
Obsidian Index Service is a tool that monitors an Obsidian vault for changes in Markdown files and indexes their metadata and content into an SQLite database, making it accessible for other applications.
How to use Obsidian Index Service?
To use the service, clone the repository, set up a virtual environment, install dependencies, and run the service with the appropriate environment variables for your Obsidian vault and database paths.
Key features of Obsidian Index Service?
- Monitors file changes (create, modify, delete) in an Obsidian vault.
- Indexes metadata and full content of Markdown files into an SQLite database.
- Supports Docker for easy deployment and access.
- Provides command-line options for scanning and monitoring.
Use cases of Obsidian Index Service?
- Keeping an up-to-date index of notes in an Obsidian vault.
- Enabling other applications to access note metadata without parsing Markdown files directly.
- Potentially serving as a sync tool for remote storage solutions.
FAQ from Obsidian Index Service?
- Can I use this service with any Markdown files?
Yes! It is designed to work with Markdown files in an Obsidian vault.
- Is it necessary to use Docker?
No, Docker is optional; you can run it locally without Docker as well.
- What programming language is used for this project?
The service is built using Python.