mirror of
https://github.com/Ar9av/obsidian-wiki.git
synced 2026-09-14 20:36:34 +08:00
Arnav
52c9f2bae2
Everything else here is local: skills on your machine, a vault on your disk. This puts a vault behind a URL so an agent elsewhere can search and write it. One container, one vault, one API key. The vault stays plain markdown on a mounted volume, so Obsidian still opens it. The container does no LLM work -- search and packing delegate to the existing graphrag/context_pack modules, and the caller's agent does the thinking. - obsidian_wiki/server.py: four vault functions, five REST routes and four MCP tools as transport over them. Auth is one bearer key; the process refuses to start without WIKI_API_KEY unless WIKI_ALLOW_ANONYMOUS=1. Every path is resolved inside the vault or refused. - Dockerfile, docker-compose.yml, .dockerignore, and a ghcr push on v* tags. - New [server] extra; the core wheel stays dependency-free. - docs/deployment.md, plus the WIKI_* vars in configuration.md and .env.example. Requires mcp>=2.0: 2.0 renamed FastMCP to MCPServer, and session_manager only exists once streamable_http_app() has been called -- a mounted sub-app's own lifespan is ignored, so it is wired into the FastAPI lifespan by hand.
19 lines
1.2 KiB
Markdown
19 lines
1.2 KiB
Markdown
# Documentation
|
|
|
|
Everything beyond the [README](../README.md) landing page.
|
|
|
|
| Page | What's in it |
|
|
|---|---|
|
|
| [Installation](installation.md) | pip, git clone, agent-driven setup, Skills CLI, multiple vaults |
|
|
| [Agent Compatibility](agents.md) | The full agent matrix and per-agent manual setup |
|
|
| [Skills Reference](skills.md) | All 39 skills, what each does, and its slash command |
|
|
| [CLI Reference](cli.md) | Every `obsidian-wiki` subcommand ([繁體中文: context packs](cli.zh-TW.md)) |
|
|
| [Configuration](configuration.md) | Every config variable, QMD semantic search, `_raw/` staging, GitHub sync |
|
|
| [Architecture](architecture.md) | The four ingest stages, vault structure, what we added to Karpathy's pattern |
|
|
| [Session Brain](session-brain.md) | Topic graph over your agent session history |
|
|
| [Browser Extension](browser-extension.md) | Capture pages into the vault, and fill web forms from it |
|
|
| [Deployment](deployment.md) | Run a vault as a Dockerized memory service agents reach over HTTP/MCP |
|
|
| [Contributing](contributing.md) | Adding skills, keeping the two READMEs in sync |
|
|
|
|
New here? Read [Installation](installation.md), then [Skills Reference](skills.md).
|