Storage

required

The storage option is used to configure how and where data is stored.

backend

enum badger recommended

The backend option is used to set which storage backend should be used to store data. This defines how data is stored. Depending on the chosen backend different further configuration options might be available or not.

In the following the supported storage backend and their available options are detailed.

json

If backend is set to json the JSON files backend is used. This backend stores data in simple json files (in multiple directories). This option is great to see which data is stored, since it is the most human-readable storage format supported. It is also great if data is manipulated externally. Performance-wise other options are better.

config.yaml

storage:
    backend: json
    data_dir: /path/to/data

The following configuration options are defined for the json backend:

data_dir

directory path required

The data_dir option sets the root directory where data is stored on disk. LightHouse creates subdirectories and places the JSON files in those directories.

badger

If backend is set to badger the BadgerDB backend is used. BadgerDB is an embeddable, persistent key-value database. No external dependencies are needed, as BadgerDB is embedded into LightHouse. The data is stored on disk is not suitable to be read or manipulated by humans.

config.yaml

storage:
    backend: badger
    data_dir: /path/to/data

The following configuration options are defined for the badger backend:

data_dir

directory path required

The data_dir option sets the root directory where the badger data is stored on disk.