obsidian-web/config.example.yaml at main · susamn/obsidian-web · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
# Obsidian Web Configuration Example
#
# For local development:
#   Copy this file to ~/.config/obsidian-web/config.yaml and customize
#
# For Docker:
#   Use environment variables to override settings (see docker-compose.yml)
#
# Configuration priority:
#   1. Command-line flag: --config /path/to/config.yaml
#   2. Environment variable: OBSIDIAN_WEB_CONFIG_PATH
#   3. ~/.config/obsidian-web/config.yaml
#   4. ./config.yaml (current directory)
#   5. /etc/obsidian-web/config.yaml
#   6. Built-in defaults

# HTTP Server Configuration
server:
  # Host to bind to (use "0.0.0.0" for Docker, "localhost" for local dev)
  host: "localhost"

  # Port to listen on
  port: 8080

  # Request timeout settings
  read_timeout: 30s
  write_timeout: 30s

  # Static files directory (for web UI assets)
  static_dir: "./static"

# Logging Configuration
logging:
  # Log level: debug, info, warn, error
  level: "info"

  # Log format: json, text
  format: "text"

  # Log output: stdout, stderr, or file path
  output: "stdout"

# Vault Configurations
# You can configure multiple vaults with different storage backends
vaults:
  # Default vault (local filesystem)
  - id: "default"
    name: "My Obsidian Vault"

    # Storage backend configuration
    storage:
      # Storage type: local, s3, minio
      type: "local"

      # Local filesystem storage configuration
      local:
        # Path to your Obsidian vault directory
        # Change this to point to your actual vault!
        path: "./data/vaults/default/store"

    # Path where the search index will be stored
    # For local dev, defaults to ~/.config/obsidian-web/indexes/default
    index_path: "./data/vaults/default/index"
    db_path: "./data/vaults/default/db"

    # Enable/disable this vault
    enabled: true

    # Mark as default vault (only one can be default)
    default: true

  # Example: Additional vault with S3 storage (disabled by default)
  # - id: "work"
  #   name: "Work Notes"
  #   storage:
  #     type: "s3"
  #     s3:
  #       bucket: "work-notes-bucket"
  #       region: "us-west-2"
  #       access_key: "${AWS_ACCESS_KEY_ID}"     # or set via env var
  #       secret_key: "${AWS_SECRET_ACCESS_KEY}" # or set via env var
  #       # endpoint: "https://s3.amazonaws.com"   # optional for S3-compatible services
  #   index_path: "./data/indexes/work"
  #   enabled: false
  #   default: false

  # Example: Vault with MinIO storage (disabled by default)
  # - id: "archive"
  #   name: "Archive"
  #   storage:
  #     type: "minio"
  #     minio:
  #       endpoint: "localhost:9000"
  #       bucket: "my-vault"
  #       access_key: "${MINIO_ACCESS_KEY}"
  #       secret_key: "${MINIO_SECRET_KEY}"
  #       use_ssl: false
  #   index_path: "./data/indexes/archive"
  #   enabled: false
  #   default: false

# Search Configuration
search:
  # Default number of results to return
  default_limit: 20

  # Maximum allowed results (prevents excessive queries)
  max_limit: 100

  # Index cache size in megabytes
  cache_size_mb: 512

# Indexing Configuration
indexing:
  # Number of documents to index per batch
  batch_size: 100

  # Automatically index all vaults on application startup
  auto_index_on_startup: true

  # Watch for file changes and re-index automatically (future feature)
  watch_for_changes: false

  # Periodic re-indexing interval (e.g., "5m", "1h", "24h")
  # Set to "0" to disable periodic re-indexing
  update_interval: 5m