Skip to main content

Configuration

Notey reads configuration from appsettings.json and optional local overrides in appsettings.Local.json. Local settings are intentionally ignored by git so API keys and machine-specific paths are not committed.

Vault root​

The Notey:Vault section configures a single vault root. Notey owns Images, Notes, Notes/Draft, and People under that root.

If Notey:Vault:RootPath is empty on startup, Notey shows the setup wizard instead of silently creating notes in the default documents folder. The wizard saves an explicit root path before normal capture begins.

Breaking change: legacy keys (NotesPath, PeoplePath, TopicsPath, ProjectsPath, ScreenshotPath) are no longer used. Configure only Notey:Vault:RootPath.

{
  "Notey": {
    "Vault": {
      "RootPath": "C:/Users/me/Obsidian/MyVault"
    }
  }
}

The setup wizard also creates the fixed top-level note folders Customers, Projects, and Topics when requested. Entered project and topic names create child folders for routing captured notes; Notey stores project and topic entity files at Notes/Projects/<name>.md and Notes/Topics/<name>.md. First-level folders under Notes become dynamic slash commands. When /topic follows one of those dynamic commands, topic suggestions are scoped to that selected folder and can target existing markdown files or folders using inline @ <relative path> routing.

AI provider​

The default AI provider is OpenAI-compatible. Prefer the NOTEY_AI_API_KEY environment variable over plaintext configuration.

{
  "Notey": {
    "Ai": {
      "DefaultProviderId": "default",
      "BaseUrl": "https://api.example.com/v1",
      "ApiKeyEnvironmentVariable": "NOTEY_AI_API_KEY",
      "ModelName": "gpt-compatible-model"
    }
  }
}

OCR​

Direct screenshot processing and persistent image embeds use OCR. If tesseract is not on PATH, configure the executable explicitly.

{
  "Notey": {
    "Ocr": {
      "TesseractExecutablePath": "C:/Program Files/Tesseract-OCR/tesseract.exe",
      "TesseractDataPath": "C:/Program Files/Tesseract-OCR/tessdata",
      "DefaultLanguage": "eng"
    }
  }
}