Skip to main content

Module default_paths

Module default_paths 

Source
Expand description

Spec §2.11 install layout — OS-aware default paths for config / mutable data / logs, plus the find_config fallback chain that every binary uses to locate its config file.

Layout

Windows                                    Linux
C:\Program Files\Kanade\                   /usr/local/bin/
  ↑ binaries                                 ↑ binaries

C:\ProgramData\Kanade\config\              /etc/kanade/
  ├─ agent.toml                              ├─ agent.toml
  └─ backend.toml                            └─ backend.toml

C:\ProgramData\Kanade\data\                /var/lib/kanade/
  ├─ state.db        (agent)                 ├─ state.db
  ├─ outbox/         (agent)                 ├─ outbox/
  ├─ staging/        (agent self-update)     ├─ staging/
  ├─ backend.db      (backend)               ├─ backend.db
  ├─ certs/                                  ├─ certs/
  └─ nats/           (JetStream data)        └─ nats/

C:\ProgramData\Kanade\logs\                /var/log/kanade/
  ├─ agent.log                               ├─ agent.log
  ├─ backend.log                             ├─ backend.log
  └─ nats-server.log                         └─ nats-server.log

Functions§

config_dir
%ProgramData%\Kanade\config\ on Windows, /etc/kanade/ on Linux.
data_dir
%ProgramData%\Kanade\data\ on Windows, /var/lib/kanade/ on Linux.
find_config
Resolve the config file path through the fallback chain:
log_dir
%ProgramData%\Kanade\logs\ on Windows, /var/log/kanade/ on Linux.