Configuration

This document details all configuration options available in ChronDB.

Configuration File

ChronDB uses an EDN (Extensible Data Notation) configuration file. By default, it looks for a config.edn file in the project's root directory.

Configuration Sections

1. Git (:git)

Git storage related configurations:

:git {
  :committer-name "ChronDB"      ; Name that will appear in commits
  :committer-email "[email protected]"  ; Email that will appear in commits
  :default-branch "main"         ; Main repository branch
  :sign-commits false            ; GPG commit signing
}

Details

• committer-name: Name used to identify the commit author

• committer-email: Email used to identify the commit author

• default-branch: Name of the main branch where changes will be saved

• sign-commits: If true, commits will be signed with GPG (requires additional setup)

2. Storage (:storage)

Data storage related configurations:

:storage {
  :data-dir "data"              ; Base storage directory
}

Details

• data-dir: Directory where documents will be stored

  • Documents are saved in JSON format

  • Directory structure is maintained by Git

  • Absolute paths are recommended in production

3. Logging (:logging)

Logging system configurations:

:logging {
  :level :info                  ; Minimum log level
  :output :stdout               ; Where logs will be written
  :file "chrondb.log"           ; Log file (if output = :file)
}

4. Servers (:servers)

Configuration for different protocols:

:servers {
  :rest {
    :enabled true
    :host "0.0.0.0"
    :port 3000
  }
  :redis {
    :enabled true
    :host "0.0.0.0"
    :port 6379
  }
  :postgresql {
    :enabled true
    :host "0.0.0.0"
    :port 5432
    :username "chrondb"
    :password "chrondb"
  }
}

Complete Example

{:git {:committer-name "ChronDB"
       :committer-email "[email protected]"
       :default-branch "main"
       :sign-commits false}
 :storage {:data-dir "/var/lib/chrondb/data"}
 :logging {:level :info
           :output :file
           :file "/var/log/chrondb/chrondb.log"}
 :servers {:rest {:enabled true
                 :host "0.0.0.0"
                 :port 3000}
          :redis {:enabled true
                 :host "0.0.0.0"
                 :port 6379}
          :postgresql {:enabled true
                      :host "0.0.0.0"
                      :port 5432
                      :username "chrondb"
                      :password "chrondb"}}}

Loading Configuration

(require '[chrondb.config :as config])

;; Load from default file (config.edn)
(def cfg (config/load-config))

;; Or specify a file
(def cfg (config/load-config "/etc/chrondb/prod.edn"))

;; Or merge with default settings
(def cfg (config/load-config {:logging {:level :debug}}))

Best Practices

1. Development Environment:

   • Use :debug as log level

   • Set :output to :stdout

   • Use relative paths for easier development

2. Production Environment:

   • Use :info or :warn as log level

   • Set :output to :file

   • Use absolute paths for directories

   • Configure external log rotation

3. Security:

   • Don't version control config.edn with credentials

   • Use environment variables for sensitive information

   • Restrict configuration file permissions