Guides¶
Step-by-step walkthroughs for common deployment scenarios. Each guide takes you from zero to a working configuration with a verification step at the end.
Which guide do I need?¶
| I want to... | Guide |
|---|---|
| Understand git modes (managed, commit-only, no-git) | Git Integration |
| Connect my Obsidian vault to Claude Desktop | Claude Desktop |
| Enable write/edit operations with git auto-commit | Claude Desktop |
| Add semantic search to my vault | Claude Desktop |
| Run the server in a Docker container | Docker |
| Add git write support to a container | Docker |
| Protect my server with a bearer token | Authentication |
| Protect my server with OIDC authentication | Authentication |
| Access my vault from desktop, mobile, AND Claude | Obsidian Everywhere |
| Use FastEmbed for local embeddings | Embeddings |
| Use Ollama for embeddings (CPU-only) | Embeddings |
| Use OpenAI for embeddings | Embeddings |
| Set up OIDC with Authelia | OIDC Providers |
| Set up OIDC with Keycloak | OIDC Providers |
| Set up OIDC with Google | OIDC Providers |
| Set up OIDC with GitHub (via Keycloak) | OIDC Providers |
Prerequisites¶
All guides assume you have:
- A directory of markdown files (e.g., an Obsidian vault)
- Python 3.10+ installed (for local installs) or Docker (for container deployments)
For installation instructions, see Installation. For the full environment variable reference, see Configuration.