Advanced configuration

In this section, you will find all the configuration options available for each component of beVault.

How to set the config

Using environment variables

You can configure each component of beVault by setting some environment variables. Those variables can be included in your docker-compose file like seen in the Installation page.
You will find detailed information for each component in the subsequent pages. You will need to prefix the variables with the component's name.

Here is an example to configure the logs for the component metaVault:

YAML

DFAKTO_METAVAULT_Serilog__MinimumLevel__Default=Information
DFAKTO_METAVAULT_Serilog__MinimumLevel__Override__Microsoft=Warning
DFAKTO_METAVAULT_Serilog__MinimumLevel__Override__System=Warning
DFAKTO_METAVAULT_Serilog__WriteTo__0__Args__outputTemplate=[{Timestamp:yyyy-MM-dd HH:mm:ss.fff} {Level:u3}] {Message:lj} <s:{SourceContext}>{NewLine}{Exception}
DFAKTO_METAVAULT_Serilog__WriteTo__0__Args__theme=Serilog.Sinks.SystemConsole.Themes.AnsiConsoleTheme::Code, Serilog.Sinks.Console
DFAKTO_METAVAULT_Serilog__WriteTo__0__Name=Console
DFAKTO_METAVAULT_Serilog__WriteTo__1__Args__fileSizeLimitBytes=10000000
DFAKTO_METAVAULT_Serilog__WriteTo__1__Args__path=/var/log/testlog_.txt
DFAKTO_METAVAULT_Serilog__WriteTo__1__Args__retainedFileCountLimit=10
DFAKTO_METAVAULT_Serilog__WriteTo__1__Args__rollingInterval=Day
DFAKTO_METAVAULT_Serilog__WriteTo__1__Args__rollOnFileSizeLimit=True
DFAKTO_METAVAULT_Serilog__WriteTo__1__Name=File

Using JSON configuration file

Let's take the example of the logs. Here is the configuration of the logs, as it is in the appsettings:

CODE

"Serilog": {
  "Using": [ "Serilog.Sinks.File" ],
  "MinimumLevel": "Debug",
  "WriteTo": [
    {
      "Name": "File",
      "Args": {
        "rollOnFileSizeLimit": true,
        "fileSizeLimitBytes": "10000000",
        "retainedFileCountLimit": 10,
        "outputTemplate": "{Timestamp:o} [{Level:u3}] ({ThreadId}) {Message}{NewLine}{Exception}"
      }
    }
  ]
},

The path is intentionally missing : if you want to add a path where the logs will be sent (and you do), DO NOT modify the appsettings directly, instead you need to add a file in the config folder of the AppData. The name of the file is not relevant.

Here is an example of the content of the file that will define a path for the logs :

CODE

{
  "Serilog": {
    "WriteTo": [
      {
        "Args": {
          "path": "/var/logs"
        }
      }
    ]
  }
}

The content of the config files will override the content of the appsettings where there is a conflict, so if we are not happy with the default value present in the appsettings, we can easily set new values in the config file. For example, if we wanted to change the logs minimum level as well as the settings of the logs' path, we could do it like so :

CODE

{
  "Serilog": {
    "MinimumLevel": "Error",

    "WriteTo": [
      {
        "Args": {
          "path": "/var/logs"
        }
      }
    ]
  }
}